@pieai/pro-gov 0.3.7 → 0.3.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +36 -9
- package/assets/docs/reference/adoption/adoption-playbook.md +29 -9
- package/assets/docs/reference/adoption/project-relationship.md +14 -15
- package/assets/docs/reference/adoption/recommended-agent-tooling.md +23 -1
- package/assets/integrations/compound-engineering.md +124 -0
- package/assets/integrations/ponytail.md +52 -0
- package/assets/integrations/superpowers.md +21 -8
- package/assets/profiles/doc-only/manifest.yml +2 -0
- package/assets/profiles/doc-only/profile.md +4 -4
- package/assets/profiles/engineering-runtime/manifest.yml +2 -0
- package/assets/profiles/engineering-runtime/profile.md +12 -4
- package/assets/starter/.agents/hooks.json +26 -0
- package/assets/starter/.claude/settings.json +26 -0
- package/assets/starter/.codex/hooks.json +28 -0
- package/assets/starter/AGENTS.template.md +3 -1
- package/assets/starter/docs/governance/boundary.md +7 -0
- package/assets/starter/docs/governance/ssot-v0.9.md +12 -0
- package/assets/starter/docs/reference/documentation-map.md +5 -0
- package/cli-guide.md +34 -6
- package/dist/cli.js +680 -45
- package/package.json +2 -2
- package/assets/docs/reference/adoption/public-release-checklist.md +0 -153
- package/assets/docs/reference/adoption/site-publication-brief.md +0 -94
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
{
|
|
2
|
+
"hooks": {
|
|
3
|
+
"Stop": [
|
|
4
|
+
{
|
|
5
|
+
"hooks": [
|
|
6
|
+
{
|
|
7
|
+
"type": "command",
|
|
8
|
+
"command": "cd \"${CLAUDE_PROJECT_DIR:-$(git rev-parse --show-toplevel)}\" && if [ -x ./node_modules/.bin/pro-gov ]; then ./node_modules/.bin/pro-gov host-hook --host claude-code --event Stop; elif [ -f packages/pro-gov/src/cli.ts ] && command -v pnpm >/dev/null 2>&1; then pnpm --silent --filter @pieai/pro-gov dev host-hook --host claude-code --event Stop; else npx --no-install @pieai/pro-gov host-hook --host claude-code --event Stop; fi",
|
|
9
|
+
"timeout": 30
|
|
10
|
+
}
|
|
11
|
+
]
|
|
12
|
+
}
|
|
13
|
+
],
|
|
14
|
+
"SubagentStop": [
|
|
15
|
+
{
|
|
16
|
+
"hooks": [
|
|
17
|
+
{
|
|
18
|
+
"type": "command",
|
|
19
|
+
"command": "cd \"${CLAUDE_PROJECT_DIR:-$(git rev-parse --show-toplevel)}\" && if [ -x ./node_modules/.bin/pro-gov ]; then ./node_modules/.bin/pro-gov host-hook --host claude-code --event SubagentStop; elif [ -f packages/pro-gov/src/cli.ts ] && command -v pnpm >/dev/null 2>&1; then pnpm --silent --filter @pieai/pro-gov dev host-hook --host claude-code --event SubagentStop; else npx --no-install @pieai/pro-gov host-hook --host claude-code --event SubagentStop; fi",
|
|
20
|
+
"timeout": 30
|
|
21
|
+
}
|
|
22
|
+
]
|
|
23
|
+
}
|
|
24
|
+
]
|
|
25
|
+
}
|
|
26
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
{
|
|
2
|
+
"hooks": {
|
|
3
|
+
"Stop": [
|
|
4
|
+
{
|
|
5
|
+
"hooks": [
|
|
6
|
+
{
|
|
7
|
+
"type": "command",
|
|
8
|
+
"command": "cd \"$(git rev-parse --show-toplevel)\" && if [ -x ./node_modules/.bin/pro-gov ]; then ./node_modules/.bin/pro-gov host-hook --host codex --event Stop; elif [ -f packages/pro-gov/src/cli.ts ] && command -v pnpm >/dev/null 2>&1; then pnpm --silent --filter @pieai/pro-gov dev host-hook --host codex --event Stop; else npx --no-install @pieai/pro-gov host-hook --host codex --event Stop; fi",
|
|
9
|
+
"timeout": 30,
|
|
10
|
+
"statusMessage": "Checking PGS Compound Gate"
|
|
11
|
+
}
|
|
12
|
+
]
|
|
13
|
+
}
|
|
14
|
+
],
|
|
15
|
+
"SubagentStop": [
|
|
16
|
+
{
|
|
17
|
+
"hooks": [
|
|
18
|
+
{
|
|
19
|
+
"type": "command",
|
|
20
|
+
"command": "cd \"$(git rev-parse --show-toplevel)\" && if [ -x ./node_modules/.bin/pro-gov ]; then ./node_modules/.bin/pro-gov host-hook --host codex --event SubagentStop; elif [ -f packages/pro-gov/src/cli.ts ] && command -v pnpm >/dev/null 2>&1; then pnpm --silent --filter @pieai/pro-gov dev host-hook --host codex --event SubagentStop; else npx --no-install @pieai/pro-gov host-hook --host codex --event SubagentStop; fi",
|
|
21
|
+
"timeout": 30,
|
|
22
|
+
"statusMessage": "Checking PGS subagent Compound Gate"
|
|
23
|
+
}
|
|
24
|
+
]
|
|
25
|
+
}
|
|
26
|
+
]
|
|
27
|
+
}
|
|
28
|
+
}
|
|
@@ -37,7 +37,9 @@
|
|
|
37
37
|
|
|
38
38
|
- Name this project's adopted profile: `engineering-runtime` or `doc-only`.
|
|
39
39
|
- Point to the chosen agents-routing file from `docs/governance/agents-routing/`.
|
|
40
|
-
- Engineering projects may use Superpowers, Directed Development, GStack, or other external workflows only inside the selected lane; do not copy upstream
|
|
40
|
+
- Engineering projects may use Superpowers, Directed Development, GStack, or other external workflows only inside the selected lane; do not copy upstream integration guides into the target project by default.
|
|
41
|
+
- For engineering projects, Superpowers is the default engineering workflow. Compound Engineering is used by default only as the post-work Compound Gate through `ce-compound`; full CE workflows require an explicit user request.
|
|
42
|
+
- Engineering projects should have PGS Stop hooks wired for Codex, Claude Code, and Antigravity. Before final reporting after completed engineering work, report `Compound Gate: ran ce-compound -> <path>` or `Compound Gate: skipped -> <reason>`.
|
|
41
43
|
- Doc-only projects should say that Superpowers TDD and Directed Development are not enabled by default.
|
|
42
44
|
- External workflow systems such as Superpowers or GStack run inside the lane selected by this router. They must not replace this project router.
|
|
43
45
|
|
|
@@ -46,6 +46,7 @@ project-specific AI development habits live.
|
|
|
46
46
|
- Product prompts, generated media notes, or project-package workbench files.
|
|
47
47
|
- Current project plans or active specs.
|
|
48
48
|
- Superpowers plugin content.
|
|
49
|
+
- Compound Engineering plugin content.
|
|
49
50
|
|
|
50
51
|
## Put Those Elsewhere
|
|
51
52
|
|
|
@@ -59,6 +60,7 @@ project-specific AI development habits live.
|
|
|
59
60
|
| Product or world truth | `docs/canon/` |
|
|
60
61
|
| Active implementation work | `docs/plans/active/` |
|
|
61
62
|
| Completed proof records | `docs/plans/completed/` |
|
|
63
|
+
| Compound Engineering learnings | `docs/solutions/**` as CE-owned external artifacts |
|
|
62
64
|
| Product artifacts outside governed docs | Project package, workbench, assets, runtime config, or source tree |
|
|
63
65
|
|
|
64
66
|
When unsure, ask this question: is this rule about how the document system works,
|
|
@@ -74,3 +76,8 @@ It does not govern every Markdown file in the repository. Markdown under
|
|
|
74
76
|
product packages, workbenches, prompt libraries, source folders, or asset
|
|
75
77
|
folders can be product artifacts. Keep those files where the product package
|
|
76
78
|
expects them unless a project explicitly opts them into doc-gov.
|
|
79
|
+
|
|
80
|
+
Compound Engineering external artifacts under `docs/solutions/**`,
|
|
81
|
+
`docs/brainstorms/**`, `docs/pulse-reports/**`, and CE-native root files under
|
|
82
|
+
`docs/plans/*` are not governed docs by default. They remain valid project
|
|
83
|
+
artifacts, but their frontmatter belongs to Compound Engineering, not Doc Gov.
|
|
@@ -50,6 +50,17 @@ Markdown.
|
|
|
50
50
|
|
|
51
51
|
Extra governed roots are allowed only when a project explicitly opts in.
|
|
52
52
|
|
|
53
|
+
Compound Engineering external artifacts are explicitly outside the default Doc
|
|
54
|
+
Gov schema:
|
|
55
|
+
|
|
56
|
+
- `docs/solutions/**`
|
|
57
|
+
- `docs/brainstorms/**`
|
|
58
|
+
- `docs/pulse-reports/**`
|
|
59
|
+
- CE-native root artifacts under `docs/plans/*`
|
|
60
|
+
|
|
61
|
+
PGS plans remain under `docs/plans/active/**` and
|
|
62
|
+
`docs/plans/completed/**`.
|
|
63
|
+
|
|
53
64
|
## Core Behavior
|
|
54
65
|
|
|
55
66
|
- **Discover before editing**: first identify the project's actual documentation
|
|
@@ -106,6 +117,7 @@ works for governed docs:
|
|
|
106
117
|
| Project AI/development policy | `docs/policy/` |
|
|
107
118
|
| Product or feature requirement | `docs/specs/` |
|
|
108
119
|
| Step-by-step implementation work | `docs/plans/` |
|
|
120
|
+
| Compound Engineering learning records | `docs/solutions/**`, governed by CE schema |
|
|
109
121
|
| Durable workspace/system truth | `docs/canon/` |
|
|
110
122
|
| How-to guides, architecture maps, tool notes | `docs/reference/` |
|
|
111
123
|
| Retired governed history | `docs/archive/` |
|
|
@@ -40,6 +40,7 @@ Use `AGENTS.md` for startup reading. It should point agents to:
|
|
|
40
40
|
| `docs/specs/completed/` | Completed specs |
|
|
41
41
|
| `docs/plans/active/` | Active implementation plans |
|
|
42
42
|
| `docs/plans/completed/` | Completed execution records |
|
|
43
|
+
| `docs/solutions/` | Compound Engineering learning records, governed by CE schema |
|
|
43
44
|
| `docs/canon/` | Durable project truth |
|
|
44
45
|
| `docs/reference/` | Guides and references |
|
|
45
46
|
| `docs/archive/` | Retired history |
|
|
@@ -49,3 +50,7 @@ Markdown outside `docs/**` is not governed by default. Product prompts, assets,
|
|
|
49
50
|
project-package canon, generated media notes, and source-package files stay in
|
|
50
51
|
their product/workbench structure unless this project explicitly opts them into
|
|
51
52
|
doc-gov.
|
|
53
|
+
|
|
54
|
+
Compound Engineering may create `docs/solutions/**`, `docs/brainstorms/**`,
|
|
55
|
+
`docs/pulse-reports/**`, and CE-native root artifacts under `docs/plans/*`.
|
|
56
|
+
Those are external workflow artifacts, not Doc Gov canonical documents.
|
package/cli-guide.md
CHANGED
|
@@ -20,14 +20,25 @@ pro-gov portfolio check --config /path/to/portfolio.json
|
|
|
20
20
|
pro-gov portfolio plan --config /path/to/portfolio.json --target web-app --json
|
|
21
21
|
pro-gov lens inspect --target .
|
|
22
22
|
pro-gov lens report --target . --out .pro-gov/lens-report.md
|
|
23
|
+
pro-gov lens audit init --target /path/to/project --out audits/project/2026-07-01
|
|
24
|
+
pro-gov lens audit check --dir audits/project/2026-07-01
|
|
23
25
|
pro-gov init --profile engineering-runtime --dry-run
|
|
26
|
+
pro-gov init --profile engineering-runtime --apply
|
|
24
27
|
pro-gov init --profile doc-only --dry-run
|
|
25
|
-
pro-gov sync --check
|
|
28
|
+
pro-gov sync --check [--profile engineering-runtime|doc-only]
|
|
26
29
|
pro-gov doctor
|
|
27
30
|
```
|
|
28
31
|
|
|
29
|
-
`init`
|
|
30
|
-
|
|
32
|
+
`init --apply` is safe for a fresh target: it preflights every destination and
|
|
33
|
+
refuses the entire operation if any target file already exists. It never merges
|
|
34
|
+
or overwrites an existing router or project-local policy. Existing projects
|
|
35
|
+
should use `--dry-run` and migrate deliberately. Optional Lefthook and GitHub
|
|
36
|
+
Actions references stay packaged but are not installed by default.
|
|
37
|
+
|
|
38
|
+
`sync --check` is read-only. It compares shared governance core files strictly,
|
|
39
|
+
but checks project-local seeds such as `AGENTS.md`, project policy, and current
|
|
40
|
+
work for presence only. It infers the installed profile when exactly one route
|
|
41
|
+
exists; `--profile` resolves an empty or temporarily ambiguous target.
|
|
31
42
|
|
|
32
43
|
Full upstream-checkout commands:
|
|
33
44
|
|
|
@@ -54,8 +65,23 @@ auto|manual` only as a migration override when deliberately moving an existing
|
|
|
54
65
|
target.
|
|
55
66
|
|
|
56
67
|
Portfolio manifests are external configuration files owned by a user or
|
|
57
|
-
organization
|
|
58
|
-
|
|
68
|
+
organization. PGS provides the format and commands; it does not publish a real
|
|
69
|
+
user's private downstream project list. A normal npm user can omit
|
|
70
|
+
`controlPlane` and `executionEngine`; `portfolio plan` will use the reviewed
|
|
71
|
+
public assets packaged with `@pieai/pro-gov`. Add `executionEngine.path` only
|
|
72
|
+
when a full local checkout should provide a private asset registry for strict
|
|
73
|
+
maintainer checks.
|
|
74
|
+
|
|
75
|
+
`lens audit init` creates a raw-first audit package for Project Lens plus
|
|
76
|
+
Ponytail reviews. For a "read-only project audit", the target repository remains
|
|
77
|
+
read-only, but the audit package is still the required output record. `lens
|
|
78
|
+
audit check` fails when the package is missing required artifacts, when
|
|
79
|
+
artifacts are still marked pending, or when generated template text was not
|
|
80
|
+
replaced with real audit output. It also requires method records for the
|
|
81
|
+
read-only boundary, agent execution, subagent trace, Project Lens/Ponytail
|
|
82
|
+
sources, target status, and audit package status. Use
|
|
83
|
+
`lens audit check --mode fresh` when this session must prove it created the raw
|
|
84
|
+
passes; use `--mode reuse` when it only verifies an existing audit package.
|
|
59
85
|
|
|
60
86
|
## Typical Adoption Flow
|
|
61
87
|
|
|
@@ -65,7 +91,9 @@ pnpm pro-gov assets list
|
|
|
65
91
|
pnpm pro-gov assets discover --target .
|
|
66
92
|
pnpm pro-gov assets recommend --target .
|
|
67
93
|
pnpm pro-gov init --profile engineering-runtime --dry-run
|
|
68
|
-
pnpm pro-gov
|
|
94
|
+
pnpm pro-gov init --profile engineering-runtime --apply
|
|
95
|
+
pnpm doc-gov scan
|
|
96
|
+
pnpm pro-gov sync --check --profile engineering-runtime
|
|
69
97
|
pnpm doc-gov migrate --profile engineering-runtime --check
|
|
70
98
|
pnpm doc-gov doctor
|
|
71
99
|
```
|