Set up from your agent

OpenPlanr publishes a setup guide written for coding agents at openplanr.dev/setup.md. Give it to the agent you already use, and the agent installs OpenPlanr in your repository step by step, asking you before it installs or changes anything.

Ask your agent

Open your repository in Claude Code, Codex, or Cursor, and ask the agent to set up OpenPlanr in this repository by following https://openplanr.dev/setup.md.

What the agent does

1. Checks that Node.js and Git are installed and recent enough. If either is missing or too old, it stops and tells you which one to install or upgrade.
2. Asks once whether to install the OpenPlanr CLI globally with npm. If you say no, it runs the CLI through npx instead.
3. Previews the setup for the coding agents on your machine and shows you which agents it covers, where files go, and what it adds, updates, or removes. Cursor installs per project, so the guide previews a separate project setup for it.
4. Asks once before applying the setup. If you say no, it stops and confirms that nothing changed.
5. Initializes the planning folder, .planr/, where specs, stories, and tasks live as files you review and version like code.
6. Runs a health check and reports the result. For a warning, it shows the suggested fix and asks before applying it.
7. Asks which feature you want to build next, tells you to restart the agent so it loads the new skills, and gives you the exact first command for your agent.

What the agent does not do

• Write anywhere other than your repository and the coding agent's own skill folders.
• Ask for, read, or store secrets.
• Guess a workaround when a command fails. It shows the exact error and stops.

After the restart

Start with /spec and the feature you named. In Codex, the guide installs each skill under its own name, and each skill also carries a display name, such as OpenPlanr Spec.

Prefer to run each command yourself? Follow Install and set up OpenPlanr, then write your first spec.