Start here

Quickstart

Install a release, run a read-only review of your repository, and inspect it in the console.

Your first workflow is a code review: one agent inspects your repository and reports correctness issues without being asked to change files.

1. Install a release

Install Go 1.27.1 or later, then install the published v0.12.1 release:

go install github.com/tylergannon/gimble/cmd/gimble@v0.12.1
gimble --help

This release predates the Gimbal rename, so its package and command are still spelled gimble. Use that spelling throughout the release instructions below. Its console is included; you do not need to build a frontend.

If your shell cannot find gimble, add Go’s binary installation directory to your PATH: GOBIN when set, otherwise the bin directory under go env GOPATH.

2. Connect an agent

This example uses Codex. Install the Codex CLI on the same machine, make sure codex is on your PATH, and sign in:

codex login
codex app-server daemon version

The second command checks that your Codex installation supports the shared daemon interface and reports its status. A stopped status is fine: Gimbal starts the daemon when its first agent needs it. If your Codex installation does not support that command, use a compatible Codex installation before continuing, or choose another supported harness.

The release’s review model defaults to gpt-6-luna. Your Codex account must have access to it; use --code-review MODEL to select another model available to your account. gimble run review --help shows the role flag and its default.

3. Run a review

Open two terminals in the repository you want reviewed. In the first, start the instance and leave it running:

cd ~/src/your-project
gimble --project .

Open http://127.0.0.1:8080 to see the console. In the second terminal, submit the review from the same repository:

cd ~/src/your-project
gimble run review   --project .   --goal "Review the current changes for correctness bugs"   --follow

Keep both terminals in that directory so they select the same instance. The running instance uses the agent configuration and PATH it had when you started it.

4. Inspect the result

In the console, open the review run from the runs list. Check its final status, then inspect the reviewer’s findings. An empty findings list means the reviewer reported no correctness issues for that goal.

127.0.0.1:8080
The console's runs list, showing each run's status and latest activity.

--follow waits for the run to succeed or fail. Keep the instance running to inspect its recorded runs afterward. The console’s current strengths and known visibility gaps are described in Status.

For another task, choose a built-in workflow. To write your own, continue to Writing workflows.

For contributors: build from source

Use this path to develop Gimbal or get changes newer than the published release. It requires Go 1.27.1, Node 24, pnpm 12.10.1, and just.

git clone https://github.com/tylergannon/gimbal
cd gimbal
just build
./bin/gimbal --help

The current source builds a command named gimbal. Follow the review steps above with gimbal in place of gimble, using the absolute path to your built binary, or run go install ./cmd/gimbal after building to put it on your PATH.

For library use and examples, continue to the workflow authoring guide.

Next Console