OKAMI AGENTby OKAMI
// start · 04

Choose the right path

Use this page as a router through the documentation: pick the goal, follow the sequence and jump to the relevant pages.

Open in full documentationGitHub
  1. Install

    Install and run doctor. In alpha, you can also clone the repo and review the script first.

    curl -fsSL https://okamiagent.com/install.sh | bash
git clone https://github.com/OkamiOps/Okami-Agent && cd Okami-Agent && ./scripts/install.sh
okami doctor
  2. Configure

    Use setup instead of hand-editing YAML.

    okami setup
  3. Chat

    Open the TUI and validate the loop.

    okami chat
  4. Run a verifiable task

    Use exit criteria.

    okami task "create hello.txt with hi" -e file_exists:hello.txt
Reliable UIFrontend skills + contracts.ui + ui_gate.ProductionSandbox, strict policy, retention and API token.ChannelsGateway, Telegram, HTTP API and Paperclip.Multi-agentIsolated agents, groups and routing.ReliabilityHarness, exit criteria, anti-loop and trace.CapabilitiesBuiltin tools, sensitivity and commands.

Open this page in the interactive docs