内容
# rimo
[English](README.en.md) | [日本語](README.md)
`rimo` 是 [Rimo Voice](https://rimo.app) 平台的命令行接口。你可以通过终端搜索、获取和查询会议笔记。
`rimo` 适用于人类和 AI 代理（如 Claude Code、Codex 等）。所有命令默认输出 JSON，并可以通过 `--help` 查看行为，因此可以直接集成到脚本或代理工作流中。
> **官方发布仓库。** 二进制文件仅从 [Releases](https://github.com/rimo/cli/releases) 获取，并使用发布的 `checksums.txt` 进行验证（参见 [安装](docs/zh/installation.md)）。
## 安装
```bash
curl -fsSL https://rimo.app/cli/install.sh | sh
```
这将安装最新的 `rimo` 二进制文件到 `~/.local/bin`。有关其他选项、升级和卸载，请参见 [安装](docs/zh/installation.md)。
## 快速入门
```bash
rimo auth login # 基于浏览器的安全登录（令牌由 OS 安全保存）
rimo note list # 列出笔记（JSON）
rimo note get <id> # 获取单个笔记
```
```bash
rimo note search "Q3 release plan" # 搜索笔记
rimo note ask "what did we decide on pricing?" # 从笔记中生成 AI 答案
```
## 命令
所有命令默认输出到 stdout JSON。（[原因和例外 →](docs/zh/output-and-errors.md)）
| 命令 | 描述 |
|---------|-------------|
| [`rimo auth login`](docs/zh/commands.md#rimo-auth-login) | 基于浏览器的登录进行身份验证 |
| [`rimo auth logout`](docs/zh/commands.md#rimo-auth-logout) | 使令牌失效并删除保存的帐户 |
| [`rimo auth status`](docs/zh/commands.md#rimo-auth-status) | 显示已认证的帐户 |
| [`rimo auth switch`](docs/zh/commands.md#rimo-auth-switch) | 切换活动帐户 |
| [`rimo note list`](docs/zh/commands.md#rimo-note-list) | 列出笔记（`--attended`、`--team`、`--since`/`--until`、`--updated-since`） |
| [`rimo note get`](docs/zh/commands.md#rimo-note-get) | 通过 ID 获取笔记（元数据、转录、文档） |
| [`rimo note search`](docs/zh/commands.md#rimo-note-search) | 通过语义相似性或关键词搜索笔记 |
| [`rimo note ask`](docs/zh/commands.md#rimo-note-ask) | 提问并获取 AI 集成的答案 |
| [`rimo team list`](docs/zh/commands.md#rimo-team-list) | 列出组织中的团队 |
| [`rimo version`](docs/zh/commands.md#rimo-version) | 显示 CLI 版本 |
| [`rimo upgrade`](docs/zh/commands.md#rimo-upgrade) | 自我升级到最新版本 |
完整参考资料请参见：[命令](docs/zh/commands.md)。
## 全局标志
```
--account <alias> 使用的帐户别名（覆盖设置中的 active_account）
--fields <spec> 包括的字段：""（所有字段）、"compact" 或 "field1,field2"
--excludes <list> 从输出中排除的字段（逗号分隔）
--dry-run 无副作用地模拟命令（仅适用于写入命令）
```
## 文档
- [安装](docs/zh/installation.md) — 安装、升级和卸载
- [身份验证](docs/zh/authentication.md) — 基于浏览器的登录和帐户
- [个人 API 密钥](docs/zh/personal-api-keys.md) — 在 Web 应用程序中创建密钥并通过 `RIMO_API_KEY` 进行身份验证以用于 CI/CD
- [命令](docs/zh/commands.md) — 包含标志和示例的完整参考资料
- [配置](docs/zh/configuration.md) — `config.yaml`、身份验证存储和环境变量
- [输出和错误](docs/zh/output-and-errors.md) — JSON 设计、`--fields`/`--excludes` 和退出代码
- [MCP 服务器](docs/zh/mcp.md) — 将 `rimo` 公开为 Claude Code、Codex、Cursor 等的 MCP 客户端的强类型工具
- [故障排除](docs/zh/troubleshooting.md) — 安装、登录和 PATH 的常见问题
## AI 代理
`rimo` 为 AI 编码代理（如 Claude Code、Codex、Cursor 等）提供了两种集成方式。两种方式可以结合使用。如果您使用 Claude Code，插件是引入技能的最简单方法。
### Claude Code 插件（一步引入技能）
`rimo` 插件附带 [代理技能](skills/rimo-cli/SKILL.md)，可以一步引入到 Claude Code：
/plugin marketplace add rimo/cli
/plugin install rimo@rimo
此仓库本身作为一个市场，因此没有外部仓库依赖。您还需要将 `rimo` 二进制文件放在 `$PATH` 中，并使用 `rimo auth login` 进行身份验证。有了技能，代理可以通过 `rimo` CLI 访问所有功能。如果您想要强类型工具（MCP），请结合使用 MCP 服务器。
### MCP 服务器（强类型工具，用于支持 MCP 的客户端）
启动 `rimo mcp` 将使 CLI 作为 [Model Context Protocol](https://modelcontextprotocol.io) 的强类型工具公开。添加 `rimo` 条目到 Claude Code 的 `.mcp.json` 中：
```json
{
"mcpServers": {
"rimo": { "type": "stdio", "command": "rimo", "args": ["mcp"] }
}
}
```
重启客户端并使用自然语言提问：
- *「总结本周的 Rimo 笔记」*
- *「查找有关 Rimo Q3 发布计划的笔记」*
有关其他 MCP 客户端（如 Claude Code、Codex、Cursor）的完整设置，请参见：[MCP 服务器](docs/zh/mcp.md)。
### 代理技能（适用于可以执行 shell 命令的任意代理）
`rimo` 还附带 [代理技能](skills/rimo-cli/SKILL.md) — 一个自包含的操作手册，任意代理都可以读取并执行 shell 命令以利用它。对于不支持 MCP 的代理或您想要一个可以粘贴到系统提示符的单个工件，请使用它。
```bash
# 按项目（与仓库一起提交）
mkdir -p .claude/skills/rimo-cli
curl -fsSL https://raw.githubusercontent.com/rimo/cli/main/skills/rimo-cli/SKILL.md \
-o .claude/skills/rimo-cli/SKILL.md
# 或按用户（在所有项目中可用）
mkdir -p ~/.claude/skills/rimo-cli
curl -fsSL https://raw.githubusercontent.com/rimo/cli/main/skills/rimo-cli/SKILL.md \
-o ~/.claude/skills/rimo-cli/SKILL.md
```
对于 Codex 或其他代理，请在会话开始时包含安装文件（例如 `cat ~/.claude/skills/rimo-cli/SKILL.md`），或将内容包含在系统提示符中。
## 支持
如果您发现错误或有功能请求，请在此仓库中创建一个问题。
## 安全
有关漏洞报告，请参见 [安全策略](SECURITY.md)。请勿在公共问题中报告安全问题。
## 许可证
本项目不是开源的。使用 Rimo CLI 须遵守 [Rimo 服务条款](https://rimo.app/policies/terms)。请参见 [NOTICE](NOTICE.md)。
