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

Quickstart

This guide gets you from first launch to your first completed turn.

1. Launch the TUI

swarmie

If this is a new workspace, accept trust to initialize .swarmie/.

2. Connect a provider

In the prompt, run:

/connect

Choose an OAuth provider (for example openai-codex, anthropic, github-copilot) or API-key setup (anthropic, openai, ollama).

3. Send your first message

Type normal text and press Enter:

Explain the architecture of this repository.

Swarmie streams assistant output as it arrives.

4. Respond to permission prompts

When a tool action needs approval, use:

  • y allow once
  • n deny
  • a always allow this session rule
  • ! bypass all approvals

5. Useful slash commands

  • /status open runtime status
  • /models open model picker
  • /config open configuration modal
  • /skills open skills picker
  • /hooks open hooks picker
  • /resume open session picker
  • /new start a fresh session
  • /exit or /quit exit

Type / to open command completion.

Keyboard quick reference

  • Shift+Enter newline
  • Ctrl+C cancel/clear/exit flow
  • Ctrl+D exit
  • Ctrl+L clear output
  • Ctrl+O collapse/expand tool blocks
  • Ctrl+N / Ctrl+P switch active agent
  • Ctrl+Y copy last assistant response
  • Alt+P model picker
  • Alt+T cycle thinking level

One-shot mode (non-interactive)

swarmie prompt "Summarize the project in 5 bullets"

Read prompt from stdin:

cat request.txt | swarmie prompt -

Emit JSONL-ish event lines:

swarmie prompt "Describe current dir" --json

Resume previous sessions

swarmie resume
swarmie resume --last