Skip to main content
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

​
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>
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.

​
Command Overview

GroupWhat it does
remyxai interestsManage Research Interests — the context that drives personalized recommendations
remyxai papersGet daily recommendations, view digests, and trigger refreshes
remyxai searchSearch across papers, repos, models, and datasets
remyxai outriderInstall 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

​
Create an Interest

remyxai interests create \
  --name "Retrieval-Augmented Generation" \
  --context "https://huggingface.co/remyxai/SpaceThinker-Qwen2.5VL-3B" \
  --daily-count 3
FlagDescriptionDefault
--name, -nShort label for the interest(prompted if omitted)
--context, -cNatural language description, or URLs to HuggingFace models, GitHub repos, arXiv papers(prompted if omitted)
--daily-count, -dRecommendations per day (1-10)2
--inactiveCreate as inactive (excluded from daily digest until toggled)—
--format, -fOutput format: text or jsontext
Run remyxai interests create with no flags for an interactive prompt that walks you through each field.

​
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
FlagDescription
--interest, -iInterest name or UUID (required)
--name, -nNew name
--context, -cNew context (invalidates recommendation pool and triggers re-ranking)
--daily-count, -dNew daily count
--activateSet active
--deactivateSet 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.
FlagDescriptionDefault
--limit, -nMax items per interest5
--period, -ptoday, week, or alltoday
--format, -ftext or jsontext
--fullShow full reasoning text without truncation—
remyxai papers digest

​
List Recommendations

remyxai papers list
Flat list of all recommendations (not grouped by interest). Supports more granular filtering.
FlagDescriptionDefault
--interest, -iFilter by interest name or UUID(all interests)
--limit, -nMax results (1-50)20
--period, -ptoday, week, or allall
--source-type, -sFilter by source type (arxiv_paper, github_repo, etc.)(all types)
--format, -ftext or jsontext
--fullShow 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.
FlagDescriptionDefault
--interest, -iRefresh a specific interest (name or UUID)(all active)
--num-results, -nItems per interest(uses interest’s daily_count)
--wait, -wBlock until all tasks complete—
--format, -ftext or jsontext
remyxai papers refresh --wait

​
Check Refresh Status

remyxai papers refresh-status <task_id>
Poll the status of an async refresh task (from papers refresh without --wait).
Search across the Remyx resource index — papers, repos, models, and datasets with Docker availability filtering.

​
Query

remyxai search query "retrieval augmented generation for code"
FlagDescriptionDefault
--max-results, -nMaximum results10
--category, -cFilter by category (can be specified multiple times)(all)
--dockerOnly show resources with runnable Docker environments—
--no-dockerOnly 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.
FlagDescriptionDefault
--format, -ftext or jsontext

​
List Recent Resources

remyxai search list
Browse recently added resources with pagination.
FlagDescriptionDefault
--limit, -nNumber of results20
--offset, -oPagination offset0
--category, -cFilter by category (multiple allowed)(all)
--docker / --no-dockerFilter 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.
FlagDescriptionDefault
--repoTarget repo as owner/name or a GitHub URL(detected from the current directory’s git remote)
--interest, -iResearch Interest UUID to wire in(prompted / see --auto-interest)
--auto-interestAuto-create a Research Interest from the repo (mutually exclusive with --interest)—
--modeauto (provision + merge setup PR + first run), review (provision + open setup PR to review), off (create the interest only)auto
--anthropic-keyAnthropic API key to connect as the model provider (Claude Code). Falls back to $ANTHROPIC_API_KEY(only used if no provider is connected)
--no-waitDon’t block polling for App install / provisioning; print next steps and return—
--dry-runPrint the plan and exit without making changes—
--yes, -ySkip 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

​
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
FlagDescriptionDefault
--repoTarget repo as owner/name or a GitHub URL(detected from git remote)
--interest, -iResearch Interest UUID to wire in—
--auto-interestAuto-create a Research Interest from the repo—
--modeauto (open + merge setup PR + dispatch first run) or review (open the setup PR for you to merge)auto
--anthropic-keyAnthropic key to set as the ANTHROPIC_API_KEY repo secret. Falls back to $ANTHROPIC_API_KEY, then prompts—
--dry-runPrint the plan + rendered workflow and exit—
--yes, -ySkip 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.
See Automated discovery PRs for what the action does once installed, its configuration inputs, and how to review the PRs it opens.

​
Quick Reference

IntentCommand
Get today’s digestremyxai papers digest
Get this week’s digestremyxai papers digest --period week
Recommendations for one interestremyxai papers list --interest "RAG" --period today
Refresh all interestsremyxai papers refresh --wait
Refresh one interestremyxai papers refresh --interest "RAG" --wait
List interestsremyxai interests list
Create an interestremyxai interests create --name "RAG" --context "..." --daily-count 3
Toggle an interestremyxai interests toggle --interest "RAG"
Delete an interestremyxai interests delete --interest "RAG" --yes
Search for resourcesremyxai search query "your query" --max-results 10
Search Docker-ready onlyremyxai search query "your query" --docker
Get resource detailsremyxai search info 2308.12345
Browse recent resourcesremyxai search list --limit 20
Catalog statsremyxai search stats
Install automated discovery PRsremyxai outrider init --repo owner/name --auto-interest
Install without the GitHub Appremyxai outrider setup-local --repo owner/name --auto-interest

​
Troubleshooting

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>
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.
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