# iKho CLI

> 规划中的能力:在终端里浏览、搜索、读取逐字稿、下载音频与查看智能笔记。本页记录命令形态,当前尚未提供可安装的 CLI。

本 Tab 的一键安装器、命令行工具与录音／逐字稿类工具尚未开放,相关章节描述的是规划中的接口形态,不代表当前可用的功能。正式开放时间、安装方式与包名将通过官网公告与开通邮件告知。

现在已经可用的是:[记忆 MCP](/docs/mcp-cli/mcp/)(填地址加密钥即可接入,见该页第一节),以及[iKho Embedded 的服务端接口](/docs/embedded/overview/)(认证、文件上传、转写)。

## 前置条件

  
- Node.js 20 或更高版本
  
- 一个 iKho 账号(开放后的开通方式以开通邮件为准)

## 安装

当前尚未提供可安装的 CLI,本文档也不提供可执行的安装命令。安装命令、包名与安装源将随开通邮件提供,请以邮件中的说明为准。

请不要凭猜测安装任何名称相近的第三方包。iKho 尚未发布 CLI 的公开包,任何声称是 iKho CLI 的现有安装源都与我们无关。

## 登录

规划中的登录方式:通过浏览器完成授权,令牌保存到本地,后续命令无需重复登录。

  bash
    
  

  
```
ikho login
```

## 命令参考

以下命令与参数是规划中的形态,以正式发布为准。当前尚未提供可安装的 CLI,这些命令还无法执行。

| 命令 | 说明 |
|---|---|
| `ikho login` | 通过浏览器登录,令牌自动保存 |
| `ikho list` | 列出录音,支持关键词与日期筛选 |
| `ikho show <id>` | 显示单条录音的完整元数据 |
| `ikho transcript <id>` | 输出逐字稿,可带说话人与时间戳 |
| `ikho note <id>` | 查看 iKho 智能引擎生成的笔记 |
| `ikho download <id>` | 下载录音音频到本地文件 |

### ikho list

  bash
    
  

  
```
ikho list                                     # 最新一页录音
ikho list --query "销售拜访"                    # 按名称关键词筛选
ikho list --from 2026-04-01 --to 2026-04-30    # 按日期区间筛选
```

### ikho show

  bash
    
  

  
```
ikho show <id>    # 查看单条录音的元数据与可用产物
```

### ikho transcript

  bash
    
  

  
```
ikho transcript <id>              # 逐字稿
ikho transcript <id> --speaker    # 附带说话人标注
ikho transcript <id> --ts         # 附带每段时间戳
```

### ikho note

  bash
    
  

  
```
ikho note <id>            # 查看智能笔记(Markdown)
ikho note <id> -o note.md    # 保存到文件
```

### ikho download

  bash
    
  

  
```
ikho download <id> -o meeting.mp3    # 下载音频到指定文件
```

## 组合用法

加上 `--json` 后,输出可直接交给 `jq` 等工具做管道处理。例如列出本月录音并只保留 id 与名称:

  bash
    
  

  
```
ikho list --from 2026-07-01 --to 2026-07-31 --json | jq '.items[] | {id, name}'
```

## 输出格式

规划中的行为:不带参数时输出适合阅读的表格;加上 `--json` 则输出结构化 JSON,便于脚本与管道组合。错误信息写入 stderr,保持 stdout 干净,方便管道使用。

## 配置文件与环境变量

规划中,CLI 与 MCP 共用本机的 `~/.ikho/` 目录存放配置与登录令牌。其中 `~/.ikho/config.json` 保存少量本地偏好,拟定结构如下:

  ~/.ikho/config.json(拟定结构)
    
  

  
```
{
  "endpoint": "<正式开放时公布的服务地址>",
  "output": "table",
  "locale": "zh-CN"
}
```

| 字段 | 说明 |
|---|---|
| `endpoint` | 远程服务地址。规划中的地址尚未开放,开放后由官网公告与开通邮件给出 |
| `output` | 默认输出格式,`table` 或 `json` |
| `locale` | 命令输出使用的语言 |

### IKHO_TOKEN 环境变量

规划中,在 CI 或脚本环境里可以通过 `IKHO_TOKEN` 环境变量直接提供访问令牌,免去浏览器登录。令牌来源的优先级从高到低为:

  
- `IKHO_TOKEN` 环境变量
  
- `~/.ikho/` 目录中通过 `ikho login` 保存的令牌

设置了 `IKHO_TOKEN` 时,CLI 不再读取本地令牌文件,也不会触发浏览器登录流程:

  bash
    
  

  
```
IKHO_TOKEN=<你的访问令牌> ikho list --json
```

配置文件字段与环境变量同属规划中的形态,最终口径以正式发布的文档为准。