Installation

• A terminal (macOS Terminal, Linux shell, Windows PowerShell)
• An API key from at least one supported provider (see Providers)

Quick Installation

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

This detects your OS and architecture, downloads the latest release, and installs to /usr/local/bin/.

Manual Installation

Download the appropriate binary from GitHub Releases:

# Example: macOS Apple Silicon
chmod +x octomind-darwin-arm64
sudo mv octomind-darwin-arm64 /usr/local/bin/octomind

Package Managers

Cargo (Rust)

cargo install octomind

Requires Rust 1.95+. See Building from Source for development setup.

API Key Setup

Set at least one provider API key as an environment variable:

# OpenRouter (recommended -- access to many providers)
export OPENROUTER_API_KEY="your_key"

# Or use a specific provider
export OPENAI_API_KEY="your_key"
export ANTHROPIC_API_KEY="your_key"
export DEEPSEEK_API_KEY="your_key"

Add to your shell profile (~/.bashrc, ~/.zshrc, etc.) for persistence. Or use a .env file in your project directory.

See Environment Variables for all supported variables.

Shell Completions

Generate completions for your shell:

# Bash
octomind completion bash > ~/.local/share/bash-completion/completions/octomind

# Zsh
octomind completion zsh > ~/.zfunc/_octomind

# Fish
octomind completion fish > ~/.config/fish/completions/octomind.fish

# PowerShell
octomind completion powershell > octomind.ps1

For Zsh, ensure ~/.zfunc is in your fpath:

echo 'fpath=(~/.zfunc $fpath)' >> ~/.zshrc
echo 'autoload -Uz compinit && compinit' >> ~/.zshrc

CI/CD Installation

The install script supports environment variables for automated environments where GitHub API rate limits may apply:

# CI example
GITHUB_TOKEN="${{ secrets.GITHUB_TOKEN }}" \
  OCTOMIND_VERSION="0.23.1" \
  curl -fsSL https://raw.githubusercontent.com/muvon/octomind/master/install.sh | bash

Verification

# Check installation
octomind --version

# Generate default config
octomind config

# Start your first session
octomind run

Configuration is stored at ~/.local/share/octomind/config/config.toml. See Configuration for details.