pk brief

The repository's policy, rendered as instructions for a session. The SessionStart hook runs it on every start, resume, and compaction and injects the text as context. Nothing is copied into the repository: the text is derived from .pk.json on each run.

Usage

pk brief
pk brief --format json

At a terminal, pk brief prints the text a session receives. --format json prints the SessionStart envelope the hook emits. In an unconfigured repository the hook is silent and the command says so.

What it says

The first sentence names the plugin's version. The plugin's shim runs the binary beside it; when none is there, it runs the pk on the PATH and tells it where the plugin is, and the sentence then also names that pk's version, says which side is behind, and gives the command that levels them: go install for pk, /plugin update for the plugin. A dev build of pk is not compared. The last sentence is constant. The rest follows the dials. changelog.types lists the commit types, the default table when the file leaves it empty. guard.breaking decides whether the marker rule mentions the ask. guard.bump decides whether the version rule mentions the ask. guard.mode and guard.push describe the protected branches and pushing. release.branch names where releases merge. preserve.mode describes how plans are kept. A dial set to off drops its paragraph.

Flags

  --format <value>
        Output format: text or json (default text)

Every command also accepts --plain, --project-dir <value>, and --quiet; see pk help help.