Using the CLI

The Remyx CLI is the command-line companion to Remyx Studio. Manage Research Interests, get personalized recommendations, search across papers, repos, and models, and install automated discovery PRs on a repo — all from your terminal. Source and latest command definitions live in the official repo.

Requirements

Python 3 and pip
A Remyx API key (get one here)

Installation

pip install remyxai

Verify the executable is on your PATH:

remyxai --help

Authentication

Remyx authenticates API calls with a bearer token. Export it before running commands:

export REMYXAI_API_KEY=<your-key-here>

$env:REMYXAI_API_KEY = "<your-key-here>"

The client uses this variable when calling https://engine.remyx.ai/api/v1.0. Do not commit keys; use your shell profile, .env (with a loader), or your CI secret store.

Your CLI auth is always a single personal key (rmxu_) in REMYXAI_API_KEY. When Outrider provisions a repo (outrider init / setup-local, or interests with --automate review/auto), it writes a scoped automation key (rmxa_) into the repo’s secrets as REMYX_API_KEY. Your personal key stays on your machine. See API key scopes for the difference.

Command Overview

Group	What it does
`remyxai interests`	Manage Research Interests — the context that drives personalized recommendations
`remyxai papers`	Get daily recommendations, view digests, and trigger refreshes
`remyxai search`	Search across papers, repos, models, and datasets
`remyxai outrider`	Install the automated discovery PRs GitHub Action on a repo

Run remyxai <group> --help for all options in a group.

Research Interests

Research Interests define what you care about. They drive the recommendation engine — each interest has its own context and daily recommendation cadence.

List Interests

remyxai interests list

Shows all your Research Interests with name, context preview, daily count, and active status.

remyxai interests list

remyxai interests list --format json

Create an Interest

remyxai interests create \
  --name "Retrieval-Augmented Generation" \
  --context "https://huggingface.co/remyxai/SpaceThinker-Qwen2.5VL-3B" \
  --daily-count 3

Flag	Description	Default
`--name, -n`	Short label for the interest	(prompted if omitted)
`--context, -c`	Natural language description, or URLs to HuggingFace models, GitHub repos, arXiv papers	(prompted if omitted)
`--daily-count, -d`	Recommendations per day (1-10)	2
`--inactive`	Create as inactive (excluded from daily digest until toggled)	—
`--refresh` / `--no-refresh`	Kick a recommendations refresh after creating	`--refresh`
`--wait, -w`	Block until the refresh completes	—
`--format, -f`	Output format: `text` or `json`	`text`

Run remyxai interests create with no flags for an interactive prompt that walks you through each field.

Create from a GitHub repo

remyxai interests from-repo https://github.com/your-org/your-project

Builds an interest from a repo’s profile (languages, topics, README, dependencies) instead of free text. Pass --automate review or --automate auto to also provision Outrider on that repo in the same step, the same flow as outrider init.

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

Create from a project’s experiments

remyxai interests from-project "My RAG Project"

Builds an interest from a project’s experiments. The <PROJECT> argument accepts a project name or UUID. The interest tracks the project by default, so new experiments keep it current; pass --no-auto-update to take a one-time snapshot instead.

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

Get Interest Details

remyxai interests get --interest "Retrieval-Augmented Generation"

The --interest flag accepts either a name (case-insensitive) or a UUID.

Update an Interest

remyxai interests update \
  --interest "Retrieval-Augmented Generation" \
  --context "https://github.com/your-org/your-rag-system" \
  --daily-count 5

Flag	Description
`--interest, -i`	Interest name or UUID (required)
`--name, -n`	New name
`--context, -c`	New context (invalidates recommendation pool and triggers re-ranking)
`--daily-count, -d`	New daily count
`--activate`	Set active
`--deactivate`	Set inactive

Updating the context invalidates the pre-ranked recommendation pool. Run remyxai papers refresh afterward to get fresh results immediately.

Toggle Active Status

remyxai interests toggle --interest "Retrieval-Augmented Generation"

Toggles between active and inactive without deleting the interest or its recommendation history.

Delete an Interest

remyxai interests delete --interest "Retrieval-Augmented Generation"

Prompts for confirmation. Pass --yes to skip:

remyxai interests delete --interest "Retrieval-Augmented Generation" --yes

Recommendations

Get personalized resource recommendations based on your Research Interests.

Daily Digest

remyxai papers digest

Shows today’s top recommendations grouped by Research Interest. Each entry includes the resource title, source type, relevance score, and why it was recommended.

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

remyxai papers digest

remyxai papers digest --period week --format json

remyxai papers digest --full --limit 3

List Recommendations

remyxai papers list

