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

# Set up a repository

> Install Outrider on a repository with or without the Remyx GitHub App, and set provider secrets.

Task guide: [Find and draft changes](https://docs.remyx.ai/platform/agents/outrider-action.md)

```bash theme={null}
remyxai outrider init --repo OWNER/REPO --auto-interest
```

## Install on a repo

```bash theme={null}
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` |
| `--agent` | Which coding-agent CLI runs the implementation: `claude`, `codex`, or `backboard`. A separate axis from the model provider. The CLI reads the provisioned workflow back and confirms the agent it was written with | `claude` |
| `--anthropic-key` | Anthropic API key to connect as the model provider when none is connected (use [Connectors](https://docs.remyx.ai/platform/configure/connectors.md#model-providers-and-coding-agents) for any other provider). Falls back to `$ANTHROPIC_API_KEY` | *(only used if no provider is connected)* |
| `--github-secrets-only` | Keep the provider key in the repo's GitHub Actions secrets only: the CLI seals it against the repo's Actions public key on your machine and the engine relays the ciphertext, so no copy is stored on Remyx. See [Where the model key lives](https://docs.remyx.ai/platform/agents/security.md#where-the-model-key-lives) | — |
| `--force` | Re-drive provisioning on a repo that is already installed (rewrite the workflow, pick up new dispatch inputs) without revoking its automation key | — |
| `--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 | — |

> [!NOTE]
>
> Connect the [GitHub](https://docs.remyx.ai/platform/configure/github.md) and a [model provider](https://docs.remyx.ai/platform/configure/connectors.md#model-providers-and-coding-agents) (Anthropic, Z.ai, Moonshot, OpenAI, or OpenRouter) integration in [Connectors](https://docs.remyx.ai/platform/configure/connectors.md) 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.

```bash Auto-create the interest and set it all up theme={null}
remyxai outrider init --repo remyxai/RepoRanger --auto-interest
```

```bash Wire in an existing interest, review the setup PR theme={null}
remyxai outrider init --repo owner/name --interest <uuid> --mode review
```

```bash Non-interactive (CI) theme={null}
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`.

```bash theme={null}
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 | — |
| `--agent` | Which coding-agent CLI the generated workflow runs by default: `claude`, `codex`, or `backboard`. Sets the `agent` dispatch input's default, so one install can still switch agents per run — provided that pair's secret is on the repo | `claude` |
| `--backend` | Default model backend for the single-file setup: `anthropic`, `openai`, `zai`, `moonshot`, or `openrouter` — on either API family, since the agent axis decides which one is spoken. Unset, it follows the agent to its own vendor (`codex` → `openai`). The rendered workflow declares `agent`/`provider`/`model` dispatch inputs either way, so any install can be re-routed per run | *(the agent's own vendor)* |
| `--model` | Model id the install runs by default, from the backend you picked (e.g. `gpt-5.4-mini` on `openai`, `glm-5.3` on `zai`). Becomes the `model` dispatch input's default. Required with `--agent backboard`, which addresses models as `<provider>/<model>` and has no default of its own | *(the agent's own default)* |
| `--zai-key` | Z.ai GLM Coding Plan key, set as the `ZAI_API_KEY` repo secret when a GLM model is in play. Falls back to `$ZAI_API_KEY` | — |
| `--two-tier` | Write the [two-tier drafter/refiner](https://docs.remyx.ai/platform/agents/backends.md#the-two-tier-drafter-refiner-pattern) layout: a dispatch-capable main workflow, a daily branch-mode drafter, and a weekly refiner | — |
| `--drafter-model` / `--refiner-model` | Models for the two tiers — any tier from any supported provider, mixed freely (e.g. a `glm-5.2` drafter with a `claude-opus-4-8` refiner, or a `kimi-k3` drafter) | — |
| `--dry-run` | Print the plan + rendered workflow and exit | — |
| `--yes, -y` | Skip the confirmation prompt | — |

> [!NOTE]
>
> `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.
>
> It writes only the selected backend's secret; add another with [`set-provider-secret`](#set-a-providers-api-key-on-a-repo) to switch per dispatch. Claude Code and Codex read no credential of their own — the action derives theirs from the provider's key — so don't set an agent-named secret for them. Backboard is the exception: its own key *is* the credential (`gh secret set BACKBOARD_API_KEY`).

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

```bash theme={null}
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 by the `<VENDOR>_API_KEY` convention (`anthropic` → `ANTHROPIC_API_KEY`, `openai` → `OPENAI_API_KEY`, `zai`, `moonshot`, `openrouter`). Covers every provider the action understands, which is wider than the set `init` can provision through the engine. **Required** | — |
| `--key-from` | Path to a file containing only the API key. **Required** | — |

See [Automated discovery PRs](https://docs.remyx.ai/platform/agents/outrider-action.md) for what the action does once installed, its configuration inputs, and how to review the PRs it opens.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.