Quick Start

Install

cargo install maki

API Keys

Export a key for at least one provider:

ProviderEnvironment Variable
AnthropicANTHROPIC_API_KEY
OpenAIOPENAI_API_KEY
Z.AIZHIPU_API_KEY
SyntheticSYNTHETIC_API_KEY

OpenAI also supports OAuth via device flow. Run maki auth login openai and it will walk you through setting it up.

Run

From your project directory:

maki

Type a prompt, press Enter, and the agent starts working.

Keybindings

  • Newline in input: Shift+Enter, Ctrl+J, or Alt+Enter
  • Scroll output: Ctrl+U / Ctrl+D (half page), Ctrl+Y / Ctrl+E (line)
  • Cancel streaming: Esc Esc
  • Quit: Ctrl+C
  • All keybindings: Ctrl+H

Choosing a Model

Set a default in your config:

# ~/.config/maki/config.toml
[provider]
default_model = "anthropic/claude-sonnet-4-6"

You can also switch models mid-session with the built-in model picker.

Project Configuration

Add a .maki/ directory to your project root for per-project settings:

.maki/
├── config.toml        # Overrides global config
└── permissions.toml   # Permission rules
AGENTS.md              # Loaded into agent context automatically

AGENTS.md is loaded at the start of every session. Put coding conventions, repo quirks & gotchas, or off-limits directories in here. Maki will automatically load AGENTS.md files inside subdirs when doing a read in the subdir.

See Configuration for all options.