CLI Reference

Complete reference for every command in the Prume CLI. All commands support --help for inline documentation.

24 commands across 4 categories. Use the cards above to jump to a section, or scroll through the full reference below.

Core Workflow

9 cmds

prume init

Initialize Prume in a Git repository. Creates the prume-staging/ directory and scans the repo.

prume init [OPTIONS]

Options

--nameProject name
--base-refBase branch (default: main)
--target-refTarget branch
--pathPath to repo (default: current directory)
--init-gitRun git init first if not a Git repo

prume analyze

Analyze Git changes and extract change units (hunks). Each hunk becomes a separately assignable unit.

prume analyze [OPTIONS]

Options

--uncommitted, -uAnalyze uncommitted working directory changes
--base, -bBase ref for branch comparison (default: config base_ref)
--target, -tTarget ref for comparison
--repairRepair broken change unit references
--pathPath to repo

prume classify

Classify change units into groups using the multi-layer rule engine (file paths, content, keywords, regex).

prume classify [OPTIONS]

Options

--auto, -aRun all classification layers
--assignAssign results to groups
--thresholdMinimum confidence score to assign (default from config)
--pathPath to repo

prume status

Show project status: change units, groups, workflow state, and assignment coverage.

prume status [OPTIONS]

Options

--pathPath to repo

prume stage

Stage a group’s change units to the Git index for committing. Operates at hunk-level precision.

prume stage <GROUP_ID> [OPTIONS]

Options

--all, -aStage all groups
--force, -fForce staging even with warnings
--interactive, -iInteractive selection of change units
--dry-run, -nShow what would be staged
--backup, -bCreate backup before staging
--atomicAtomic staging (all or nothing)
--validate-firstRun validation before staging
--pathPath to repo

prume commit

Commit a staged group. Uses the group’s configured message.

prume commit <GROUP_ID> [OPTIONS]

Options

--all, -aCommit all staged groups
--message, -mOverride commit message
--dry-run, -nShow what would be committed
--verbose, -vVerbose output
--pathPath to repo

prume stage-all

Stage and optionally commit all groups in dependency order. Interactive by default.

prume stage-all [OPTIONS]

Options

--resume-from, -rResume from a specific group
--dry-run, -dShow plan without executing
--skip-confirm, -ySkip confirmation prompts
--commit, -cCommit each group after staging

prume apply

Apply all groups as commits to a new branch. Alternative to stage-all for creating a clean branch.

prume apply [OPTIONS]

Options

--to, -tTarget branch name
--from, -fSource branch
--dry-run, -nShow plan without executing
--pathPath to repo

prume extract

Extract a branch’s committed changes back into uncommitted local changes for re-organizing.

prume extract <SOURCE_BRANCH> [OPTIONS]

Options

--base, -bBase branch (default: main)
--clean-branch, -cCreate a clean branch for the result
--force, -fForce even with uncommitted changes
--pathPath to repo

Inspection

5 cmds

prume diff

View diffs for change units — all, by group, by file, or unassigned only.

prume diff [TARGET] [OPTIONS]

Options

--group, -gShow diff for a specific group
--file, -fShow diff for a specific file
--unassigned, -uShow only unassigned change units
--context, -CNumber of context lines in diff
--stat, -sShow diffstat summary
--color / --no-colorEnable or disable colored output

prume show

Show details for a single change unit: file, hunk, group assignment, diff.

prume show <CHANGEUNIT_ID> [OPTIONS]

Options

--rawShow raw internal data

prume stats

Show project statistics and analytics.

prume stats [OPTIONS]

Options

--detailed, -dDetailed breakdown
--jsonOutput as JSON
--pathPath to repo

prume changeunits

List change units in a format suitable for scripting and AI tools.

prume changeunits [OPTIONS]

Options

--jsonOutput as JSON
--unassigned, -uShow only unassigned change units
--file, -fFilter by file path
--compact, -cCompact output for AI context windows
--pathPath to repo

prume validate

Validate project integrity: missing change units, circular dependencies, overlapping assignments.

prume validate

Group Management

4 cmds

prume groups

Manage groups (logical commit containers).

prume groups <SUBCOMMAND>

Subcommands

listList all groups
show <id>Show group details
create <name>Create a new group
delete <id>Delete a group
rename <id> <name>Rename a group
message <id>Set/edit group commit message
add <id> <cu_ids...>Add change units to a group
remove <id> <cu_ids...>Remove change units from a group
merge <source> <target>Merge two groups
split <id>Split a group interactively
auto-split <id>Auto-split a group by file clusters
stash <id>Stash a group (hide without deleting)
unstash <id>Restore a stashed group
move <id>Move change units between groups
dependencies <id>Show or set group dependencies
analyze-depsAnalyze file-level dependencies across groups
reorderReorder groups for commit sequence

prume assign

Assign change units to a group by file, pattern, or interactively.

prume assign <GROUP_ID> [OPTIONS]

Options

--file, -fAssign by file path (repeatable)
--pattern, -pAssign by glob pattern
--unassigned-only, -uOnly consider unassigned change units
--interactive, -iInteractive assignment
--pathPath to repo

prume reset

Reset Prume state. Clears change units and optionally groups.

prume reset [OPTIONS]

Options

--force, -fSkip confirmation
--keep-groupsReset change units but keep groups
--pathPath to repo

prume purge

Remove committed groups and their change units from Prume state.

prume purge [OPTIONS]

Options

--dry-run, -nShow what would be purged
--force, -fSkip confirmation
--pathPath to repo

Utilities

6 cmds

prume export

Export Prume data for backup or sharing.

prume export <SUBCOMMAND>

Subcommands

groupsExport groups as JSON (-o, --include-changeunits)
fullFull project export (-o required)

prume import

Import groups from a JSON file.

prume import <FILE> [OPTIONS]

Options

--merge, -mMerge with existing groups instead of replacing
--dry-run, -nPreview without importing
--pathPath to repo

prume config

View and manage Prume configuration.

prume config <SUBCOMMAND>

Subcommands

showShow current config (merged global + local)
initCreate a config file (--global for ~/.config/prume/)
set <key> <value>Set a config value

prume git

Git index management: verify consistency, sync, backup/restore.

prume git <SUBCOMMAND>

Subcommands

statusGit index status (--json, --verbose, --check)
verifyVerify index integrity
syncSync Prume state with Git index
resetReset Git index (--groups-only, --index-only)
repairRepair index issues
backupCreate a backup (-o, --with-state)
restoreRestore from backup (--with-state, --force)
diagnoseDiagnose issues (-o, --include-diffs)
backupsList available backups

prume doctor

Check system requirements and Prume configuration. Optionally fix issues.

prume doctor [OPTIONS]

Options

--fixAttempt to fix detected issues

prume completions

Set up shell completions for bash, zsh, or fish.

prume completions <SHELL>

Pro Commands

Pro

Prume Pro extends the CLI with additional commands. Install with pip install prume-pro. See the Pro Features page for details.

prume ui

Launch the Web UI

prume suggest

AI grouping suggestions

prume auto-assign

Auto-assign by similarity

prume license

Manage license keys

prume jira

Jira integration

prume stack-pr

Stacked PRs

prume graphite

Graphite PR management

prume pr

PR description utilities

prume branch

Create branch per group

prume jetbrains

JetBrains changelists

prume migrate

Migrate from git-staging-groups