Command reference

Use moi-cli <command> --help to view the subcommands supported by a command group. This page describes top-level commands and global options; task pages refer only to the commands needed to complete a task.

Global options

Option	Purpose
-endpoint <url>	Specify the Product API endpoint.
-api-key <token>	Specify a personal access token.
-workspace-id <id>	Specify the workspace used by the current command.
-verbose	Output detailed information.
-o	Output results as JSON.
-no-interactive	Disable interactive prompts.
-version	Output the CLI version.
-help	Output help.

Configuration and workspaces

Command	Purpose
config	Save or view endpoint, personal access token, workspace, and role configuration.
workspace	Manage and query workspaces.
workspace-member	Manage workspace members.
iam	Query or manage identity- and permission-related resources.
account	Get database connection information for the current workspace.

Data and tasks

Command	Purpose
catalog	Operate on catalogs, databases, tables, volumes, and files.
connector	Manage connectors and import and export tasks.
semantic-model	Manage semantic models and data sources.
workflow	Deploy, run, query, cancel, or rerun workflows.
sql	Operate on SQL, workbooks, and SQL history.
compute	Manage compute instances and view metrics.
data-share	Manage data publications and subscriptions.

Agents and model supply

Command	Purpose
agent	Invoke agents and query tasks.
model	List models, probe model services, or set up an LLM Backend.
provider-backend	Manage Provider Backends, Endpoints, and Routers.

Other commands

Command	Purpose
dashboard	View a task execution overview.

When you are not sure which subcommands a command group supports, run the following command. Replace <command> with the actual command group, such as workflow:

moi-cli <command> --help

After configuring an endpoint and personal access token, use -help to view options for a specific subcommand:

moi-cli <command> <subcommand> -help

In the current CLI, --help shows the command group’s subcommand list.

Complete subcommand index

This index lists the subcommands exposed by each current CLI command group. Use it to locate a capability; confirm arguments, required input, and complex JSON shapes with moi-cli <command> <subcommand> -help.

config — Configuration

set-workspace · set-endpoint · set-api-key · set-role · unset-role · show

workspace — Workspaces

ensure · get · get-db-connection · list · create · claim delete

workspace-member — Workspace members

current-principal · members · invite · member · update · set-roles delete · update-status · create-user-tag · user-tags · update-user-tag · delete-user-tag audit-logs · audit-log-overview

catalog — Catalog

get · prepare · health · tree · system-tree · list create · info · update · delete · list-databases · create-database database-info · update-database · update-database-description · delete-database · database-children · database-table-leaves create-volume · volume-info · update-volume · delete-volume · volume-full-path · create-table table-info · multi-table-info · delete-table · table-data · preview-table · download-table table-exists · table-full-path · truncate-table · table-overview · files · create-file file-info · delete-file · delete-file-ref · trigger-file-workflow · download-file · preview-file upload-bytes · upload-file · upload · upload-private-bytes · upload-private-file · upload-private data-asset · batch-get-data-assets · file-data-asset · file-artifact · batch-resolve-file-artifacts · create-folder update-folder · delete-folder · clean-folder · run-nl2sql

workflow — Workflows

list · deploy · get · update · delete · pause resume · run · list-runs · list-all-runs · get-run · get-run-by-id refresh-run · pause-run · resume-run · get-run-result · get-run-result-by-id · get-run-import-context-by-id list-run-import-files-by-id · get-run-node-by-id · get-run-import-context · list-run-import-files · get-run-node · get-run-node-rerun-plan create-run-node-rerun · list-run-rerun-branches · get-run-rerun · cancel-run-rerun · retry-run · batch-retry-failed-files cancel-run · delete-run · list-file-executions · workitem-catalog · workitem-catalog-item · get-workitem-api-service publish-workitem-api-service · invoke-workitem-api-service · invoke-dynamic-service · invoke-workflow-dynamic-service · enable-workitem-api-service · disable-workitem-api-service custom-operators · create-custom-operator · get-custom-operator · get-custom-operator-code · test-custom-operator · update-custom-operator enable-custom-operator · disable-custom-operator · delete-custom-operator · catalog-file-lineage-overview · artifact-lineage-overview · artifact-output-blocks artifact-block-revisions · create-artifact-block-revision · switch-artifact-effective-revisions · artifact-node · artifact-node-output-blocks · artifact-node-block-revisions create-artifact-node-block-revision · switch-artifact-node-effective-revisions · create-artifact-node-rerun · create-target-artifact-node-revision-rerun · workflow-templates · get-workflow-template create-workflow-template · update-workflow-template · delete-workflow-template

