Maki Docs

Maki is a terminal coding agent written in Rust, built bottom up to spend as few tokens as possible without getting dumber. Point it at a repo, pick a provider, and it reads, searches, edits, and runs code for you.

The docs are sorted by what you came here to do:

Getting Started new to maki

Quick StartInstall, connect a provider, first session. Configurationinit.lua, the small Lua script where all settings live.

Guides getting things done

SkillsWrite Markdown playbooks the agent loads on demand. PluginsAdd your own tools and commands in Lua, or let the agent write them. Background TasksPress Ctrl+B to keep a build or subagent running while the agent carries on. Headless Mode--print for scripts and CI. Drop-in Claude Code compatible. ACPDrive Maki from your editor, like Zed, over the Agent Client Protocol.

Concepts wondering why

Token EconomyWhere tokens go in an agent loop, and every trick Maki uses to spend fewer of them. ContextWhat enters the model's context and when, and where to put project knowledge.

Reference looking something up

ToolsEvery built-in tool and its parameters. ProvidersModel catalogs, env vars, providers.toml, model tiers. PermissionsWhat runs freely, what asks first, TOML rules. Folder TrustWhether a project's .maki config may run on your machine. NotificationsKnow when a session finishes or needs your input. MCPExternal tool servers over stdio or HTTP. CommandsThe / palette, sessions, toggles, custom commands. KeybindingsDefaults, precedence, rebinding from Lua. Lua APIThe plugin surface, mirrored from Neovim. HooksRewrite, block, or trim a tool call from Lua. Lua PackagesLoad external Lua plugins from Neovim-style package directories. CLIFlags and subcommands (auth, models, acp, prompt, ...). TelemetryOpt-in OpenTelemetry metrics and events, to a collector you run.

Something missing or wrong? Open an issue on GitHub.