Flat list of all recommendations (not grouped by interest). Supports more granular filtering.

Flag	Description	Default
`--interest, -i`	Filter by interest name or UUID	(all interests)
`--limit, -n`	Max results (1-50)	20
`--period, -p`	`today`, `week`, or `all`	`all`
`--source-type, -s`	Filter by source type (`arxiv_paper`, `github_repo`, etc.)	(all types)
`--format, -f`	`text` or `json`	`text`
`--full`	Show full reasoning text	—

# Papers for a specific interest from this week
remyxai papers list --interest "Retrieval-Augmented Generation" --period week

# Only GitHub repos
remyxai papers list --source-type github_repo

Refresh Recommendations

remyxai papers refresh

Triggers an async recommendation refresh. By default, refreshes all active interests. Use --wait to block until complete.

Flag	Description	Default
`--interest, -i`	Refresh a specific interest (name or UUID)	(all active)
`--num-results, -n`	Items per interest	(uses interest’s daily_count)
`--wait, -w`	Block until all tasks complete	—
`--format, -f`	`text` or `json`	`text`

remyxai papers refresh --wait

remyxai papers refresh --interest "Reinforcement Learning" --wait

Check Refresh Status

remyxai papers refresh-status <task_id>

Poll the status of an async refresh task (from papers refresh without --wait).

Search

Search across the Remyx resource index — papers, repos, models, and datasets with Docker availability filtering.

Query

remyxai search query "retrieval augmented generation for code"

Flag	Description	Default
`--max-results, -n`	Maximum results	10
`--category, -c`	Filter by category (can be specified multiple times)	(all)
`--docker`	Only show resources with runnable Docker environments	—
`--no-docker`	Only show resources without Docker	—

# Search for Docker-ready resources only
remyxai search query "vision language models" --docker --max-results 5

# Filter by category
remyxai search query "reinforcement learning" --category cs.LG --category cs.AI

Get Resource Details

remyxai search info 2308.12345

Returns detailed information for a specific resource by arXiv ID, including full abstract, Docker status, Dockerfile contents, and reference summary.

Flag	Description	Default
`--format, -f`	`text` or `json`	`text`

List Recent Resources

remyxai search list

Browse recently added resources with pagination.

Flag	Description	Default
`--limit, -n`	Number of results	20
`--offset, -o`	Pagination offset	0
`--category, -c`	Filter by category (multiple allowed)	(all)
`--docker` / `--no-docker`	Filter by Docker availability	(all)

Catalog Statistics

remyxai search stats

Shows aggregate stats: total assets, Docker availability counts, category breakdown, and citation classification coverage.

Outrider

Install automated discovery PRs on a GitHub repo without leaving the terminal. The CLI drives the same “set it up for me” flow as the web app — your local git is never touched.

Install on a repo

remyxai outrider init --repo owner/name --auto-interest

This drives the Remyx engine so the Remyx GitHub App (remyx-ai[bot]) sets the repo secrets, writes the workflow, opens a bot-authored setup PR, and — in auto mode — merges it and fires the first run. No personal gh token is needed; only your REMYXAI_API_KEY.

Flag	Description	Default
`--repo`	Target repo as `owner/name` or a GitHub URL	(detected from the current directory’s git remote)
`--interest, -i`	Research Interest UUID to wire in	(prompted / see `--auto-interest`)
`--auto-interest`	Auto-create a Research Interest from the repo (mutually exclusive with `--interest`)	—
`--bulk-repos`	Path to a TSV of `owner/name<TAB>interest_uuid` rows; provisions each in turn with per-row error capture. Mutually exclusive with `--repo` / `--interest` / `--auto-interest`	—
`--pace`	Seconds to wait between repos in a `--bulk-repos` run	3
`--mode`	`auto` (provision + merge setup PR + first run), `review` (provision + open setup PR to review), `off` (create the interest only)	`auto`
`--anthropic-key`	Anthropic API key to connect as the model provider (Claude Code). Falls back to `$ANTHROPIC_API_KEY`	(only used if no provider is connected)
`--no-wait`	Don’t block polling for App install / provisioning; print next steps and return	—
`--dry-run`	Print the plan and exit without making changes	—
`--yes, -y`	Skip the confirmation prompt	—

Connect the GitHub and Claude Code (Anthropic API key) integrations in Connectors first; outrider init uses those connections. If the GitHub App isn’t installed on the repo, the command surfaces the install link, and you can pass --anthropic-key to set the Anthropic key the first time.

remyxai outrider init --repo remyxai/RepoRanger --auto-interest

remyxai outrider init --repo owner/name --interest <uuid> --mode review

