Skip to main content

No project description provided

Project description

Remyx AI command-line client

CLI for the Remyx AI platform. Install Outrider on a repo, manage Research Interests, browse recommended papers, and search for research assets — all from the terminal.

Install

pip install remyxai

Authenticate

Get an API key from engine.remyx.ai/account and export it:

export REMYXAI_API_KEY=<your-key>

All commands read this environment variable.

Quickstart

See today's paper recommendations

remyxai papers digest

Shows recommended papers grouped by Research Interest. Use remyxai papers list --interest <name-or-uuid> for the flat view.

Create a Research Interest

# Free-form context
remyxai interests create \
  --name "LLM Efficiency" \
  --context "Quantization, speculative decoding, KV cache compression"

# From a GitHub repo, or from one of your projects
remyxai interests from-repo https://github.com/your-org/your-repo
remyxai interests from-project "Spatial VQA"

The pipeline matches new arXiv papers to your interests daily. See Research Interests for all three ways to create one.

Install Outrider on a repo

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

Sets up Outrider on the target repo, server-side — your local git is never touched. See Outrider for what it configures and the credentials it needs.

Research Interests

A Research Interest is a named description of what to track; the recommendation pipeline matches new arXiv papers (and other sources) to it. Every create command kicks off a first recommendation pass automatically so the interest is populated right away — add --wait to block until the picks are ready, or --no-refresh to skip.

From free-form context

remyxai interests create \
  --name "LLM Efficiency" \
  --context "Quantization, speculative decoding, KV cache compression"

--context also accepts a HuggingFace or GitHub URL, which the server expands into context.

From a GitHub repo

remyxai interests from-repo <github-url> analyzes the repo, generates a profile of the project (themes, architecture, history), and uses it as the interest's context:

remyxai interests from-repo https://github.com/your-org/your-repo \
  --name "My Project" --daily-count 3 --automate review --wait
  • --automate {none|review|auto} — paper-PR automation on the repo: none (default; just create the interest), review (open a setup PR to review), or auto (set it up automatically). For the full repo setup, see Outrider.

From a project

remyxai interests from-project <name-or-uuid> builds the interest's context from a project's experiments:

# Track all experiments on the project
remyxai interests from-project "Spatial VQA" --wait

# Or curate a subset, and pin the context
remyxai interests from-project <uuid> -e "baseline-run" -e "dpo-v2" --no-auto-update
  • -e/--include-experiment — track a specific experiment (repeatable); omit to track all.
  • --no-auto-update — pin the context instead of refreshing as new experiments land.

Outrider

Outrider is a GitHub Action that opens pull requests integrating relevant new papers into a repo. remyxai outrider init sets it up for you, server-side — your local git is never touched.

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

This uses the Remyx GitHub App (remyx-ai[bot]) to:

  • Create a Research Interest from the repo (--auto-interest), or use an existing one (--interest <uuid>)
  • Write the Outrider workflow to the target repo and set its required Actions secrets
  • Open a bot-authored setup PR — and, in auto mode, merge it and fire the first run

Modes

Set with --mode (default auto):

  • auto — provision, merge the setup PR, and start the first run
  • review — provision and open the setup PR for you to review and merge

Trigger a one-shot run

Once Outrider is installed, remyxai outrider trigger dispatches an ad-hoc run targeting a specific paper or method — see docs/method-targeted-runs.md for the discover → trigger workflow.

Credentials

You set up two things, once:

  1. Your REMYXAI_API_KEY, exported in your shell (see Authenticate) — this authorizes the CLI.
  2. A model provider connected on the Integrations page — Claude Code today, more providers coming soon. The Action needs this to call the model.

Remyx handles the rest. You never create repo secrets by hand. During provisioning the Remyx GitHub App sets two Actions secrets on the target repo for you:

