# CLI

`moi-cli` 是 MatrixOne Intelligence 的**产品级**命令行工具。它通过产品 API 端点调用与控制台同一套产品能力，使用个人访问令牌（PAT）认证，并遵循产品 RBAC。

需要发送 HTTP 请求时使用 [API](https://docs.matrixorigin.cn/moi/zh/5.0/developer/api/index.html.md)；需要在应用中封装调用时使用 [SDK](https://docs.matrixorigin.cn/moi/zh/5.0/developer/sdk/index.html.md)。控制台中可见的功能不等于 `moi-cli` 已提供对应子命令。

## 什么时候用 CLI

| 要完成的工作 | 建议入口 |
| --- | --- |
| 在终端完成配置、列表或一次性运维操作 | 本页开始，接着 [快速开始](https://docs.matrixorigin.cn/moi/zh/5.0/developer/cli/quickstart.html.md) |
| 在脚本或 CI 中复用与控制台一致的产品操作 | [安装](https://docs.matrixorigin.cn/moi/zh/5.0/developer/cli/install.html.md) 后按 [命令概览](https://docs.matrixorigin.cn/moi/zh/5.0/developer/cli/commands.html.md) 选型 |
| 在应用代码中管理产品对象 | [SDK](https://docs.matrixorigin.cn/moi/zh/5.0/developer/sdk/index.html.md) |
| 直接调用资源 HTTP 接口或 Genesis 模型 | [API](https://docs.matrixorigin.cn/moi/zh/5.0/developer/api/index.html.md) |

## 阅读顺序

1. [安装](https://docs.matrixorigin.cn/moi/zh/5.0/developer/cli/install.html.md)：取得可执行的 `moi-cli`。
2. [配置与认证](https://docs.matrixorigin.cn/moi/zh/5.0/developer/cli/config-auth.html.md)：写入产品端点、PAT、工作区，并按需配置 Role。
3. [快速开始](https://docs.matrixorigin.cn/moi/zh/5.0/developer/cli/quickstart.html.md)：完成一次只读调用，确认连通。
4. [命令概览](https://docs.matrixorigin.cn/moi/zh/5.0/developer/cli/commands.html.md)：按产品域选择命令；细节以 `moi-cli <command> --help` 为准。

领取 PAT 见 [访问凭据](https://docs.matrixorigin.cn/moi/zh/5.0/guides/billing/credentials.html.md)。产品端点需包含当前环境的产品 API 前缀（例如 `/newmoi`），写法见 [Product API 通用约定](https://docs.matrixorigin.cn/moi/zh/5.0/developer/api/product-api/conventions.html.md)。

## 边界

- `moi-cli` 面向产品 API 与产品 RBAC，不替代控制台中的全部界面能力。
- 凭据使用账号层的个人访问令牌；不要使用 Genesis 模型密钥、浏览器 Cookie 或其他产品的密钥。
- PAT 只标识调用者本人，不固化工作区或 Role。工作区由 `-workspace-id` 或配置指定；Role 仅通过持久化配置按工作区选择。
- 具体资源是否允许当前身份操作，仍由服务端授权决定；CLI 配置合法不等于业务操作一定成功。