命令参考

使用 moi-cli <command> --help 查看当前命令组支持的子命令。本页说明顶层命令和全局选项;具体任务页只引用完成任务所需的命令。

全局选项

选项

作用

-endpoint <url>

指定产品 API 服务地址。

-api-key <token>

指定个人访问令牌。

-workspace-id <id>

指定当前命令使用的工作区。

-verbose

输出详细信息。

-o

以 JSON 输出结果。

-no-interactive

禁用交互式提示。

-version

输出 CLI 版本。

-help

输出帮助。

配置与工作区

命令

用途

config

保存或查看服务地址、个人访问令牌、工作区和角色配置。

workspace

管理和查询工作区。

workspace-member

管理工作区成员。

iam

查询或管理与身份和权限相关的资源。

account

获取当前工作区的数据库连接信息。

数据与任务

命令

用途

catalog

操作目录、数据库、表、卷和文件。

connector

管理连接器以及导入和导出任务。

semantic-model

管理语义模型和数据来源。

workflow

部署、运行、查询、取消或重新运行工作流。

sql

操作 SQL、工作簿和 SQL 历史。

compute

管理计算实例和查看指标。

data-share

管理数据发布和数据订阅。

智能体与模型供给

命令

用途

agent

调用智能体并查询任务。

model

列出模型,探测模型服务,或设置 LLM Backend。

provider-backend

管理 Provider Backend、Endpoint 和 Router。

其他命令

命令

用途

dashboard

查看任务执行概览。

不确定命令组支持哪些子命令时,运行以下命令。将 <command> 替换为实际命令组,例如 workflow

moi-cli <command> --help

查看某个子命令的选项时,先配置服务地址和个人访问令牌,再使用 -help。当前 CLI 的 --help 只展示命令组的子命令列表:

moi-cli <command> <subcommand> -help

完整子命令索引

以下索引列出当前 CLI 每个命令组公开的子命令。它用于定位能力;参数、必填输入和复杂 JSON 结构仍以 moi-cli <命令组> <子命令> -help 为准。

config — 配置

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

workspace — 工作区

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

workspace-member — 工作区成员

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 — 目录

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 — 工作流

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 — 智能体

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 — 账号

db-connection

semantic-model — 语义模型

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 — 权限

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 — 模型

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

provider-backend — 模型服务与路由

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

connector — 连接器

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 — 计算实例

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-execution-overview

data-share — 数据分享

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

最后更新于