sql — SQL

execute · describe · kill · result · history · meta-tables create-workbook · workbooks · update-workbook · delete-workbook · workbook-detail · workbook-versions create-workbook-version · update-workbook-version · save-workbook-version · meta-databases · meta-db-tree · meta-db-tables meta-table-info · meta-table-columns · meta-table-column-stats · meta-table-ddl · drop-meta-database · drop-meta-table drop-meta-view · execute-query · describe-query · kill-query · query-result · query-history-overview query-history · query-detail · query-profile · query-web-socket-url

agent — Agents

send · get-task · cancel-task · card · agent-card · a2a a2a-stream · load-agent-package · upload-workspace-file · inspect-skill-package · import-skill-package · get-skill-file polish-skill-stream · resource-get · resource-post · resource-put · resource-patch · resource-delete resource-any · create-channel-instance · list-channel-instances · get-channel-instance · update-channel-instance · test-channel-configuration disable-channel-instance · test-channel-instance · create-callback-rule · list-callback-rules · get-callback-rule · update-callback-rule delete-callback-rule

account — Account

db-connection

semantic-model — Semantic models

list · list-tags · create · get · update · delete create-with-sources · create-empty · upload-local-file · upload-model-local-file · preview-source-selection-counts · preview-model-source-selection-counts list-sources · list-sources-page · check-source-existence · append-sources · backfill-legacy-sources · delete-source get-source-document · update-source-governance · import-initial-segments · update-segment · delete-segment · create-segment update-segment-enabled · reembed-segments · set-current-segment-version · list-source-jobs · reconcile-source-jobs · list-entries create-entry · update-entry · delete-entry · import · export · validate

iam — IAM

permission-schema · roles · create-role · role-permission-view · update-role · update-role-lifecycle role-delete-impact · delete-role · validate-object-grants · apply-object-grants · object-permission-view

model — Models

list · list-embedding-models · setup-llm-backend · probe-llm-models · probe-embedding-models

provider-backend — Model services and routing

list · create · get · update · delete · create-endpoint list-endpoints · set-endpoint-status · router · update-router · probe-backend-models

connector — Connectors

list · get · create · update · delete · validate files · upload · local-upload · preview-file · db-list-databases · db-list-schemas db-list-tables · db-source-schema · structured-sources · structured-source-databases · structured-source-schemas · structured-source-objects structured-source-schema · structured-backfill-start-resolve · file-download · file-stream · file-delete · mo-database-list mo-database-table-list · mo-check-table-name · mo-column-mapping · tasks · create-task · update-task update-task-from-spec · delete-task · pause-task · resume-task · get-task · task-files task-runs · retry-task-files · export-tasks · export-task-info · export-task-files · delete-export-task create-export-task · retry-export-task · export-task-state

compute — Compute

list · specs · spec-management-permission · create-spec · update-spec · set-spec-enabled create · worker-images · get · update · adopt-legacy-ownership · preflight-delete delete · suspend · resume · retry · metrics · runtime admin-list · admin-update · admin-runtime · admin-preflight-delete · admin-delete · admin-suspend admin-resume · admin-retry

dashboard — Task overview

task-execution-overview

data-share — Data sharing

publishes · workspace-names-result · resolve-workspace-names · publish-summary · source-tables · check-publish-name create-publish · update-publish · delete-publish · subscriptions · subscribe · unsubscribe

Last updated on Sep 11, 2026