CLI¶
moi-cli is the official command-line client for MatrixOne Intelligence. It calls Product APIs from your terminal or CI pipelines to manage workspaces, catalogs, connectors, knowledge bases, workflows, SQL queries, agents, and compute instances. If you have not installed the client yet, start with Install and update MOI-CLI or run your first request in Use the CLI.
Basic syntax¶
moi-cli [global options] <command-group> <subcommand> [flags]
Place global options (such as -auth, -o, -workspace-id, and -request-timeout) before <command-group>, and place operation flags (such as --name, --model-id, and --json-file) after <subcommand>.
Quick verification¶
After installing the binary and configuring credentials, run these three commands to verify the binary version, offline help, and Product API connectivity:
moi-cli -version
moi-cli --help
moi-cli -auth pat -o workspace list
-version and --help run offline locally without network access. workspace list calls the Product API and prints accessible workspaces as JSON.
Choose an entry point¶
Goal |
Entry page |
When to use |
|---|---|---|
Configure endpoints, credentials, and role mappings |
Set up PAT or Astra sign-in for the first time, pin a workspace role, or troubleshoot authentication. |
|
Write shell scripts and CI pipelines |
Pipe |
|
Run domain operations by resource |
Manage workspace permissions, catalogs and volumes, connectors, knowledge bases, workflows, SQL, agents, or compute instances. |
|
Look up global options, command groups, and schemas |
Check all 16 top-level command groups, file upload flags, and offline |