Introduction
What Mate is and where to find things in these docs.
Mate is an alpha CLI for running coding agents with project-specific context, policies, and capabilities already wired in.
It uses two repositories:
- companion repository: stores Mate configuration, agent instructions, skills, and capability output
- working repository: stores the project code agents should edit
The default workflow runs from the working repository: mate install,
mate companion link, then mate claude or mate opencode. Linking selects or
clones a companion and installs its selected requirements before the first
launch. Each launch then syncs the companion’s managed files into the working
repository. The two repositories keep separate histories. No companion yet?
Create one first.
Sections
Getting Started
Install Mate, link a companion, and launch your first agent.
Concepts
The repository model and the secret guardrails.
Scenarios
Step-by-step walkthroughs of the core flows.
Capabilities
Optional tools such as OpenSpec, Graphify, TokenSave, and React Doctor.
Reference
The CLI commands, their context, and their options.
Troubleshooting
Diagnose installation, linking, launch, and Git problems.