Documentation

Get started with Augure Code

The coding agent in your terminal. Install it with one line, connect your Augure account or an API key, and it reads your repo, edits files, runs commands, and fixes what breaks.

1. Install

One line on macOS or Linux. The installer downloads the build for your platform, verifies its checksum, and puts augure on your PATH.

Terminal
curl -fsSL https://augureai.ca/install.sh | sh

Platforms: macOS 12+ (Apple Silicon and Intel) and Linux x64/arm64 (glibc 2.34+ — Ubuntu 22.04+, Debian 12+, RHEL 9+, Fedora 35+). On Windows, install inside WSL2.

What it touches: the binary goes to ~/.local/bin (or /usr/local/bin), and a default config to ~/.codex/config.toml. An existing config is never overwritten.

2. Connect your account

The installer asks how you want to connect, and augure itself offers the same choices on first run. There are two ways in — use whichever fits.

Option A — Sign in with your Augure account

Best for interactive work. Works with every plan, Free included — paid plans include Augure Code compute in your plan's monthly allowance, with nothing extra to set up.

Terminal
augure login

Your browser opens at chat.augureai.ca. Sign in with Google, Microsoft, or email — then the tab says “Signed in to Augure, you can close this tab” and your terminal confirms with your email. Credentials live in ~/.codex/augure-auth.json, refreshed automatically; augure logout removes them.

Already signed in on the web? You'll still be asked to sign in — that's deliberate. The terminal gets its own private session, handed to it directly and never stored in your browser, so signing out of the website later can't break your CLI.

Option B — Use an API key

Best for CI, automation, and heavy agent work: pay-per-use in CAD, no plan limits. Create a key in the developer dashboard (access is instant; a payment method is required before your first key). The key is shown once — copy it right away.

Terminal
# paste it when the installer or first run asks, or:
export AUGURE_API_KEY=<your key>

You can hold up to 5 active keys and rotate or revoke them in the dashboard. A safety cap of $500 CAD per day applies across your account.

Privacy note: model traffic goes to exactly one host — api.augureai.ca — with zero data retention. Account sign-in and token refresh additionally use Augure's Canadian-hosted authentication service, and the CLI checks Augure's release host for updates at most once a day (disable with check_for_update_on_startup = false). Every host is ours — nothing third-party, ever.

3. Your first session

Run augure in any repo and type what you want done — “explain this codebase”, “fix the failing test”, “add a --verbose flag”. The agent explores, proposes changes, and asks before running anything outside its sandbox.

/model switches models. Rosedale One is the strongest coding model and needs a Pro or Max plan (or an API key).

Free plan? If a model isn't included in your plan, Augure Code picks an available one at startup and tells you — you can start on Free and upgrade when ready.

AUGURE.md in your repo root gives the agent standing instructions for that project.

Headless & CI

augure exec runs one task without the interactive UI and never prompts for anything — configure auth first. An API key via environment variable is the right tool here.

CI example
export AUGURE_API_KEY=<your key>
augure exec "run the test suite and summarize the failures"

# non-interactive install (no prompts):
curl -fsSL https://augureai.ca/install.sh | AUGURE_NON_INTERACTIVE=1 sh

Use another coding tool

Prefer OpenCode, Cline, Aider, Continue or Zed? On Max and Ultra you can point them at your own plan with a CLI token. Usage is drawn from the subscription you already pay for — no API key, no second bill, and no card on file.

Create one under Settings → Connect a coding tool. The token is shown once, expires in 90 days by default, and can be revoked whenever you like — one per machine is the usual setup.

~/.config/opencode/opencode.json (or opencode.jsonc)
{
  "$schema": "https://opencode.ai/config.json",
  "provider": {
    "augure": {
      "npm": "@ai-sdk/openai-compatible",
      "name": "Augure",
      "options": {
        "baseURL": "https://api.augureai.ca/v1",
        "apiKey": "{env:AUGURE_TOKEN}"
      },
      "models": {
        "ossington-5": { "name": "Ossington 5" },
        "tofino-3": { "name": "Tofino 3" },
        "rosedale-1": { "name": "Rosedale One" }
      }
    }
  }
}

The file matters as much as its contents: OpenCode reads ~/.config/opencode/opencode.json (or opencode.jsonc) for global config, or an opencode.json in the project root. Signing in without this block leaves you with a token and no provider — the model picker stays empty, which looks like the token failed.

Then either export AUGURE_TOKEN=aug_cli_…, or store the token in OpenCode's own keychain and drop the apiKey line entirely:

Store the token instead of exporting it
opencode auth login
#   → choose "Other"
#   → provider id:  augure      ← the id, NOT the token
#   → paste your aug_cli_… token when it asks for the key

opencode models | grep augure   # augure/ossington-5, augure/tofino-3, …
opencode run --model augure/tofino-3 "say hello"

Anything that speaks the OpenAI API works the same way: the base URL above, the token as the API key.

Troubleshooting

“Missing environment variable: AUGURE_API_KEY”

No credentials are configured. Run augure login to use your Augure account, or export the key. (Builds before v1.0.2 word this error without mentioning augure login — it works there too.)

“… requires a Pro plan” (HTTP 429)

The selected model isn't included in your plan. Pick another with /model, or upgrade at chat.augureai.ca/pricing. Other 429s are daily or monthly usage limits — the message says which, and when it resets.

“API access is paused” (HTTP 402)

Your payment method lapsed. Update it in the developer dashboard and requests resume immediately.

Updating

From v1.0.2, Augure Code shows a notice when a new version is out — run augure update to install it (checksum-verified; config and credentials untouched). Re-running the installer works too, and is the way to update from v1.0.0/v1.0.1.

Where things live

Config: ~/.codex/config.toml · Account credentials: ~/.codex/augure-auth.json (removed by augure logout) · Binary: ~/.local/bin/augure or /usr/local/bin/augure.

Ready to build?

One line to install. Sign in with your plan, or go pay-per-use with an API key.

About Augure CodeGet an API key