Skip to content

update install docs with download links from GitHub releases #6589

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mccanne merged 2 commits into from
Jan 30, 2026
+16 −12
Merged

update install docs with download links from GitHub releases #6589

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9047a52
update install docs with download links from GitHub releases
mccanne Jan 30, 2026
20f7f52
address PR feedback
mccanne Jan 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 16 additions & 12 deletions book/src/getting-started/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
# Installation

SuperDB, along with its new query language [SuperSQL](../super-sql/intro.md),
is downloadable software available as a single binary embodied in
the [super](../command/super.md) command.

You can [install a pre-built binary](#homebrew)
or [build from source code](#building-from-source).
SuperDB is downloadable software available as a single binary embodied
in the [super](../command/super.md) command. This software includes support
for [SuperSQL](../super-sql/intro.md),
SuperDB's new query language for super-structured data.

Several options for installation are available:
* download and install pre-built binaries via links on the
[GitHub Releases page](https://github.com/brimdata/super/releases),
* automatically install a pre-built binary for a Mac or Linux environment
with [Homebrew](#homebrew), or
* [build from source code](#building-from-source).

To install the SuperDB Python client, see the
[Python library documentation](../dev/libraries/python.md).
Expand All @@ -17,15 +22,9 @@ On macOS and Linux, you can use [Homebrew](https://brew.sh/) to install `super`:
```bash
brew install --cask brimdata/tap/super
```
Once installed, run a [quick test](hello-world.md).

## Building From Source

>[!TIP]
> If you don't have Go installed, download and install it from the
> [Go install page](https://golang.org/doc/install). Go 1.24 or later is
> required.

With Go installed, you can easily build `super` from source:

```bash
Expand All @@ -34,6 +33,11 @@ go install github.com/brimdata/super/cmd/super@main

This installs the `super` binary in your `$GOPATH/bin`.

>[!TIP]
> If you don't have Go installed, download and install it from the
> [Go install page](https://golang.org/doc/install). Go 1.24 or later is
> required.

## Try It

Once installed, run a [quick test](hello-world.md).