Quickstart

Get from zero to a productive AI session in 5 minutes.

1. Install

curl -fsSL https://raw.githubusercontent.com/muvon/octomind/master/install.sh | bash

2. Set API Key

export OPENROUTER_API_KEY="your_key"

Get a key at openrouter.ai. OpenRouter gives you access to many AI providers through a single key.

3. Generate Config

octomind config

Creates ~/.local/share/octomind/config/config.toml with sensible defaults.

4. Start a Session

octomind run

You're now in an interactive AI session with full tool access. The AI can read files, edit code, run commands, and manage your project.

What You Can Do

Ask questions about your code:

How does the authentication system work?

Make changes:

Add error handling to the login function

Run commands:

Run the test suite and fix any failures

Attach images for analysis:

/image screenshot.png

Essential Commands

CommandDescription
/helpShow all commands
/infoToken usage and costs
/image <path>Attach image for AI analysis
/exitExit session

Session Modes

# Default: interactive with tools
octomind run

# Chat-only (assistant role)
octomind run assistant

# Named session (resume later)
octomind run --name my-feature

# Resume a session
octomind run --resume my-feature

# Tap agent (fetches specialized config)
octomind run octomind:developer

Non-Interactive Mode

Pipe a message via stdin and get a response:

echo "Explain the auth module" | octomind run developer --format plain

Structured JSON output for pipelines:

echo "List TODO items" | octomind run developer --format jsonl

Next Steps