Quickstart

Install the CLI

From npm (package name hyper-pm):

npm install -g hyper-pm

Or use a monorepo build — see Install.

Open a Git repository

cd into a repo you want to manage. hyper-pm uses git for all storage; bare repos are not the typical target — use a normal clone.

Initialize

hyper-pm init

This sets up the data branch and writes .hyper-pm/config.json. You can override branch name and remote later; see Configuration.

Create work items

Default output is JSON (good for scripting). Copy ids from the printed objects, or pipe through jq:

hyper-pm epic create --title "Launch hyper-pm docs"
hyper-pm story create --title "Write Speed Docs pages" --epic <epic-id>
hyper-pm ticket create --title "Add overview diagram" --story <story-id>

Use --format text (a global option before the subcommand) for human-readable tables during exploration:

hyper-pm --format text epic read

Inspect and validate

hyper-pm --format text ticket read --id <ticket-id>
hyper-pm doctor