grithdocs

grith setup

The interactive first-run wizard: pick how you will use grith, connect a provider, start a trial.

grith setup

The first-run wizard. It is interactive only - there are no flags beyond the global ones, and it needs a terminal on both stdin and stdout.

grith onboarding is the same command.

The screens

  1. Welcome - what grith does.
  2. Mode - how you intend to use it:
    • Exec - supervise external tools. No built-in provider is configured.
    • Ollama - local models.
    • Cloud - Anthropic, OpenAI or OpenRouter.
  3. Trial - offer to start a Pro trial.
  4. Guide - a short orientation printed after the wizard exits.

Cloud providers take their key from the environment - ANTHROPIC_API_KEY, OPENAI_API_KEY or OPENROUTER_API_KEY. The wizard does not ask you to paste a key into a config file.

When it runs on its own

Only on a first interactive launch of bare grith or grith run, and only when general.onboarded is still false and both stdin and stdout are terminals. Set --skip-onboarding or GRITH_SKIP_ONBOARDING=1 to suppress it.

grith init stamps onboarded = true as it writes the file, so a config you created deliberately does not get a wizard on top of it.

ℹ️grith exec never shows the wizard

The first time you run grith exec it prints a single line to stderr - that grith is now supervising the tool, and where the dashboard is - then launches the tool immediately. It never interrupts a supervised session with a wizard.

See also

Last updated: 2026-08-24Edit this page on GitHub →