> ## Documentation Index
> Fetch the complete documentation index at: https://docs.remyx.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# CLI Reference

> Complete command reference for the Remyx CLI

# CLI Reference

Quick reference for all `remyxai` commands. For usage examples and guides, see [Using the CLI](/cli).

***

## `remyxai interests`

Manage Research Interests — the context that drives personalized recommendations.

| Command                               | Description                                       |
| ------------------------------------- | ------------------------------------------------- |
| `interests list`                      | List all Research Interests                       |
| `interests get -i <name\|uuid>`       | Get details for one interest                      |
| `interests create`                    | Create a new interest (interactive or with flags) |
| `interests from-repo <repo_url>`      | Create an interest from a GitHub repo profile     |
| `interests from-project <name\|uuid>` | Create an interest from a project's experiments   |
| `interests update -i <name\|uuid>`    | Update an interest's fields                       |
| `interests toggle -i <name\|uuid>`    | Toggle active/inactive status                     |
| `interests delete -i <name\|uuid>`    | Delete an interest                                |

### `interests create`

```
remyxai interests create [OPTIONS]
```

| Flag                         | Type   | Default      | Description                                                 |
| ---------------------------- | ------ | ------------ | ----------------------------------------------------------- |
| `--name, -n`                 | string | *(prompted)* | Short label                                                 |
| `--context, -c`              | string | *(prompted)* | Description or URLs (HuggingFace, GitHub, arXiv, free text) |
| `--daily-count, -d`          | int    | 2            | Recommendations per day (1-10)                              |
| `--inactive`                 | flag   | —            | Create as inactive                                          |
| `--refresh` / `--no-refresh` | flag   | `--refresh`  | Kick a recommendations refresh after creating               |
| `--wait, -w`                 | flag   | —            | Block until the refresh completes                           |
| `--format, -f`               | choice | `text`       | `text` or `json`                                            |

### `interests from-repo`

```
remyxai interests from-repo <repo_url> [OPTIONS]
```

| Argument   | Type   | Description                   |
| ---------- | ------ | ----------------------------- |
| `repo_url` | string | **Required.** GitHub repo URL |

| Flag                         | Type   | Default       | Description                                                                                      |
| ---------------------------- | ------ | ------------- | ------------------------------------------------------------------------------------------------ |
| `--name, -n`                 | string | *(from repo)* | Short label                                                                                      |
| `--daily-count, -d`          | int    | 2             | Recommendations per day (1-10)                                                                   |
| `--inactive`                 | flag   | —             | Create as inactive                                                                               |
| `--automate`                 | choice | `none`        | `none`, `review`, or `auto`. `review`/`auto` provision Outrider on the repo like `outrider init` |
| `--timeout`                  | int    | 300           | Seconds to wait on Outrider provisioning when automating                                         |
| `--refresh` / `--no-refresh` | flag   | `--refresh`   | Kick a recommendations refresh after creating                                                    |
| `--wait, -w`                 | flag   | —             | Block until the refresh completes                                                                |
| `--format, -f`               | choice | `text`        | `text` or `json`                                                                                 |

### `interests from-project`

```
remyxai interests from-project <project> [OPTIONS]
```

| Argument  | Type   | Description                        |
| --------- | ------ | ---------------------------------- |
| `project` | string | **Required.** Project name or UUID |

| Flag                         | Type   | Default          | Description                                         |
| ---------------------------- | ------ | ---------------- | --------------------------------------------------- |
| `--name, -n`                 | string | *(from project)* | Short label                                         |
| `--daily-count, -d`          | int    | 2                | Recommendations per day (1-10)                      |
| `--inactive`                 | flag   | —                | Create as inactive                                  |
| `--include-experiment, -e`   | string | *(all)*          | Limit context to a specific experiment (repeatable) |
| `--no-auto-update`           | flag   | —                | Snapshot the project once instead of tracking it    |
| `--refresh` / `--no-refresh` | flag   | `--refresh`      | Kick a recommendations refresh after creating       |
| `--wait, -w`                 | flag   | —                | Block until the refresh completes                   |
| `--format, -f`               | choice | `text`           | `text` or `json`                                    |

### `interests update`

```
remyxai interests update [OPTIONS]
```

| Flag                | Type   | Description                                   |
| ------------------- | ------ | --------------------------------------------- |
| `--interest, -i`    | string | **Required.** Name or UUID                    |
| `--name, -n`        | string | New name                                      |
| `--context, -c`     | string | New context (invalidates recommendation pool) |
| `--daily-count, -d` | int    | New daily count                               |
| `--activate`        | flag   | Set active                                    |
| `--deactivate`      | flag   | Set inactive                                  |
| `--format, -f`      | choice | `text` or `json`                              |

### `interests delete`

```
remyxai interests delete [OPTIONS]
```

| Flag             | Type   | Description                |
| ---------------- | ------ | -------------------------- |
| `--interest, -i` | string | **Required.** Name or UUID |
| `--yes, -y`      | flag   | Skip confirmation prompt   |
| `--format, -f`   | choice | `text` or `json`           |

***

## `remyxai papers`