REMYXAI_API_KEY=... ANTHROPIC_API_KEY=... \
  remyxai outrider init --repo owner/name --interest <uuid> --yes

Install without the GitHub App

For organizations that can’t grant a third-party GitHub App yet (e.g. a pending security review), setup-local does the same provisioning using your own authenticated gh CLI instead of the Remyx App — nothing new to security-review. The running Action opens PRs with the repo’s built-in GITHUB_TOKEN.

remyxai outrider setup-local --repo owner/name --auto-interest

Flag	Description	Default
`--repo`	Target repo as `owner/name` or a GitHub URL	(detected from git remote)
`--interest, -i`	Research Interest UUID to wire in	—
`--auto-interest`	Auto-create a Research Interest from the repo	—
`--bulk-repos`	Path to a TSV of `owner/name<TAB>interest_uuid` rows; provisions each in turn with per-row error capture. Mutually exclusive with `--repo` / `--interest` / `--auto-interest`	—
`--pace`	Seconds to wait between repos in a `--bulk-repos` run	3
`--mode`	`auto` (open + merge setup PR + dispatch first run) or `review` (open the setup PR for you to merge)	`auto`
`--no-cron`	Render the workflow with the cron schedule commented out, keeping only `workflow_dispatch` (manual / `outrider trigger` runs)	—
`--anthropic-key`	Anthropic key to set as the `ANTHROPIC_API_KEY` repo secret. Falls back to `$ANTHROPIC_API_KEY`, then prompts	—
`--dry-run`	Print the plan + rendered workflow and exit	—
`--yes, -y`	Skip the confirmation prompt	—

setup-local needs an authenticated gh (run gh auth login, or set $GITHUB_TOKEN with repo + workflow scopes) and admin on the target repo. The only runtime Remyx dependency is the REMYX_API_KEY the workflow uses.

Trigger a one-shot run

Once Outrider is installed on a repo, trigger fires a single workflow_dispatch run of the workflow through your local gh. Useful for testing or kicking a run between cron cycles without waiting for the schedule.

remyxai outrider trigger --repo owner/name

Flag	Description	Default
`--repo`	Target repo as `owner/name` or a GitHub URL	(detected from git remote)
`--interest, -i`	Research Interest to run against	(the repo’s configured interest)
`--pin-method`	A method query, or a literal arXiv ID, to pin for this run; bypasses the candidate-selection pass. Mutually exclusive with `--pin-arxiv`	—
`--pin-arxiv`	An arXiv ID already in the candidate pool to pin for this run. Mutually exclusive with `--pin-method`	—
`--ref`	Git ref to dispatch the workflow on	(repo default branch)
`--claude-timeout`	Wall-clock seconds for the Claude Code agent calls on this dispatch (preflight and implementation share the budget). Raise for very large monorepos	(action default, 900s)
`--provider`	Route Claude Code at a specific model provider for this dispatch (`anthropic`, `zai`). The target workflow must declare a `provider` dispatch input, which `setup-local` workflows do	(workflow default)
`--model`	Specific model to request from the provider (e.g. `claude-opus-4-7`, `glm-5.2`, `glm-4.6`), forwarded as `ANTHROPIC_MODEL`	(provider’s default)

trigger needs an authenticated gh (run gh auth login). It refuses up front if no Outrider workflow is registered on the repo; install one first with outrider init or setup-local.

Route a run at a different model provider

Outrider runs Claude Code, and it can route those calls at any Anthropic-Messages-compatible provider. A setup-local workflow declares provider and model as dispatch inputs and picks the right auth environment variable per run, so one workflow can A/B Anthropic against an alternate such as z.ai’s GLM:

# one run on z.ai's GLM-5.2; Anthropic stays the workflow default
remyxai outrider trigger --repo owner/name \
  --pin-method "speculative decoding" --provider zai --model glm-5.2

--provider names the API endpoint; --model picks the model from it. Omit either to fall back to the workflow’s (or the provider’s) default. See model backends for the auth-header details.

Set a provider’s API key on a repo

set-provider-secret writes a provider’s API key into the repo’s secrets safely. It reads the key from a file, strips the trailing newline, and sidesteps the gh secret set --body - truncation trap that otherwise stores a literal - and breaks every run with a 401.

remyxai outrider set-provider-secret \
  --repo owner/name --provider zai --key-from ~/zai-key

Flag	Description	Default
`--repo`	Target repo as `owner/name` or a GitHub URL	(detected from git remote)
`--provider`	Which provider the key is for; selects the secret name (`anthropic` → `ANTHROPIC_API_KEY`, `zai` → `ZAI_API_KEY`). Required	—
`--key-from`	Path to a file containing only the API key. Required	—

