Skip to content

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:

RoleWhat it doesDetail
Plugin developmentScaffold, run, build, and manage plugin projectsPlugin Development → CLI reference
Platform-data CLITalk to a running platform (auth, list experiments, create projects, check status)Platform commands

Verifying the install

bash
mint --version
# → mint <version>
mint --help

If 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)

CommandPurpose
mint auth login / logout / status / refreshAcquire and manage a session token
mint experiment list / get / create / updateCRUD on experiments via the platform API
mint project list / get / create / archiveCRUD on projects
mint statusPlatform 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):

CommandPurpose
mint initScaffold a new plugin project
mint devRun the plugin (and optionally a local platform) with hot reload
mint dev logsTail logs from a running plugin process
mint buildPackage the plugin into a .mint bundle
mint doctorValidate the plugin project structure
mint infoPrint the plugin's metadata
mint docsOpen SDK docs in the browser
mint sdk link / unlink / updateManage the plugin's SDK pin

Full details — every flag, every subcommand: Plugin Development → CLI reference.

What mint is not

  • Not a platform launcher. mint serve doesn't exist. Start the platform with uvicorn api.main:app.
  • Not a pip install <plugin> replacement. Plugins are typically installed through the marketplace UI; mint doesn't have a plugin install subcommand.
  • Not a daemon. mint dev runs in the foreground.

Next

Platform commandsConfigurationPlugin development → CLI reference

MINT is open source. Made by the Morscher Lab.