Get personalized recommendations from the Remyx resource index.

| Command                           | Description                                     |
| --------------------------------- | ----------------------------------------------- |
| `papers digest`                   | Today's top recommendations grouped by interest |
| `papers list`                     | Flat list of recommendations with filtering     |
| `papers refresh`                  | Trigger async recommendation refresh            |
| `papers refresh-status <task_id>` | Poll a refresh task's status                    |

### `papers digest`

```
remyxai papers digest [OPTIONS]
```

| Flag           | Type   | Default | Description                            |
| -------------- | ------ | ------- | -------------------------------------- |
| `--limit, -n`  | int    | 5       | Max items per interest                 |
| `--period, -p` | choice | `today` | `today`, `week`, or `all`              |
| `--format, -f` | choice | `text`  | `text` or `json`                       |
| `--full`       | flag   | —       | Show full reasoning without truncation |

### `papers list`

```
remyxai papers list [OPTIONS]
```

| Flag                | Type   | Default | Description                                          |
| ------------------- | ------ | ------- | ---------------------------------------------------- |
| `--interest, -i`    | string | *(all)* | Filter by interest name or UUID                      |
| `--limit, -n`       | int    | 20      | Max results (1-50)                                   |
| `--period, -p`      | choice | `all`   | `today`, `week`, or `all`                            |
| `--source-type, -s` | string | *(all)* | Filter by source: `arxiv_paper`, `github_repo`, etc. |
| `--format, -f`      | choice | `text`  | `text` or `json`                                     |
| `--full`            | flag   | —       | Show full reasoning without truncation               |

### `papers refresh`

```
remyxai papers refresh [OPTIONS]
```

| Flag                | Type   | Default          | Description                          |
| ------------------- | ------ | ---------------- | ------------------------------------ |
| `--interest, -i`    | string | *(all active)*   | Refresh one interest by name or UUID |
| `--num-results, -n` | int    | *(daily\_count)* | Items per interest                   |
| `--wait, -w`        | flag   | —                | Block until all tasks complete       |
| `--format, -f`      | choice | `text`           | `text` or `json`                     |

### `papers refresh-status`

```
remyxai papers refresh-status <task_id> [OPTIONS]
```

| Argument  | Type   | Description                                     |
| --------- | ------ | ----------------------------------------------- |
| `task_id` | string | **Required.** UUID from `papers refresh` output |

| Flag           | Type   | Default | Description      |
| -------------- | ------ | ------- | ---------------- |
| `--format, -f` | choice | `text`  | `text` or `json` |

***

## `remyxai search`

Search across the Remyx resource index.

| Command                  | Description                                  |
| ------------------------ | -------------------------------------------- |
| `search query <text>`    | Semantic search across papers, repos, models |
| `search info <arxiv_id>` | Detailed info for a specific resource        |
| `search list`            | Browse recently added resources              |
| `search stats`           | Catalog statistics                           |

### `search query`

```
remyxai search query <query_text> [OPTIONS]
```

| Argument     | Type   | Description                                 |
| ------------ | ------ | ------------------------------------------- |
| `query_text` | string | **Required.** Natural language search query |

| Flag                | Type   | Default | Description                             |
| ------------------- | ------ | ------- | --------------------------------------- |
| `--max-results, -n` | int    | 10      | Maximum results                         |
| `--category, -c`    | string | *(all)* | arXiv category filter (repeatable)      |
| `--docker`          | flag   | —       | Only resources with Docker environments |
| `--no-docker`       | flag   | —       | Only resources without Docker           |

### `search info`

```
remyxai search info <arxiv_id> [OPTIONS]
```

| Argument   | Type   | Description                                 |
| ---------- | ------ | ------------------------------------------- |
| `arxiv_id` | string | **Required.** arXiv ID (e.g., `2308.12345`) |

| Flag           | Type   | Default | Description      |
| -------------- | ------ | ------- | ---------------- |
| `--format, -f` | choice | `text`  | `text` or `json` |

### `search list`

```
remyxai search list [OPTIONS]
```

| Flag             | Type   | Default | Description                  |
| ---------------- | ------ | ------- | ---------------------------- |
| `--limit, -n`    | int    | 20      | Number of results            |
| `--offset, -o`   | int    | 0       | Pagination offset            |
| `--category, -c` | string | *(all)* | Category filter (repeatable) |
| `--docker`       | flag   | —       | Only Docker-ready resources  |
| `--no-docker`    | flag   | —       | Only non-Docker resources    |

### `search stats`

```
remyxai search stats
```

No options. Prints total assets, Docker availability counts, top categories, and citation coverage.

***

## `remyxai outrider`

Install [automated discovery PRs](/platform/discover/outrider) (the Outrider GitHub Action) on a repo.

| Command                        | Description                                                      |
| ------------------------------ | ---------------------------------------------------------------- |
| `outrider init`                | Provision via the Remyx GitHub App (`remyx-ai[bot]`)             |
| `outrider setup-local`         | Provision via your own `gh` CLI, without the GitHub App          |
| `outrider trigger`             | Fire a one-shot `workflow_dispatch` run of an installed workflow |
| `outrider set-provider-secret` | Set a provider's API-key secret on a repo, safely                |

