Install the Postman plugin into detected agents

Install the Postman plugin into every detected coding agent found on your machine with a single command. You can also limit the installation to a specific agent. This method requires Node.js and the agent versions listed in Requirements.

To install for a single agent using that agent’s own method, see Install the Postman plugin for a specific agent.

Usage

npx @postman/postman-plugin [command] [options]

Run npx @postman/postman-plugin with a command and any options. With no command, it runs install.

Commands and options

The installer accepts the following commands:

Command	What it does
`install`	Install into each detected agent, or update it there. This is the default when you don’t pass a command.
`status`	Show which agents are detected and whether the Postman plugin is installed.
`remove`	Uninstall from each detected agent. Alias: `uninstall`.

The commands accept the following options:

--agent <id>

Limit the command to one or more agents instead of every detected agent. Repeat the option or comma-separate the ids. Works with install, status, and remove.

-y, --yes

Skip the confirmation prompt for install or remove. Required for both when running outside a terminal, unless you also pass --dry-run.

--dry-run

Preview what install or remove would do, without making any changes.

The following options are global. Use them on their own, without a command:

-h, --help

Show the help.

-v, --version

Show the version.

Examples

# Install into every detected agent (the default command)
npx @postman/postman-plugin
# Limit to one agent
npx @postman/postman-plugin install --agent cursor
# Check what's currently installed
npx @postman/postman-plugin status
# Remove the plugin from every detected agent
npx @postman/postman-plugin remove

Exit codes

Exit code	Meaning
`0`	Succeeded, or there was nothing to do.
`1`	Failed: an error occurred, you canceled, or `install` found no supported agent.
`2`	Invalid usage, or `install` or `remove` needed confirmation but ran outside a terminal (use `--yes`).
`3`	Succeeded, except for a manual step you still need to complete (shown as `next:` in the output).