Maki Docs

Maki is a terminal coding agent written in Rust. Point it at a codebase, pick an LLM provider, and it reads, edits, searches, and runs code for you while keeping token usage low.

This page is a map of the docs. Skim it once, then jump to what you need.

Start here

New to Maki? Two pages get you going:

  • Quick Start installs Maki and connects your first provider. Takes a few minutes.
  • Configuration covers init.lua, the small Lua script where all settings live.

Everyday use

Answers to the "how do I..." questions once Maki is running:

  • Commands: everything behind the / palette, from /model to /btw.
  • Keybindings: move around the TUI without touching the mouse.
  • Tools: the full reference for the 20 built-in tools the agent works with.
  • Permissions: decide what the agent may do on its own and when it must ask you first.

Connecting things

  • Providers: Anthropic, OpenAI, Ollama, and friends, plus the weak, medium, and strong model tiers.
  • MCP: plug in external tool servers over stdio or HTTP.

Extending and embedding

  • Lua API: write plugins in Lua with an API that mirrors Neovim.
  • Headless Mode: run Maki with --print in scripts and CI. Output is Claude Code compatible.
  • ACP: drive Maki from your editor, like Zed, over the Agent Client Protocol.

Something missing or wrong? Open an issue on GitHub.