### `outrider init`

```
remyxai outrider init [OPTIONS]
```

| Flag              | Type   | Default              | Description                                                                                                                                        |
| ----------------- | ------ | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--repo`          | string | *(git remote)*       | Target repo `owner/name` or GitHub URL                                                                                                             |
| `--interest, -i`  | string | —                    | Research Interest UUID to wire in                                                                                                                  |
| `--auto-interest` | flag   | —                    | Auto-create the interest from the repo (exclusive with `--interest`)                                                                               |
| `--bulk-repos`    | string | —                    | Path to a TSV of `owner/name<TAB>interest_uuid` rows; loops with per-row error capture. Exclusive with `--repo` / `--interest` / `--auto-interest` |
| `--pace`          | int    | 3                    | Seconds between repos in a `--bulk-repos` run                                                                                                      |
| `--mode`          | choice | `auto`               | `auto`, `review`, or `off`                                                                                                                         |
| `--anthropic-key` | string | `$ANTHROPIC_API_KEY` | Model-provider key (used only if none is connected)                                                                                                |
| `--no-wait`       | flag   | —                    | Don't block on App install / provisioning                                                                                                          |
| `--dry-run`       | flag   | —                    | Print the plan and exit                                                                                                                            |
| `--yes, -y`       | flag   | —                    | Skip the confirmation prompt                                                                                                                       |

### `outrider setup-local`

```
remyxai outrider setup-local [OPTIONS]
```

| Flag              | Type   | Default              | Description                                                                                                                                        |
| ----------------- | ------ | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--repo`          | string | *(git remote)*       | Target repo `owner/name` or GitHub URL                                                                                                             |
| `--interest, -i`  | string | —                    | Research Interest UUID to wire in                                                                                                                  |
| `--auto-interest` | flag   | —                    | Auto-create the interest from the repo                                                                                                             |
| `--bulk-repos`    | string | —                    | Path to a TSV of `owner/name<TAB>interest_uuid` rows; loops with per-row error capture. Exclusive with `--repo` / `--interest` / `--auto-interest` |
| `--pace`          | int    | 3                    | Seconds between repos in a `--bulk-repos` run                                                                                                      |
| `--mode`          | choice | `auto`               | `auto` or `review`                                                                                                                                 |
| `--no-cron`       | flag   | —                    | Render the workflow with the cron schedule commented out, keeping only `workflow_dispatch`                                                         |
| `--anthropic-key` | string | `$ANTHROPIC_API_KEY` | Key set as the `ANTHROPIC_API_KEY` repo secret                                                                                                     |
| `--dry-run`       | flag   | —                    | Print the plan + rendered workflow and exit                                                                                                        |
| `--yes, -y`       | flag   | —                    | Skip the confirmation prompt                                                                                                                       |

Requires an authenticated `gh` CLI and admin on the target repo.

### `outrider trigger`

```
remyxai outrider trigger [OPTIONS]
```

| Flag               | Type   | Default                 | Description                                                                                                           |
| ------------------ | ------ | ----------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `--repo`           | string | *(git remote)*          | Target repo `owner/name` or GitHub URL                                                                                |
| `--interest, -i`   | string | *(configured interest)* | Research Interest to run against                                                                                      |
| `--pin-method`     | string | —                       | A method query, or a literal arXiv ID, to pin for this run; bypasses the selection pass. Exclusive with `--pin-arxiv` |
| `--pin-arxiv`      | string | —                       | An arXiv ID already in the candidate pool to pin. Exclusive with `--pin-method`                                       |
| `--ref`            | string | *(repo default branch)* | Git ref to dispatch the workflow on                                                                                   |
| `--claude-timeout` | int    | *(action default, 900)* | Wall-clock seconds for the Claude Code agent calls on this dispatch                                                   |
| `--provider`       | string | *(workflow default)*    | Model provider for this dispatch (`anthropic`, `zai`); the workflow must declare a `provider` dispatch input          |
| `--model`          | string | *(provider default)*    | Model to request from the provider (e.g. `glm-5.2`), forwarded as `ANTHROPIC_MODEL`                                   |

Refuses if no Outrider workflow is registered on the repo. Requires an authenticated `gh` CLI.

### `outrider set-provider-secret`

```
remyxai outrider set-provider-secret [OPTIONS]
```

| Flag         | Type   | Default        | Description                                                                                                 |
| ------------ | ------ | -------------- | ----------------------------------------------------------------------------------------------------------- |
| `--repo`     | string | *(git remote)* | Target repo `owner/name` or GitHub URL                                                                      |
| `--provider` | string | **required**   | Provider the key is for; selects the secret name (`anthropic` → `ANTHROPIC_API_KEY`, `zai` → `ZAI_API_KEY`) |
| `--key-from` | path   | **required**   | File containing only the API key. Read from file to avoid the `gh secret set --body -` truncation trap      |

***

## Global Options

All commands support `--help` for detailed usage:

```bash theme={null}
remyxai --help
remyxai interests --help
remyxai papers digest --help
```
