Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

Installation

Swarmie ships as the swarmie binary from the crates/cli crate.

Requirements

  • Rust toolchain with Cargo (stable recommended)
  • A terminal environment (TUI runs in terminal)
  • Network access for remote model providers

Install from source (this repository)

git clone https://github.com/j0nl1/swarmie.git
cd swarmie
cargo install --path crates/cli

Install from git directly

cargo install --git https://github.com/j0nl1/swarmie swarmie

Verify installation

swarmie --help

You should see top-level commands:

  • prompt (alias e)
  • resume
  • web

If you run swarmie with no subcommand, it starts the interactive TUI REPL.

First launch behavior

On first run in a project without .swarmie/, Swarmie asks whether you trust the workspace. If accepted, it creates:

  • .swarmie/config.toml
  • .swarmie/.gitignore
  • .swarmie/modes/

The generated config.toml is minimal and expects provider setup via /connect.

Config file locations

Swarmie merges config layers in this order (lowest to highest precedence):

  1. /etc/swarmie/config.toml
  2. ~/.swarmie/config.toml
  3. <project>/.swarmie/config.toml (only for trusted workspaces)
  4. CLI --config key=value overrides
  5. SWARMIE_* environment overrides

If no provider/model can be resolved at startup, use /connect in the TUI to set one up.