Skip to content
OpenPlanr Docs
LearnGitHub (opens in a new tab)

Set up from your agent

Ask your coding agent to install the OpenPlanr plugin or skills, confirm missing setup choices, and add the companion CLI when needed.

OpenPlanr publishes a setup guide for coding agents at openplanr.dev/setup.md. It starts with the plugin or skills and adds the companion CLI only when your workflow needs it.

Ask your agent

Open your project in Claude Code, Codex, or Cursor and ask:

Set up OpenPlanr in this repo: https://openplanr.dev/setup.md

What the agent does

  1. Checks the current host and whether OpenPlanr is already installed, so it can avoid duplicate discovery.
  2. Offers the Claude Code marketplace where applicable, or the standard skills installer. It confirms only missing choices: skills, destination host, and project or global scope.
  3. Shows the selected install command and destination before applying it. The standard installer can use noninteractive defaults inside a coding agent, so the guide supplies the selected skill and host explicitly.
  4. Verifies installation separately from workflow execution and tells you when to restart your host.
  5. Adds the companion CLI if you need diagram rendering, a local studio, planning validation, diagnostics, or integrations. Structured planning also uses openplanr init in your project.
  6. Gives you a first request appropriate to your goal and the installed skill names.

Prefer the terminal?

Run this from your project in a normal terminal:

bash
npx skills add openplanr/OpenPlanr

The installer offers skill selection and Project or Global scope, and detects destination hosts. You do not need to remember flags for this guided flow.

The skills package is Vercel Labs' installer. Its anonymous installation telemetry is separate from OpenPlanr. See the install guide for optional flags and the companion CLI.

After installation

Start with Ship for a clear change, Investigate for a bug, Design for interface work, or Operate for an operating review. Use Spec when the requirements need clarification. Select the installed skill name: plugin skills use planr:ship, while source skills use planr-ship.