mint CLI
The mint command-line interface ships with the mint-sdk package (PyPI). It does not start the platform — the platform server is launched directly via uvicorn api.main:app (see Install on Linux). mint covers two complementary roles:
| Role | What it does | Detail |
|---|---|---|
| Plugin development | Scaffold, run, build, and manage plugin projects | Plugin Development → CLI reference |
| Platform-data CLI | Talk to a running platform (auth, list experiments, create projects, check status) | Platform commands |
Verifying the install
bash
mint --version
# → mint <version>
mint --helpIf the command isn't found, the install location isn't on your PATH. With uv tool install mint-sdk, run uv tool update-shell. With pip install --user mint-sdk, add ~/.local/bin to PATH.
Command index
Platform-data CLI (User Manual side)
| Command | Purpose |
|---|---|
mint auth login / logout / status / refresh | Acquire and manage a session token |
mint experiment list / get / create / update | CRUD on experiments via the platform API |
mint project list / get / create / archive | CRUD on projects |
mint status | Platform health overview |
Detail: Platform commands. Configuration of how mint reaches the platform: Configuration.
Plugin-development commands
These commands act on a plugin project (cd into the plugin's directory first):
| Command | Purpose |
|---|---|
mint init | Scaffold a new plugin project |
mint dev | Run the plugin (and optionally a local platform) with hot reload |
mint dev logs | Tail logs from a running plugin process |
mint build | Package the plugin into a .mint bundle |
mint doctor | Validate the plugin project structure |
mint info | Print the plugin's metadata |
mint docs | Open SDK docs in the browser |
mint sdk link / unlink / update | Manage the plugin's SDK pin |
Full details — every flag, every subcommand: Plugin Development → CLI reference.
What mint is not
- Not a platform launcher.
mint servedoesn't exist. Start the platform withuvicorn api.main:app. - Not a
pip install <plugin>replacement. Plugins are typically installed through the marketplace UI;mintdoesn't have aplugin installsubcommand. - Not a daemon.
mint devruns in the foreground.
Next
→ Platform commands → Configuration → Plugin development → CLI reference