Command Reference¶
This page summarizes moi-cli command syntax, global options, all 16 core top-level command groups, local file upload flag conventions, and offline introspection tools. For credential setup and role mapping precedence, see Configuration and Authentication.
moi-cli [global options] <command-group> <subcommand> [flags]
Global options¶
Place global options before <command-group> (single-dash -flag or double-dash --flag syntax is accepted):
Option |
Default |
Description |
|---|---|---|
|
|
Authentication mode: |
|
Local fallback (required for remote servers) |
Full Product API base URL, such as |
|
Empty (reads config file) |
Raw personal access token for PAT mode, sent in the |
|
Empty (reads config or login) |
Target workspace ID for the current invocation. |
|
Command default ( |
Positive HTTP deadline covering request send and response body read, such as |
|
|
Writes business responses as JSON to |
|
|
Disables interactive terminal prompts such as pagination. |
|
|
Enables verbose diagnostic output. |
|
|
Prints the binary version and exits (offline). |
|
|
Prints global, group, or subcommand usage and exits (offline). |
Top-level command groups¶
The table below maps all 16 core business command groups to their domain task guides:
Command group |
Primary responsibilities |
Task guide |
|---|---|---|
|
Manage saved endpoint, PAT, default workspace, and workspace role mappings ( |
|
|
List, create, ensure by name ( |
|
|
Inspect current principal, invite and manage workspace members, maintain user tags, and query member audit logs |
|
|
Manage roles, role inheritance, user role bindings, application policies, object grants, and row/column data privileges |
|
|
Retrieve workspace database connection parameters and session initialization SQL ( |
|
|
Manage catalogs, databases, tables, volumes, file uploads and downloads, data assets, and NL2SQL |
|
|
Check publish names, create and manage cross-workspace data publications, resolve target workspaces, and manage subscriptions |
|
|
Manage external connectors, browse database and structured sources, sample |
|
|
Manage knowledge bases and semantic entries, upload and append data sources, edit document segments, and reconcile source jobs |
|
|
Search bound knowledge bases, paginate evidence, locate parsed Markdown documents, and submit citations under task-scoped authorization |
|
|
Deploy workflows, validate candidate projects, trigger executions, configure cron schedules, and publish API/MCP services |
|
|
Execute SQL queries, fetch results and catalog metadata, cancel queries, and manage SQL workbooks and query history |
|
|
Create and manage dashboards, chart configurations, and workspace task execution overviews |
|
|
Invoke agents, submit interactive inputs, manage versions/automations/skill packages, and configure messaging channels and plugins; |
Agents, Conversations, and Automations, Messaging Channels and Plugins |
|
List models, test model connectivity, and manage LLM, Embedding, and Parser provider backends and routing |
|
|
Inspect compute specs, create and resize compute instances, pause or resume instances, and read runtime metrics |
In addition to business command groups, moi-cli includes local utility commands: schema and skill inspect wire contracts and bundled operational references offline, and update checks or rolls back managed client installations (see Install and update MOI-CLI).
Local file upload flags¶
Subcommands that upload local regular files share the --file-path flag convention across domains:
Catalogs and volumes:
catalog upload,catalog upload-private(plus direct-path aliasescatalog upload-fileandcatalog upload-private-file)Knowledge base sources:
semantic-model upload-local-file,semantic-model upload-model-local-fileConnector imports:
connector local-upload,connector upload(only connector uploads accept repeated--file-pathflags for multi-file batches)Agent and skill packages:
agent load-agent-package,agent upload-workspace-file,agent inspect-skill-package,agent import-skill-package
Shared upload flags:
Flag |
Default |
Description |
|---|---|---|
|
Required |
Path to a local regular file; mutually exclusive with |
|
Local file basename |
Overrides the filename sent to the server (single-file upload commands). |
|
|
Maximum total bytes read into memory for a single invocation; increase explicitly when uploading files larger than 64 MiB. |
moi-cli -auth pat -o semantic-model upload-local-file \
--file-path ./handbook.pdf \
--max-upload-bytes 134217728
Offline introspection: help, JSON schemas, and bundled skills¶
Before writing complex JSON request files or when working offline, use these three built-in introspection mechanisms to verify exact flags and payload shapes supported by your binary:
1. Command tree and flag help (--help)¶
moi-cli --help
moi-cli workflow --help
moi-cli workflow deploy --help
2. JSON payload inspection and offline validation (schema)¶
moi-cli schema prints wire-level JSON input contracts (including nested or string-encoded subfields) and validates local JSON files structurally without sending network requests:
# List all commands with registered offline schemas
moi-cli schema
# Inspect JSON array or nested argument shapes for specific commands
moi-cli schema semantic-model append-sources
moi-cli schema workflow deploy --argument dynamic-service-file
moi-cli schema dashboard create-chart --argument json.chart_config
# Validate a local JSON payload offline (no network call is sent)
moi-cli schema iam create-role --validate-file ./role.json
Use --validate-file on schemas marked as validation-enabled; server-side permission checks, concurrency version checks, and business rules still apply when executing the live command.
3. Bundled capability search and export (skill)¶
Each moi-cli binary bundles paired operational references that can be searched by keyword, read by relative path, or exported offline to a new directory:
moi-cli skill search --query 'channel create' --limit 5
moi-cli skill read --path references/workflows.md
moi-cli skill export --dir ./moi-cli-skill
skill export --dir requires a non-existent destination directory so existing local files are never overwritten.