# CLI

Search, read pages and research from a terminal or script.

## Install

Install from npm (Node.js 22 or later), or use the install script for a standalone executable that needs no 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
```

## Save your API key

arex setup asks for your key, checks it and saves it to ~/.config/arex/config.json. arex doctor checks the setup. A set AREX_API_KEY takes precedence over the saved key.

### Shell

```bash
arex setup
arex doctor
```

## Commands

research waits for the answer unless you pass --detach; arex run then gets, waits for, cancels or deletes the Run. Every command has --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>
```

## In scripts

With --json, a successful command prints one JSON value; errors go to stderr with a nonzero exit code. If waiting times out, the Run keeps going: resume with 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)