Getting started¶
Install¶
minacode supports macOS and Linux only
Python 3.11 or newer
uv to install and run
uv tool install minacode
Upgrade¶
uv tool upgrade minacode
minacode checks PyPI at most once a day and reports an available update at startup and in
/status.
Configure¶
minacode needs one thing to start: a provider to talk to. Generate a starter config:
minacode --init-config
This writes ~/.minacode/config.toml. Only the [provider] block is required; every other
setting has a built-in default, and the file lists the common ones as comments.
Point it at a provider¶
minacode speaks to any OpenAI-compatible API (and to Anthropic). Open the config and fill in a provider — for example DeepSeek:
[provider]
active = "default"
[provider.default]
url = "https://api.deepseek.com"
key = "sk-..."
model = "deepseek-v4-flash"
Key |
Meaning |
|---|---|
|
Base URL of the API |
|
Your API key |
|
Model name to use |
You can define several [provider.<name>] blocks and switch between them with active (or
/provider inside a session). See Configuration for every option,
including reasoning effort and per-host tuning.
Start a session¶
minacode
Type a request in plain language and the agent starts working — reading files, proposing
edits, running commands. Before anything that changes files or runs a command, it asks for
confirmation (unless you pass --yolo). You can keep typing while it works; see
Follow-ups.
Exit with /exit, /quit, or Ctrl-D.
Command-line flags¶
Flag |
Effect |
|---|---|
|
Resume the most recent session in this project |
|
Resume a saved session; with no |
|
Skip confirmation prompts for mutating tools |
|
Override the configured terminal color theme |
|
Use a specific config file instead of |
|
Write a starter config file and exit |
|
Show command-line help and exit |
|
Print the version and exit |