Open documentation index
Getting startedOverviewInstallationQuick startCore concepts
ConfigurationConfiguration referenceProvidersRouting and failoverRate limiting
OperationsStorageObservabilitySecurityTUI dashboardAI routing
ReferenceCLI referenceAdmin APITroubleshooting
Docs/Reference/CLI reference
Reference

CLI reference

Command groups for running the proxy, editing configuration, managing keys and secrets, reading logs, and diagnosing AI routing.

Global usage

Terminal
modelmux --help
modelmux --config /path/to/config.yaml <command>
modelmux version

Use --help on any command or subcommand for the authoritative flags available in the installed version.

Server and TUI

CommandPurpose
modelmux startStart the HTTP proxy server.
modelmux tuiOpen the terminal dashboard.
modelmux versionPrint version, commit, and build timestamp.

Configuration commands

CommandPurpose
modelmux config initCreate an example configuration file.
modelmux config validateValidate YAML and configuration relationships.
modelmux config validate --jsonReturn machine-readable validation output.
modelmux config validate --check-providerAlso test provider connectivity.

Providers, models, and groups

CommandPurpose
modelmux provider add ...Add a provider to configuration.
modelmux model add ...Add a model to configuration.
modelmux group add ...Add a model group to configuration.
modelmux providersList providers; supports JSON output.
modelmux modelsList models; supports JSON output.
modelmux groupsList groups; supports JSON output.

The exact add-command flags can evolve. Use modelmux provider add --help, modelmux model add --help, and modelmux group add --help.

Key commands

CommandPurpose
modelmux key add ...Add a key to configuration.
modelmux key test --id <key>Test a key against its provider.
modelmux key enable --id <key>Enable a key in config and runtime.
modelmux key disable --id <key>Disable a key in config and runtime.
modelmux keysList configured keys; supports JSON output.

Secret-store commands

CommandPurpose
modelmux secret set --ref nameStore a value using a hidden prompt.
modelmux secret set --ref name --value "$TOKEN"Store a value non-interactively.
modelmux secret listList stored secret references, not plaintext values.
modelmux secret delete --ref nameDelete one stored reference.
modelmux secret export --output fileExport an encrypted backup.
modelmux secret import --input fileImport an encrypted backup.
modelmux secret verifyCheck encrypted-store integrity.
modelmux secret rotate-master-keyRe-encrypt with a new master key.

Logs and resource lists

Terminal
modelmux logs --limit 50
modelmux logs --model-id example-chat
modelmux logs --status-code 429
modelmux logs --json --limit 100

modelmux providers --json
modelmux models --json
modelmux keys --json
modelmux groups --json

AI diagnostics

CommandPurpose
modelmux ai classify --file request.jsonClassify a saved request.
modelmux ai route --file request.json --jsonPreview policy routing.
modelmux ai explain --request-id <id>Explain routing for a recorded request.
modelmux ai doctor-configValidate AI routing configuration.