Skip to content

init

Initialize rp1 in a repository and prepare it for workflow use.

Synopsis

rp1 init [options]

Description

rp1 init is the normal entry point for bringing rp1 into an existing repository. It prepares the project, detects supported hosts, installs integrations where automatic setup is available, and prints the next actions.

Options

Option Short Description
--yes -y Accept safe defaults without prompting
--interactive -i Force interactive mode even without a TTY

Host Support

Host Detected by init Instruction file Automatic integration setup
Claude Code Yes CLAUDE.md Yes
OpenCode Yes AGENTS.md Yes
GitHub Copilot CLI Yes AGENTS.md Yes
Codex Yes AGENTS.md No, run rp1 install codex after init

Use Installation and Host Setup when you need the full setup path for a specific host.

What Gets Configured

Project Directories

init prepares the standard rp1 layout:

.rp1/
├── project_id
├── context/
├── work/
└── settings.toml

Instruction File

rp1 adds project guidance to the instruction file your host reads:

  • Claude Code: CLAUDE.md
  • OpenCode: AGENTS.md
  • Codex: AGENTS.md
  • GitHub Copilot CLI: AGENTS.md

Those files tell the host how to load project context and invoke rp1 workflows.

Ignore Defaults

The recommended setup keeps project context shareable while treating local work artifacts as disposable:

  • Track .rp1/context/
  • Ignore .rp1/work/
  • Ignore .rp1/context/meta.json
  • Ignore .rp1/settings.toml

Git Ignore Presets

rp1 init uses the recommended ignore defaults unless you choose a different setup during interactive initialization. The presets all keep .rp1/project_id shareable so Arcade and rp1 can recognize the same project across clones and worktrees.

Examples

Standard Setup

cd my-project
rp1 init

Non-Interactive Setup

rp1 init --yes

Use non-interactive setup for automation, dev containers, and fresh checkouts where you want repeatable defaults.

Typical Next Steps

After init, the normal path is:

  1. Restart the detected host tool so it reloads rp1.
  2. Run any host-specific install command that init printed.
  3. Generate project context.
  4. Start your first workflow or open Arcade.
Host First context command
Claude Code /knowledge-build
OpenCode /rp1-base-knowledge-build
Codex $rp1-base-knowledge-build
GitHub Copilot CLI /rp1-base-knowledge-build

See Also