# 命令概览

`moi-cli` 的顶层命令与产品 SDK 的服务面大致对应。本页列出常用入口；子命令、必填参数与输出字段以当前二进制的帮助为准：

```bash
moi-cli --help
moi-cli <command> --help
moi-cli <command> <subcommand> --help
```

复杂参数通常支持 `--json` 或 `--json-file`；流式或文件类结果可使用 `--output`。需要程序化集成时，优先对照同名能力的 [SDK](https://docs.matrixorigin.cn/moi/zh/5.0/developer/sdk/index.html.md) 或 [Product API](https://docs.matrixorigin.cn/moi/zh/5.0/developer/api/product-api/index.html.md) 文档。

## 配置

| 命令 | 用途 |
| --- | --- |
| `config` | 管理 endpoint、PAT、当前工作区与按工作区的 Role |

详见 [配置与认证](https://docs.matrixorigin.cn/moi/zh/5.0/developer/cli/config-auth.html.md)。

## 账号、工作区与权限

| 命令 | 用途 | 相关文档 |
| --- | --- | --- |
| `workspace` | 创建、确保、查询、列表、认领、删除工作区等 | [账号与权限 · SDK](https://docs.matrixorigin.cn/moi/zh/5.0/developer/sdk/account-workspace/index.html.md) |
| `workspace-member` | 成员、邀请、角色、用户标签与审计 | 同上 |
| `account` | 账号侧能力（如数据库连接信息） | 同上 |
| `iam` | 角色、权限视图与对象授权 | 同上 |

## 数据与连接器

| 命令 | 用途 | 相关文档 |
| --- | --- | --- |
| `catalog` | Catalog、数据库、表、Volume 与文件等 | [数据与连接器 · SDK](https://docs.matrixorigin.cn/moi/zh/5.0/developer/sdk/data/index.html.md) |
| `connector` | 连接器、结构化源、任务与文件 | 同上 |
| `data-share` | 发布与订阅 | 同上 |
| `semantic-model` | 知识 / 语义模型、来源、片段与条目 | [知识库 · SDK](https://docs.matrixorigin.cn/moi/zh/5.0/developer/sdk/knowledge-explore/index.html.md) |

## 工作流与智能体

| 命令 | 用途 | 相关文档 |
| --- | --- | --- |
| `workflow` | 部署、运行、暂停/恢复、重跑与运行详情 | [工作流 · SDK](https://docs.matrixorigin.cn/moi/zh/5.0/developer/sdk/workflows/index.html.md) |
| `agent` | 发送消息、查询/取消任务、读取 Card | [智能体 · SDK](https://docs.matrixorigin.cn/moi/zh/5.0/developer/sdk/agents/index.html.md) |

## SQL、模型与计算

| 命令 | 用途 | 相关文档 |
| --- | --- | --- |
| `sql` | 查询、历史、元数据与工作簿 | [SQL · SDK](https://docs.matrixorigin.cn/moi/zh/5.0/developer/sdk/sql/index.html.md) |
| `model` | 模型列表与探测等 | [模型 · SDK](https://docs.matrixorigin.cn/moi/zh/5.0/developer/sdk/models/index.html.md) |
| `provider-backend` | Provider Backend、Endpoint 与路由（`--kind llm\|embedding\|parser`） | 同上 |
| `compute` | 计算资源规格、生命周期、指标与管理操作 | [计算与告警 · SDK](https://docs.matrixorigin.cn/moi/zh/5.0/developer/sdk/compute-alerting/index.html.md) |
| `dashboard` | 任务执行概览等仪表盘只读能力 | 以 `--help` 与部署说明为准 |

## 使用约定

- 需要工作区上下文的命令：传入 `-workspace-id`，或先 `config set-workspace`。
- 写、删、发布类操作前，确认 PAT 身份、目标工作区与 Role 具备相应权限。
- 非交互环境（脚本、CI）建议加 `-no-interactive`，需要稳定解析时加 `-o`。
- 控制台可见但上表未列出的能力，可能仅提供 HTTP 或 SDK；不要假定 CLI 一定覆盖。