Tutorial
Install GigaBrain
Get the gbrain binary onto your machine in one command.
This tutorial gets gbrain on your PATH the fastest way: one shell command, no Rust toolchain. For variants — building from source, the airgapped vs online channel, npm — see Airgapped vs online afterwards.
Before you start
Section titled “Before you start”You’ll need:
- macOS (Apple Silicon or Intel) or Linux (x86_64 or ARM64).
- A shell where you can pipe to
sh. - Permission to write to
~/.local/bin(the default install directory).
Windows users: the install script does not yet support Windows. The cross-platform release binary works under WSL2; native Windows is on the roadmap.
Step 1 — Run the installer
Section titled “Step 1 — Run the installer”curl -fsSL https://raw.githubusercontent.com/macro88/gigabrain/main/scripts/install.sh | sh The installer:
- Detects your platform.
- Downloads the matching airgapped binary from the latest GitHub Release.
- Verifies the SHA-256 checksum.
- Moves the binary to
~/.local/bin/gbrain. - Adds the directory to
PATHin your shell profile (unless you pass--no-profile).
Step 2 — Confirm it’s on your PATH
Section titled “Step 2 — Confirm it’s on your PATH”Open a new shell or source your profile, then:
gbrain version
gbrain --help You should see a version line beginning with gbrain v0.9.x. If gbrain: command not found, ensure ~/.local/bin is on your PATH (the installer prints a hint for your shell on success).
Step 3 — Pin a specific version (optional)
Section titled “Step 3 — Pin a specific version (optional)”The installer always grabs the latest release. To pin:
curl -fsSL https://raw.githubusercontent.com/macro88/gigabrain/main/scripts/install.sh | GBRAIN_VERSION=v0.9.8 sh What you got
Section titled “What you got”By default, the installer fetches the airgapped binary. That means:
- The BGE-small embedding model is bundled inside the binary.
- The first time you run a semantic query, no download happens.
- The binary is ~180 MB.
If you’d rather have a smaller binary that downloads model weights on first use, see Airgapped vs online.
Where things live
Section titled “Where things live”| Path | What |
|---|---|
~/.local/bin/gbrain | The binary itself. |
~/.gbrain/skills/ | Embedded skills, extracted on first run. |
~/.gbrain/models/ | Cached model weights (online channel only). |
~/brain.db (you choose) | Your actual knowledge brain. We’ll create this in the next tutorial. |
Now build your first brain
Ten minutes from here to a working brain that answers your first question. If anything went sideways during install, the troubleshooting page covers the common failure modes.