See Automated discovery PRs for what the action does once installed, its configuration inputs, and how to review the PRs it opens.

Quick Reference

Intent	Command
Get today’s digest	`remyxai papers digest`
Get this week’s digest	`remyxai papers digest --period week`
Recommendations for one interest	`remyxai papers list --interest "RAG" --period today`
Refresh all interests	`remyxai papers refresh --wait`
Refresh one interest	`remyxai papers refresh --interest "RAG" --wait`
List interests	`remyxai interests list`
Create an interest	`remyxai interests create --name "RAG" --context "..." --daily-count 3`
Create an interest from a repo	`remyxai interests from-repo https://github.com/your-org/your-project`
Create an interest from a project	`remyxai interests from-project "My RAG Project"`
Toggle an interest	`remyxai interests toggle --interest "RAG"`
Delete an interest	`remyxai interests delete --interest "RAG" --yes`
Search for resources	`remyxai search query "your query" --max-results 10`
Search Docker-ready only	`remyxai search query "your query" --docker`
Get resource details	`remyxai search info 2308.12345`
Browse recent resources	`remyxai search list --limit 20`
Catalog stats	`remyxai search stats`
Install automated discovery PRs	`remyxai outrider init --repo owner/name --auto-interest`
Install without the GitHub App	`remyxai outrider setup-local --repo owner/name --auto-interest`
Fire a one-shot Outrider run	`remyxai outrider trigger --repo owner/name`
Run a method via z.ai GLM	`remyxai outrider trigger --repo owner/name --pin-method "..." --provider zai --model glm-5.2`
Set a provider’s API key on a repo	`remyxai outrider set-provider-secret --repo owner/name --provider zai --key-from ~/zai-key`

Troubleshooting

REMYXAI_API_KEY missing or invalid

Export the key in the same shell session you use for remyxai. Verify with:

echo $REMYXAI_API_KEY

If empty, set it:

export REMYXAI_API_KEY=<your-key-here>

Command not found: remyxai

The binary may not be on your PATH. Check where pip installed it:

pip show remyxai | grep Location

On Linux, pip install without sudo puts the binary in ~/.local/bin. Either add that to your PATH or install with sudo pip install remyxai.

Digest shows 'no new recommendations today'

Run remyxai papers refresh --wait to trigger a fresh ranking. If recommendations show for --period week but not today, they were generated on a previous day. Refreshing will surface the latest resources.

Next Steps

Set up automated discovery PRs on a repo with remyxai outrider init
Browse commands and source in the Remyx CLI repo
Connect the MCP server for AI-powered experiment management

Introduction

Discover

Experiments

Manage

Admin

Concepts

Roadmap

Requirements

Installation

Authentication

Command Overview

Research Interests

List Interests

Create an Interest

Create from a GitHub repo

Create from a project’s experiments

Get Interest Details

Update an Interest

Toggle Active Status

Delete an Interest

Recommendations

Daily Digest

List Recommendations

Refresh Recommendations

Check Refresh Status

Search

Query

Get Resource Details

List Recent Resources

Catalog Statistics

Outrider

Install on a repo

Install without the GitHub App

Trigger a one-shot run

Route a run at a different model provider

Set a provider’s API key on a repo

Quick Reference

Troubleshooting

Next Steps

​Requirements

​Installation

​Authentication

​Command Overview

​Research Interests

​List Interests

​Create an Interest

​Create from a GitHub repo

​Create from a project’s experiments

​Get Interest Details

​Update an Interest

​Toggle Active Status

​Delete an Interest

​Recommendations

​Daily Digest

​List Recommendations

​Refresh Recommendations

​Check Refresh Status

​Search

​Query

​Get Resource Details

​List Recent Resources

​Catalog Statistics

​Outrider

​Install on a repo

​Install without the GitHub App

​Trigger a one-shot run

​Route a run at a different model provider

​Set a provider’s API key on a repo

​Quick Reference

​Troubleshooting

​Next Steps

Requirements

Installation

Authentication

Command Overview

Research Interests

List Interests

Create an Interest

Create from a GitHub repo

Create from a project’s experiments

Get Interest Details

Update an Interest

Toggle Active Status

Delete an Interest

Recommendations

Daily Digest

List Recommendations

Refresh Recommendations

Check Refresh Status

Search

Query

Get Resource Details

List Recent Resources

Catalog Statistics

Outrider

Install on a repo

Install without the GitHub App

Trigger a one-shot run

Route a run at a different model provider

Set a provider’s API key on a repo

Quick Reference

Troubleshooting

Next Steps