Skip to content

README.md

Latest commit

 

History

History
33 lines (20 loc) · 2.04 KB

README.md

File metadata and controls

33 lines (20 loc) · 2.04 KB
Raw

pm CLI Codex Plugin

This plugin packages pm-cli for Codex with:

  • a native stdio MCP server (pm-mcp) backed by pm command modules, not shell pm invocations
  • skills for developer, user, extension, SDK, release, and audit workflows
  • command prompts for common planning and verification loops
  • repo marketplace metadata for one-step local installation in Codex

Install

From this repository:

codex plugin marketplace add .

Restart Codex, then install pm CLI from the repo marketplace. The bundled MCP server starts through plugins/pm-codex/scripts/pm-mcp-server.mjs.

For a published package install, keep @unbrained/pm-cli available through npm. The launcher uses the local repo build when present and falls back to npx -y --package=@unbrained/pm-cli@latest pm-mcp when the plugin is cached outside the repository.

Native Tools

Prefer the narrow tools when they match the task: pm_context, pm_search, pm_list, pm_get, pm_create, pm_copy, pm_focus, pm_update, pm_append, pm_claim, pm_release, pm_close, pm_comments, pm_files, pm_docs, pm_notes, pm_learnings, pm_deps, pm_test, pm_validate, pm_health, pm_contracts, pm_schema, pm_config, and pm_plan.

Use pm_run for the remaining pm surface. Supported actions include init, calendar, activity, aggregate, dedupe-audit, normalize, reindex, extension, history, history-redact, stats, test-all, comments-audit, gc, templates, and test-runs controls.

pm_plan exposes Codex-style ExecPlans as a first-class Plan item type with ordered steps, evidence, decisions, discoveries, validation, and materialization. See the pm-native skill for the full Plan workflow recipe. For init automation, pass options.agentGuidance (ask|add|skip|status) when you need deterministic AGENTS/CLAUDE guidance behavior in non-interactive runs.

Safety

Do not pass path for real repository tracking. For tests, pass a sandbox cwd or path, and keep PM_GLOBAL_PATH isolated when running commands that execute linked tests.