> ## Documentation Index
> Fetch the complete documentation index at: https://docs.plannotator.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Install Plannotator

> Install Plannotator on macOS, Linux, WSL, or Windows, verify the command, and finish setup for your coding agent.

The standard installer adds the `plannotator` command, checks the downloaded binary, and installs the hooks, skills, commands, and local runtimes used by detected coding agents.

## Run the installer

<Tabs>
  <Tab title="macOS, Linux, or WSL">
    ```bash theme={null}
    curl -fsSL https://plannotator.ai/install.sh | bash
    ```
  </Tab>

  <Tab title="Windows PowerShell">
    ```powershell theme={null}
    irm https://plannotator.ai/install.ps1 | iex
    ```
  </Tab>

  <Tab title="Windows Command Prompt">
    ```bat theme={null}
    curl -fsSL https://plannotator.ai/install.cmd -o install.cmd && install.cmd && del install.cmd
    ```
  </Tab>
</Tabs>

The macOS and Linux installer supports x64 and Arm64. The Windows installers support x64 and Arm64 Windows.

The full installer needs Git to fetch the current skills and command files. The optional integrated terminal also needs Node.js and npm. If that runtime cannot be installed, document annotation still works without the integrated terminal.

## Verify the command

Open a new terminal if the installer changed your `PATH`, then run:

```bash theme={null}
plannotator --version
plannotator --help
```

The help output lists the user-facing commands supported by the installed version.

## Finish your agent setup

Choose your coding agent. The table shows what to do after the standard installer.

| Host                                           | Next step                                                                                                                                                                                                   |
| ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Claude Code](/open-source/agents/claude-code) | Install the Claude Code marketplace plugin and restart Claude Code.                                                                                                                                         |
| [Codex](/open-source/agents/codex)             | On macOS, Linux, or WSL, restart Codex Desktop. The installer enables the experimental plan-review hook and installs shared skills when it detects Codex. On Windows, use manual commands or shared skills. |
| [OpenCode](/open-source/agents/opencode)       | Add `@plannotator/opencode@latest` to `opencode.json`, then restart OpenCode.                                                                                                                               |
| [Copilot CLI](/open-source/agents/copilot-cli) | Install the Copilot CLI marketplace plugin, then restart Copilot CLI.                                                                                                                                       |
| [Gemini CLI](/open-source/agents/gemini-cli)   | The standard installer adds the policy, plan-review hook, and commands when it detects `~/.gemini`. Restart Gemini CLI.                                                                                     |
| [Amp](/open-source/agents/amp)                 | Copy the Amp plugin into the user or project plugin directory.                                                                                                                                              |
| [Droid](/open-source/agents/droid)             | Add the Plannotator marketplace and install its Droid plugin.                                                                                                                                               |
| [Kiro CLI](/open-source/agents/kiro-cli)       | The standard installer adds review skills and an example agent when it detects Kiro CLI. Rerun the installer if you installed Kiro later.                                                                   |
| [Pi](/open-source/agents/pi)                   | Install `@plannotator/pi-extension` through Pi. The standard installer is not required.                                                                                                                     |

## Install only the binary

Use a minimal install when you want the command without agent hooks, skills, commands, the optional `sem` semantic-diff sidecar, or the managed agent-terminal runtime.

<Tabs>
  <Tab title="macOS, Linux, or WSL">
    ```bash theme={null}
    curl -fsSL https://plannotator.ai/install.sh | bash -s -- --minimal
    ```
  </Tab>

  <Tab title="Windows PowerShell">
    ```powershell theme={null}
    & ([scriptblock]::Create((irm https://plannotator.ai/install.ps1))) -Minimal
    ```
  </Tab>
</Tabs>

`--binary-only` is an alias for `--minimal` in the shell installer. `-BinaryOnly` is the PowerShell alias. You can also set `PLANNOTATOR_MINIMAL=1`.

## Pin or verify a release

Pin a release when you need a repeatable install:

<Tabs>
  <Tab title="macOS, Linux, or WSL">
    ```bash theme={null}
    curl -fsSL https://plannotator.ai/install.sh | bash -s -- --version vX.Y.Z
    ```
  </Tab>

  <Tab title="Windows PowerShell">
    ```powershell theme={null}
    & ([scriptblock]::Create((irm https://plannotator.ai/install.ps1))) -Version vX.Y.Z
    ```
  </Tab>

  <Tab title="Windows Command Prompt">
    ```bat theme={null}
    curl -fsSL https://plannotator.ai/install.cmd -o install.cmd
    install.cmd --version vX.Y.Z
    del install.cmd
    ```

    The positional form is also supported after you download the script:

    ```bat theme={null}
    install.cmd vX.Y.Z
    ```
  </Tab>
</Tabs>

Every installer checks the binary against its SHA-256 checksum. SLSA provenance verification is optional and requires an installed and authenticated GitHub CLI:

<Tabs>
  <Tab title="macOS, Linux, or WSL">
    ```bash theme={null}
    curl -fsSL https://plannotator.ai/install.sh | bash -s -- --version vX.Y.Z --verify-attestation
    ```
  </Tab>

  <Tab title="Windows PowerShell">
    ```powershell theme={null}
    & ([scriptblock]::Create((irm https://plannotator.ai/install.ps1))) -Version vX.Y.Z -VerifyAttestation
    ```
  </Tab>

  <Tab title="Windows Command Prompt">
    ```bat theme={null}
    curl -fsSL https://plannotator.ai/install.cmd -o install.cmd
    install.cmd --version vX.Y.Z --verify-attestation
    del install.cmd
    ```
  </Tab>
</Tabs>

Windows provenance verification supports stable releases from v0.17.2 onward. The Windows installers reject prerelease tags when verification is enabled.

Continue with [annotating your first plan](/open-source/start/quickstart).

Last verified against Plannotator OSS v0.23.1 on July 18, 2026. Maintained by the Plannotator project.