Skip to content

Commit 0c95468

Browse files
committed
docs: extract command reference into docs/commands.md
1 parent a68da53 commit 0c95468

2 files changed

Lines changed: 53 additions & 23 deletions

File tree

README.md

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -39,29 +39,7 @@ remyxai outrider trigger --repo your-org/your-repo --pin-arxiv 2402.02347v3
3939
| Method-targeted runs + team-scale patterns | [docs/method-targeted-runs.md](docs/method-targeted-runs.md) |
4040
| Research Interests: three ways to create one | [docs/research-interests.md](docs/research-interests.md) |
4141
| Install paths, credentials, bulk-install | [docs/install-paths.md](docs/install-paths.md) |
42-
43-
## Command reference
44-
45-
Run any command with `--help` for full flag listings and examples.
46-
47-
| Command | What it does |
48-
|---|---|
49-
| `remyxai outrider init` | Install Outrider on a repo via the Remyx App |
50-
| `remyxai outrider setup-local` | Install Outrider via your own `gh` (no Remyx App) |
51-
| `remyxai outrider trigger` | Dispatch a one-shot run (`--search-method` / `--pin-arxiv` / `--provider` / `--model` / `--claude-timeout`) |
52-
| `remyxai outrider set-provider-secret` | Set a per-provider API-key secret on a repo, safely |
53-
| `remyxai papers digest` | Recommendations grouped by Research Interest |
54-
| `remyxai papers list` | Recommendations flat view (filter by interest, period, source type) |
55-
| `remyxai papers refresh [--wait]` | Trigger a fresh ranking |
56-
| `remyxai interests list` | List your Research Interests |
57-
| `remyxai interests get <name-or-uuid>` | Show one interest |
58-
| `remyxai interests create` | Create an interest from free-form context |
59-
| `remyxai interests from-repo <github-url>` | Create an interest from a GitHub repo profile |
60-
| `remyxai interests from-project <name-or-uuid>` | Create an interest from a project's experiments |
61-
| `remyxai interests update <id>` | Edit name / context / daily count / active state |
62-
| `remyxai interests toggle <id>` | Flip active/inactive |
63-
| `remyxai search query <text>` | Search the engine's research-asset catalog |
64-
| `remyxai search info <arxiv-id>` | Asset details |
42+
| Full command reference | [docs/commands.md](docs/commands.md) |
6543

6644
## Development
6745

docs/commands.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
---
2+
type: reference
3+
description: Full command reference for the Remyx AI CLI.
4+
tags: [cli, reference, commands]
5+
---
6+
7+
# Command reference
8+
9+
Run any command with `--help` for full flag listings and examples — that's the authoritative source.
10+
11+
## Outrider
12+
13+
| Command | What it does |
14+
|---|---|
15+
| `remyxai outrider init` | Install Outrider on a repo via the Remyx App |
16+
| `remyxai outrider setup-local` | Install Outrider via your own `gh` (no Remyx App) |
17+
| `remyxai outrider trigger` | Dispatch a one-shot run (`--search-method` / `--pin-arxiv` / `--provider` / `--model` / `--claude-timeout`) |
18+
| `remyxai outrider set-provider-secret` | Set a per-provider API-key secret on a repo, safely |
19+
20+
See also: [method-targeted-runs.md](method-targeted-runs.md) for `outrider trigger` in depth, [install-paths.md](install-paths.md) for `init` vs `setup-local` and bulk-install.
21+
22+
## Papers
23+
24+
| Command | What it does |
25+
|---|---|
26+
| `remyxai papers digest` | Recommendations grouped by Research Interest |
27+
| `remyxai papers list` | Recommendations flat view (filter by interest, period, source type) |
28+
| `remyxai papers refresh [--wait]` | Trigger a fresh ranking |
29+
| `remyxai papers refresh-status <task_id>` | Poll a refresh task |
30+
31+
## Interests
32+
33+
| Command | What it does |
34+
|---|---|
35+
| `remyxai interests list` | List your Research Interests |
36+
| `remyxai interests get <name-or-uuid>` | Show one interest |
37+
| `remyxai interests create` | Create an interest from free-form context |
38+
| `remyxai interests from-repo <github-url>` | Create an interest from a GitHub repo profile |
39+
| `remyxai interests from-project <name-or-uuid>` | Create an interest from a project's experiments |
40+
| `remyxai interests update <id>` | Edit name / context / daily count / active state |
41+
| `remyxai interests toggle <id>` | Flip active/inactive |
42+
| `remyxai interests delete <id>` | Remove an interest |
43+
44+
See also: [research-interests.md](research-interests.md) for the three interest-creation flavors in depth.
45+
46+
## Search
47+
48+
| Command | What it does |
49+
|---|---|
50+
| `remyxai search query <text>` | Search the engine's research-asset catalog |
51+
| `remyxai search list` | List recently added research assets (papers + Docker images) |
52+
| `remyxai search info <arxiv-id>` | Asset details |

0 commit comments

Comments
 (0)