# CLI

在终端或脚本中搜索、读取网页和做研究。

## 安装

通过 npm 安装（需要 Node.js 22 及以上），或用安装脚本下载无需 Node.js 的独立可执行文件。

### Shell

```bash
npm install -g @arex-research/cli
```

### Shell

```bash
curl -fsSL https://github.com/AREX-Research/arex-cli/releases/latest/download/install.sh | sh
```

## 保存 API 密钥

arex setup 会询问并校验密钥，保存到 ~/.config/arex/config.json。arex doctor 检查配置。设置了 AREX_API_KEY 时，优先使用它。

### Shell

```bash
arex setup
arex doctor
```

## 命令

research 默认等待答案，加 --detach 则立即返回；之后用 arex run 查询、等待、取消或删除该 Run。每个命令都支持 --help。

### Shell

```bash
arex search "recent advances in AI agents" --limit 5
arex contents https://example.com/article --max-chars 4000
arex research "Compare current agent evaluation frameworks" --mode fast
arex research "What changed?" --detach
arex run wait <run-id>
```

## 在脚本中使用

加 --json 后，成功时只输出一个 JSON 值；出错时写入 stderr 并以非零状态退出。等待超时后 Run 仍在进行，用 arex run wait 继续等待。

### Shell

```bash
arex search "agent evaluation benchmarks" --json | jq -r '.results[].url'
```

[npm · @arex-research/cli](https://www.npmjs.com/package/@arex-research/cli)

[GitHub](https://github.com/AREX-Research/arex-cli)

[Changelog](https://github.com/AREX-Research/arex-cli/blob/main/CHANGELOG.md)

[GitHub Releases](https://github.com/AREX-Research/arex-cli/releases)