Repo secret What it is
REMYX_API_KEY A scoped automation key Remyx mints just for this repo — not your personal REMYXAI_API_KEY, and revocable on its own.
ANTHROPIC_API_KEY (or your provider's key) Copied from the provider you connected on the Integrations page, so the Action can call the model at runtime.

No provider connected yet? As a one-time fallback, pass --anthropic-key (or set ANTHROPIC_API_KEY) and the CLI connects it for you. Otherwise no model key ever goes on the command line.

If the Remyx GitHub App isn't installed on the target repo yet, the command surfaces the install link.

For the no-App setup-local path, the --no-cron switch, and --bulk-repos onboarding across many repos at once, see docs/install-paths.md.

Command reference

Run any command with --help for full flag listings and examples.

Command What it does
remyxai papers digest Recommendations grouped by Research Interest
remyxai papers list Recommendations flat view (filter by interest, period, source type)
remyxai papers refresh [--wait] Trigger a fresh ranking
remyxai papers refresh-status <task_id> Poll a refresh task
remyxai interests list List your Research Interests
remyxai interests get <name-or-uuid> Show one interest
remyxai interests create Create an interest from free-form context
remyxai interests from-repo <github-url> Create an interest from a GitHub repo profile
remyxai interests from-project <name-or-uuid> Create an interest from a project's experiments
remyxai interests update <id> Edit name / context / daily count / active state
remyxai interests toggle <id> Flip active/inactive
remyxai interests delete <id> Remove an interest
remyxai outrider init Install Outrider on a GitHub repo via the Remyx App
remyxai outrider setup-local Install Outrider via your own gh (no Remyx App)
remyxai outrider trigger Dispatch a one-shot Outrider run; supports --pin-method / --pin-arxiv / --provider / --model / --claude-timeout
remyxai outrider set-provider-secret Set a per-provider API-key secret on a repo, safely (avoids the gh secret set --body - truncation trap)
remyxai search query <text> Search the engine's research-asset catalog
remyxai search list List recently added research assets (papers + Docker images)
remyxai search info <arxiv-id> Asset details

Development

git clone https://github.com/remyxai/remyxai-cli
cd remyxai-cli
pip install -e .

# Run tests
pytest tests/

Releases: tag a v* release on GitHub and the publish.yml workflow builds + uploads to PyPI via Trusted Publishing (no API token stored).

Links

  • Outrider — the GitHub Action this CLI installs
  • engine.remyx.ai — web app, account settings, API key
  • Issues — bug reports and feature requests

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

remyxai-0.4.4.tar.gz (50.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

remyxai-0.4.4-py3-none-any.whl (55.2 kB view details)

Uploaded Python 3

File details

Details for the file remyxai-0.4.4.tar.gz.

File metadata

  • Download URL: remyxai-0.4.4.tar.gz
  • Upload date:
  • Size: 50.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for remyxai-0.4.4.tar.gz
Algorithm Hash digest
SHA256 44b1c11149f5336549d931f3d4462d1dafc021f0372b23489febb6afafec85a1
MD5 5939c71b02efa0436bb5854dd2d5d49b
BLAKE2b-256 2c2fb174db1cf4a1146b2f29c07b167d4b116f1df1ce5636647176ed983af1a7

See more details on using hashes here.

Provenance

The following attestation bundles were made for remyxai-0.4.4.tar.gz:

Publisher: publish.yml on remyxai/remyxai-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file remyxai-0.4.4-py3-none-any.whl.

File metadata

  • Download URL: remyxai-0.4.4-py3-none-any.whl
  • Upload date:
  • Size: 55.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for remyxai-0.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 c20df759655573496168ae8d4c47c5b1292305281545a109591f8de5fbc61b57
MD5 0962d6acd340ad54d9b57df5b94b9ff1
BLAKE2b-256 aa7ebca8b47397c2fc068985f893eda80c925bc51a9e6384cb5fe9208d0c7780

See more details on using hashes here.

Provenance

The following attestation bundles were made for remyxai-0.4.4-py3-none-any.whl:

Publisher: publish.yml on remyxai/remyxai-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page