@pieai/pro-gov 0.3.3 → 0.3.5
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 +80 -15
- package/assets/docs/reference/adoption/adoption-playbook.md +42 -6
- package/assets/docs/reference/adoption/downstream-project-registry.md +24 -17
- package/assets/docs/reference/adoption/project-relationship.md +9 -8
- package/assets/docs/reference/adoption/public-release-checklist.md +36 -29
- package/assets/docs/reference/adoption/recommended-agent-tooling.md +106 -0
- package/assets/docs/reference/adoption/site-publication-brief.md +22 -14
- package/assets/integrations/ponytail.md +109 -0
- package/assets/integrations/superpowers.md +30 -2
- package/assets/starter/.gemini/settings.json +5 -0
- package/assets/starter/.github/workflows/docs-check.yml +4 -2
- package/assets/starter/docs/governance/agents-routing/doc-only-v0.9.md +3 -2
- package/assets/starter/docs/governance/agents-routing/engineering-runtime-v0.9.md +3 -2
- package/assets/starter/docs/governance/ssot-v0.9.md +2 -2
- package/assets/starter/lefthook.template.yml +2 -2
- package/cli-guide.md +25 -1
- package/dist/cli.js +1444 -18
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,19 +1,31 @@
|
|
|
1
1
|
# @pieai/pro-gov
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
`@pieai/pro-gov` is the project-level setup kit for
|
|
4
|
+
[Project Governance System](https://github.com/PieAIStudio/ProjectGovernanceSystem).
|
|
5
|
+
It helps AI-assisted projects stay understandable after many plans, documents,
|
|
6
|
+
tools, and AI sessions have accumulated.
|
|
4
7
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
8
|
+
Think of Project Governance System as a librarian, traffic desk, and inspection
|
|
9
|
+
station:
|
|
10
|
+
|
|
11
|
+
- `pro-gov` shows which reusable project-governance parts are present or missing;
|
|
12
|
+
- `@pieai/doc-gov` checks documents, routing, links, hooks, and CI;
|
|
13
|
+
- Superpowers may provide the engineering process;
|
|
14
|
+
- Ponytail may provide an optional simplicity review.
|
|
15
|
+
|
|
16
|
+
The current `pro-gov` release is conservative by design. Public init and sync
|
|
17
|
+
commands inspect and compare; they do not silently overwrite another project's
|
|
18
|
+
router or local truth.
|
|
9
19
|
|
|
10
20
|
## Install
|
|
11
21
|
|
|
22
|
+
Requires Node.js `22.12.0` or newer.
|
|
23
|
+
|
|
12
24
|
```bash
|
|
13
25
|
pnpm add -D @pieai/pro-gov @pieai/doc-gov
|
|
14
26
|
```
|
|
15
27
|
|
|
16
|
-
|
|
28
|
+
Optional project scripts:
|
|
17
29
|
|
|
18
30
|
```json
|
|
19
31
|
{
|
|
@@ -24,24 +36,77 @@ Add scripts in the target project:
|
|
|
24
36
|
}
|
|
25
37
|
```
|
|
26
38
|
|
|
27
|
-
## Commands
|
|
39
|
+
## Public Commands
|
|
28
40
|
|
|
29
41
|
```bash
|
|
30
42
|
pro-gov assets list
|
|
43
|
+
pro-gov assets discover --target .
|
|
44
|
+
pro-gov assets recommend --target .
|
|
45
|
+
pro-gov lens inspect --target .
|
|
46
|
+
pro-gov lens report --target . --out .pro-gov/lens-report.md
|
|
31
47
|
pro-gov init --profile engineering-runtime --dry-run
|
|
32
48
|
pro-gov init --profile doc-only --dry-run
|
|
33
49
|
pro-gov sync --check
|
|
34
50
|
pro-gov doctor
|
|
35
51
|
```
|
|
36
52
|
|
|
37
|
-
|
|
38
|
-
|
|
53
|
+
What these commands do:
|
|
54
|
+
|
|
55
|
+
| Command group | Purpose | Writes project files? |
|
|
56
|
+
| --- | --- | --- |
|
|
57
|
+
| `assets list` | Shows packaged assets and public registry metadata. | No |
|
|
58
|
+
| `assets discover` | Detects local project signals. | No |
|
|
59
|
+
| `assets recommend` | Suggests relevant asset bundles with reasons. | No |
|
|
60
|
+
| `lens inspect` | Produces ProjectLens-style local evidence. | No |
|
|
61
|
+
| `lens report` | Writes the requested report file. | Only the explicit output |
|
|
62
|
+
| `init --dry-run` | Shows starter/profile files that would be needed. | No |
|
|
63
|
+
| `sync --check` | Compares local starter files with packaged assets. | No |
|
|
64
|
+
| `doctor` | Checks required packaged assets and whether `doc-gov` is available. | No |
|
|
65
|
+
|
|
66
|
+
## Full Checkout Commands
|
|
67
|
+
|
|
68
|
+
A full Project Governance System checkout may also manage Yuanfei's local
|
|
69
|
+
agent-asset registry through reviewed plans:
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
pro-gov assets plan --bundle base-governance --target . --out .pro-gov/asset-plan.json
|
|
73
|
+
pro-gov assets apply --plan .pro-gov/asset-plan.json
|
|
74
|
+
pro-gov assets check --target .
|
|
75
|
+
pro-gov assets npx update --plan
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
The plan is the safety gate. `apply` may update managed targets described by the
|
|
79
|
+
plan; it must not overwrite an unrelated unmanaged file.
|
|
80
|
+
|
|
81
|
+
These checkout-only workflows depend on the upstream `agent-assets/` registry.
|
|
82
|
+
The public npm package intentionally excludes private and mirrored third-party
|
|
83
|
+
skill bodies.
|
|
39
84
|
|
|
40
85
|
## Package Boundary
|
|
41
86
|
|
|
42
|
-
- `pro-gov`
|
|
43
|
-
- `
|
|
44
|
-
|
|
45
|
-
-
|
|
46
|
-
|
|
47
|
-
|
|
87
|
+
- `pro-gov` distributes starter, profile, integration, and adoption assets.
|
|
88
|
+
- `pro-gov assets discover|recommend` provides read-only project evidence and
|
|
89
|
+
deterministic recommendations.
|
|
90
|
+
- `pro-gov assets plan|apply|check` manages local assets only from an explicit,
|
|
91
|
+
reviewable plan in a full upstream checkout.
|
|
92
|
+
- `pro-gov lens inspect|report` provides read-only inspection and an explicit
|
|
93
|
+
report output.
|
|
94
|
+
- `doc-gov` remains the document, router, manifest, link, hook, CI, and migration
|
|
95
|
+
validator.
|
|
96
|
+
- Product truth stays in the target project.
|
|
97
|
+
- Write-mode `pro-gov init --apply` is not enabled in this release.
|
|
98
|
+
- Superpowers and Ponytail are external tools, not bundled runtime dependencies.
|
|
99
|
+
|
|
100
|
+
## Recommended Companion Tools
|
|
101
|
+
|
|
102
|
+
Superpowers is recommended for engineering/runtime projects that need
|
|
103
|
+
brainstorming, plans, TDD, debugging, verification, and worktree discipline.
|
|
104
|
+
|
|
105
|
+
Ponytail can be installed as an optional complexity adviser. Keep its global mode
|
|
106
|
+
`off`; test `lite` in one isolated task before considering a stronger mode.
|
|
107
|
+
Ponytail must not remove requested scope, tests, safety, accessibility, or proof.
|
|
108
|
+
|
|
109
|
+
Read the
|
|
110
|
+
[full project introduction](https://github.com/PieAIStudio/ProjectGovernanceSystem#readme)
|
|
111
|
+
for beginner examples, profiles, adoption guidance, and exact integration
|
|
112
|
+
boundaries.
|
|
@@ -6,7 +6,7 @@ status: stable
|
|
|
6
6
|
canonical: true
|
|
7
7
|
owner: human
|
|
8
8
|
created: 2026-05-06
|
|
9
|
-
last_reviewed: 2026-06-
|
|
9
|
+
last_reviewed: 2026-06-15
|
|
10
10
|
domain: adoption
|
|
11
11
|
tags:
|
|
12
12
|
- adoption
|
|
@@ -22,16 +22,22 @@ related:
|
|
|
22
22
|
|
|
23
23
|
Use this when a project wants to migrate into the Project Governance System.
|
|
24
24
|
|
|
25
|
+
Before choosing external AI workflow tools, read
|
|
26
|
+
`docs/reference/adoption/recommended-agent-tooling.md`. It explains which PGS
|
|
27
|
+
packages are required, when Superpowers is recommended, and why Ponytail should
|
|
28
|
+
remain globally `off` until it is tested in an isolated task.
|
|
29
|
+
|
|
25
30
|
## The Short Version
|
|
26
31
|
|
|
27
32
|
1. Pick one profile.
|
|
28
33
|
2. Inventory the project's current docs/rules.
|
|
29
34
|
3. Install the governance packages.
|
|
30
|
-
4.
|
|
31
|
-
5. Add
|
|
32
|
-
6.
|
|
33
|
-
7.
|
|
34
|
-
8.
|
|
35
|
+
4. Run project and agent-asset discovery.
|
|
36
|
+
5. Add starter `docs/governance/` and `docs/policy/` files.
|
|
37
|
+
6. Add the selected `docs/governance/agents-routing/` profile rule.
|
|
38
|
+
7. Move current truth into the governed layers.
|
|
39
|
+
8. Archive or delete old systems.
|
|
40
|
+
9. Run validation.
|
|
35
41
|
|
|
36
42
|
Do not migrate by slowly adding random files. Migrate by making one clear current work surface.
|
|
37
43
|
|
|
@@ -66,6 +72,11 @@ Current package-based method:
|
|
|
66
72
|
the starter files that would be installed
|
|
67
73
|
- run `pro-gov sync --check` to compare reusable starter files without changing
|
|
68
74
|
the project
|
|
75
|
+
- run `pro-gov assets discover --target <path>` and
|
|
76
|
+
`pro-gov assets recommend --target <path>` to collect local project signals
|
|
77
|
+
and suggested agent-asset bundles without changing the project
|
|
78
|
+
- run `pro-gov lens inspect --target <path>` when the project needs a
|
|
79
|
+
ProjectLens-style local evidence packet
|
|
69
80
|
- run `doc-gov migrate --profile <engineering-runtime|doc-only> --check` before
|
|
70
81
|
changing files so profile mismatches fail early
|
|
71
82
|
- run `doc-gov router-check` after the sync so stale router/profile paths fail
|
|
@@ -97,6 +108,27 @@ the private workspace package name is `pro-gov`. Target projects should use
|
|
|
97
108
|
for public links, and refer to the source as the Project Governance System
|
|
98
109
|
upstream repository.
|
|
99
110
|
|
|
111
|
+
### Optional: Managed Agent Assets
|
|
112
|
+
|
|
113
|
+
Agent assets are skills, rules, and commands exposed to AI hosts. They are not
|
|
114
|
+
the same as governed project docs.
|
|
115
|
+
|
|
116
|
+
Use this flow only from a full Project Governance System checkout that contains
|
|
117
|
+
`agent-assets/`; the public npm package excludes Yuanfei's private and
|
|
118
|
+
third-party skill bodies by design:
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
pro-gov assets discover --target /path/to/project --json
|
|
122
|
+
pro-gov assets recommend --target /path/to/project --json
|
|
123
|
+
pro-gov assets plan --target /path/to/project --bundle base-governance --host codex --out /tmp/pro-gov-asset-plan.json
|
|
124
|
+
pro-gov assets apply --plan /tmp/pro-gov-asset-plan.json
|
|
125
|
+
pro-gov assets check --target /path/to/project --json
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
The plan file is the safety gate. Review it before applying. It creates managed
|
|
129
|
+
symlinks and `.pro-gov/assets.lock.json`; it should not overwrite unmanaged
|
|
130
|
+
project files.
|
|
131
|
+
|
|
100
132
|
## Step 4: Add Starter Structure
|
|
101
133
|
|
|
102
134
|
Use `starter/` as the reference, but keep local facts local.
|
|
@@ -145,6 +177,10 @@ Add:
|
|
|
145
177
|
|
|
146
178
|
Do not add Superpowers TDD or Directed Development by default.
|
|
147
179
|
|
|
180
|
+
Ponytail is also optional. If it is installed, keep its global mode `off` and
|
|
181
|
+
activate it only for a bounded task or review after reading
|
|
182
|
+
`integrations/ponytail.md`.
|
|
183
|
+
|
|
148
184
|
## Step 6: Create Current Work
|
|
149
185
|
|
|
150
186
|
Create or update:
|
|
@@ -6,7 +6,7 @@ status: active
|
|
|
6
6
|
canonical: true
|
|
7
7
|
owner: human
|
|
8
8
|
created: 2026-06-09
|
|
9
|
-
last_reviewed: 2026-06-
|
|
9
|
+
last_reviewed: 2026-06-14
|
|
10
10
|
domain: adoption
|
|
11
11
|
tags:
|
|
12
12
|
- downstream
|
|
@@ -30,9 +30,12 @@ downstream projects.
|
|
|
30
30
|
## Registry Rules
|
|
31
31
|
|
|
32
32
|
- Update this file when a project adopts, leaves, renames, or changes profile.
|
|
33
|
+
- Keep only projects that currently exist and are expected to receive future
|
|
34
|
+
governance updates. Remove deleted or superseded projects instead of keeping
|
|
35
|
+
stale health rows.
|
|
33
36
|
- Treat package versions as the versions installed in the downstream project's
|
|
34
|
-
`package.json`.
|
|
35
|
-
|
|
37
|
+
`package.json`. Record both packages when the project has completed
|
|
38
|
+
package-based adoption.
|
|
36
39
|
- Treat health as a snapshot. A project can be on the latest version but still
|
|
37
40
|
have local working-tree cleanup in progress.
|
|
38
41
|
- Do not add a project-specific profile here unless at least two projects need
|
|
@@ -44,18 +47,21 @@ downstream projects.
|
|
|
44
47
|
|
|
45
48
|
## Current Downstream Projects
|
|
46
49
|
|
|
47
|
-
|
|
50
|
+
The current downstream set was checked on 2026-06-14.
|
|
48
51
|
|
|
49
|
-
| Project | Local path | Profile | Installed doc-gov | Health snapshot | Notes |
|
|
50
|
-
| --- | --- | --- | --- | --- | --- |
|
|
51
|
-
|
|
|
52
|
-
|
|
|
53
|
-
|
|
|
54
|
-
|
|
|
55
|
-
|
|
|
56
|
-
|
|
|
57
|
-
|
|
|
58
|
-
|
|
|
52
|
+
| Project | Local path | Profile | Installed doc-gov | Installed pro-gov | Health snapshot | Notes |
|
|
53
|
+
| --- | --- | --- | --- | --- | --- | --- |
|
|
54
|
+
| Anvil | `/Users/yuanfei/PieAI/Anvil` | `engineering-runtime` | `0.3.3` | `0.3.3` | Healthy | `docs:check` passes with 0 warnings. Existing unrelated local writing work was preserved. |
|
|
55
|
+
| Collapse | `/Users/yuanfei/PieAI/Collapse` | `engineering-runtime` | `0.3.3` | `0.3.3` | Healthy | Adopted the thin placeholder-phase runtime profile. `docs:check` and the production build pass. |
|
|
56
|
+
| Non-Heroes | `/Users/yuanfei/PieAI/Non-Heroes` | `engineering-runtime` | `0.3.3` | `0.3.3` | Healthy | `docs:check` passes with 0 warnings. |
|
|
57
|
+
| PieAIStudio-Site | `/Users/yuanfei/PieAI/PieAIStudio-Site` | `engineering-runtime` | `0.3.3` | `0.3.3` | Healthy | `docs:check` passes with 0 warnings. Existing unrelated local skill links were preserved. |
|
|
58
|
+
| PieHQ | `/Users/yuanfei/PieAI/PieHQ` | `doc-only` | `0.3.3` | `0.3.3` | Healthy | `docs:check` passes with 0 warnings. |
|
|
59
|
+
| Sea | `/Users/yuanfei/PieAI/Sea` | `engineering-runtime` | `0.3.3` | `0.3.3` | Healthy | `docs:check` passes with 0 warnings across the large governed-doc set. |
|
|
60
|
+
| Show | `/Users/yuanfei/PieAI/Show` | `engineering-runtime` | `0.3.3` | `0.3.3` | Healthy | `docs:check` passes with 0 warnings. |
|
|
61
|
+
| SupaLuv | `/Users/yuanfei/PieAI/SupaLuv` | `engineering-runtime` | `0.3.3` | `0.3.3` | Healthy | Migrated from the vendored `doc-gov@0.2.0` copy. `docs:check` and `cloud:check` pass; unrelated local content work was preserved. |
|
|
62
|
+
| YaZu | `/Users/yuanfei/PieAI/YaZu` | `engineering-runtime` | `0.3.3` | `0.3.3` | Healthy | `docs:check` passes with 0 warnings. |
|
|
63
|
+
| TuringPact | `/Users/yuanfei/PieAI/TuringPact` | `engineering-runtime` | `0.3.3` | `0.3.3` | Healthy | Migrated the legacy `Docs/` system into current, completed, and archive layers. `docs:check` and `verify:web` pass. |
|
|
64
|
+
| ProjectLens | `/Users/yuanfei/PieAI/ProjectLens` | `doc-only` | `0.3.3` | `0.3.3` | Healthy | `docs:check` passes with 0 warnings. ProjectLens is a project-level audit workspace, not a runtime product. |
|
|
59
65
|
|
|
60
66
|
## Representative Examples
|
|
61
67
|
|
|
@@ -63,9 +69,6 @@ The `examples/` directory is not the full registry. It contains representative
|
|
|
63
69
|
case studies:
|
|
64
70
|
|
|
65
71
|
- `examples/non-heroes/example.md` for an engineering-runtime product.
|
|
66
|
-
- `examples/pieflow/example.md` for a complex app/runtime product.
|
|
67
|
-
- `examples/pieip/example.md` for a doc-only AI media / asset-governance
|
|
68
|
-
project.
|
|
69
72
|
|
|
70
73
|
Add a new example only when a project teaches a reusable adoption pattern that
|
|
71
74
|
the existing examples do not cover.
|
|
@@ -74,5 +77,9 @@ the existing examples do not cover.
|
|
|
74
77
|
|
|
75
78
|
- `Supa` is no longer tracked here because that project was renamed/replaced by
|
|
76
79
|
`Non-Heroes`.
|
|
80
|
+
- `story-creator` is no longer tracked because the repository was renamed and
|
|
81
|
+
replaced by `Anvil`.
|
|
82
|
+
- `PieFlow` and `PieIP` were removed from the current registry on 2026-06-14
|
|
83
|
+
because those projects were deleted.
|
|
77
84
|
- GitNexus is intentionally absent. It has been removed from the central system
|
|
78
85
|
and should not be reintroduced through downstream policy links.
|
|
@@ -32,8 +32,8 @@ The central repo owns the **engine**. Each project owns its **local product cont
|
|
|
32
32
|
| --- | --- |
|
|
33
33
|
| Status lifecycle, document types, SSOT, agents routing, CLI checks, templates | Project Governance System upstream repository |
|
|
34
34
|
| Non-Heroes product plans, runtime canon, product rules | Non-Heroes |
|
|
35
|
-
|
|
|
36
|
-
|
|
|
35
|
+
| TuringPact product truth, game runtime, commercial Gates | TuringPact |
|
|
36
|
+
| ProjectLens audit evidence and observer workflow | ProjectLens |
|
|
37
37
|
| Current downstream adoption list and health snapshot | `docs/reference/adoption/downstream-project-registry.md` |
|
|
38
38
|
|
|
39
39
|
## Naming And Checkout Paths
|
|
@@ -62,10 +62,10 @@ Not yet automatically.
|
|
|
62
62
|
Known downstream projects are listed in
|
|
63
63
|
`docs/reference/adoption/downstream-project-registry.md`.
|
|
64
64
|
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
65
|
+
Early downstream projects had local working copies because the system was born
|
|
66
|
+
inside active projects. This central repo is now the upstream source, and
|
|
67
|
+
downstream projects should use `@pieai/doc-gov`, `@pieai/pro-gov`, and their
|
|
68
|
+
selected profile instead of keeping private CLI or starter copies.
|
|
69
69
|
|
|
70
70
|
## Why Not Auto-Symlink Everything?
|
|
71
71
|
|
|
@@ -79,7 +79,8 @@ The old `governance/` folder mixed both kinds. The clearer split is:
|
|
|
79
79
|
- `docs/governance/` contains doc-system rules, SSOT, agents-routing, document types, templates, and manifest.
|
|
80
80
|
- `docs/policy/` contains project-local AI development policy, lane wording, proof commands, and truth hierarchy.
|
|
81
81
|
|
|
82
|
-
Symlinking or copying the whole policy layer would be wrong because
|
|
82
|
+
Symlinking or copying the whole policy layer would be wrong because different
|
|
83
|
+
projects need different local lane profiles. The safe rule:
|
|
83
84
|
|
|
84
85
|
- shared rules may be symlinked
|
|
85
86
|
- doc-gov core should become the installed validator package
|
|
@@ -104,7 +105,7 @@ Example:
|
|
|
104
105
|
- The generic fix is a `completed` lifecycle state.
|
|
105
106
|
- Therefore `completed` belongs in this repo's doc-gov core.
|
|
106
107
|
|
|
107
|
-
## How
|
|
108
|
+
## How Downstream Projects Upgrade
|
|
108
109
|
|
|
109
110
|
Use an explicit migration task:
|
|
110
111
|
|
|
@@ -6,7 +6,7 @@ status: stable
|
|
|
6
6
|
canonical: true
|
|
7
7
|
owner: human
|
|
8
8
|
created: 2026-06-04
|
|
9
|
-
last_reviewed: 2026-06-
|
|
9
|
+
last_reviewed: 2026-06-21
|
|
10
10
|
domain: adoption
|
|
11
11
|
tags:
|
|
12
12
|
- release
|
|
@@ -69,28 +69,55 @@ Before publishing:
|
|
|
69
69
|
- package dry-runs show only intended files
|
|
70
70
|
- publish `@pieai/doc-gov` before `@pieai/pro-gov` when both package versions
|
|
71
71
|
are new, because `pro-gov` depends on the matching validator release
|
|
72
|
-
-
|
|
72
|
+
- npm Trusted Publisher is configured for both packages
|
|
73
73
|
- registry is the official npm registry, not a mirror
|
|
74
74
|
- scoped publish uses public access
|
|
75
75
|
|
|
76
|
-
Recommended
|
|
76
|
+
Recommended local verification:
|
|
77
77
|
|
|
78
78
|
```bash
|
|
79
|
-
npm whoami --registry https://registry.npmjs.org/
|
|
80
|
-
|
|
81
79
|
pnpm --filter @pieai/doc-gov pack --dry-run
|
|
82
80
|
pnpm --filter @pieai/pro-gov pack --dry-run
|
|
81
|
+
```
|
|
83
82
|
|
|
84
|
-
|
|
85
|
-
npm view @pieai/doc-gov version --registry https://registry.npmjs.org/
|
|
83
|
+
Recommended publish command:
|
|
86
84
|
|
|
87
|
-
|
|
88
|
-
|
|
85
|
+
```bash
|
|
86
|
+
gh workflow run npm-publish.yml --ref main
|
|
89
87
|
```
|
|
90
88
|
|
|
91
89
|
Important: do not claim an npm package is live until its `npm view <package>
|
|
92
90
|
version` command resolves from the public registry.
|
|
93
91
|
|
|
92
|
+
## Trusted Publishing Setup
|
|
93
|
+
|
|
94
|
+
npm publishing should use Trusted Publishing through GitHub Actions. This is the
|
|
95
|
+
smooth path: GitHub Actions proves to npm that a specific workflow in this
|
|
96
|
+
repository is publishing the package, so maintainers do not need to pass a
|
|
97
|
+
long-lived npm token around.
|
|
98
|
+
|
|
99
|
+
Set this once for each package on npmjs.com:
|
|
100
|
+
|
|
101
|
+
1. Open the package settings for `@pieai/doc-gov`.
|
|
102
|
+
2. Add a Trusted Publisher for GitHub Actions:
|
|
103
|
+
- owner: `PieAIStudio`
|
|
104
|
+
- repository: `ProjectGovernanceSystem`
|
|
105
|
+
- workflow file: `npm-publish.yml`
|
|
106
|
+
- allowed action: `npm publish`
|
|
107
|
+
3. Repeat the same setup for `@pieai/pro-gov`.
|
|
108
|
+
4. Keep the workflow as manual `workflow_dispatch` until several releases have
|
|
109
|
+
succeeded.
|
|
110
|
+
|
|
111
|
+
The workflow must keep:
|
|
112
|
+
|
|
113
|
+
- `permissions.id-token: write`
|
|
114
|
+
- a GitHub-hosted runner
|
|
115
|
+
- npm CLI `11.5.1` or newer
|
|
116
|
+
- package `repository` fields that match the public GitHub repository
|
|
117
|
+
- `pnpm pack` before publish, so workspace dependencies are converted in the
|
|
118
|
+
tarball
|
|
119
|
+
- `npm publish <tarball> --provenance --access public`
|
|
120
|
+
|
|
94
121
|
## After Release
|
|
95
122
|
|
|
96
123
|
After GitHub and npm are live:
|
|
@@ -101,23 +128,3 @@ After GitHub and npm are live:
|
|
|
101
128
|
- update downstream projects only through an explicit sync task
|
|
102
129
|
- update public website copy from the current README and this checklist, not
|
|
103
130
|
from stale chat history
|
|
104
|
-
|
|
105
|
-
## Future: Trusted Publishing
|
|
106
|
-
|
|
107
|
-
The first release may be published from a logged-in maintainer machine. Future
|
|
108
|
-
releases should move to npm Trusted Publishing through GitHub Actions.
|
|
109
|
-
|
|
110
|
-
Recommended future setup:
|
|
111
|
-
|
|
112
|
-
1. On npmjs.com, open the package settings for `@pieai/doc-gov` and
|
|
113
|
-
`@pieai/pro-gov`.
|
|
114
|
-
2. Add a Trusted Publisher for GitHub Actions to each package:
|
|
115
|
-
- owner: `PieAIStudio`
|
|
116
|
-
- repository: `ProjectGovernanceSystem` (GitHub slug)
|
|
117
|
-
- workflow file: `npm-publish.yml`
|
|
118
|
-
3. Keep the workflow as manual `workflow_dispatch` until the first trusted
|
|
119
|
-
publishing run succeeds.
|
|
120
|
-
4. After that, optionally add a release-tag trigger such as `v0.3.1`.
|
|
121
|
-
|
|
122
|
-
Trusted Publishing gives npm a verifiable GitHub build origin and avoids
|
|
123
|
-
long-lived npm tokens.
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: REF-RECOMMENDED-AGENT-TOOLING
|
|
3
|
+
title: Recommended Agent Tooling
|
|
4
|
+
type: reference
|
|
5
|
+
status: stable
|
|
6
|
+
canonical: true
|
|
7
|
+
owner: human
|
|
8
|
+
created: 2026-06-21
|
|
9
|
+
last_reviewed: 2026-06-21
|
|
10
|
+
domain: adoption
|
|
11
|
+
tags:
|
|
12
|
+
- adoption
|
|
13
|
+
- tooling
|
|
14
|
+
- superpowers
|
|
15
|
+
- ponytail
|
|
16
|
+
pinned: false
|
|
17
|
+
related:
|
|
18
|
+
- REF-ADOPTION-PLAYBOOK
|
|
19
|
+
- POLICY-DESIGN-PRINCIPLES
|
|
20
|
+
- POLICY-SYNC-STRATEGY
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
# Recommended Agent Tooling
|
|
24
|
+
|
|
25
|
+
This page separates what a project needs from what may help it.
|
|
26
|
+
|
|
27
|
+
## The Beginner Version
|
|
28
|
+
|
|
29
|
+
Imagine a school workshop:
|
|
30
|
+
|
|
31
|
+
- PGS labels the shelves, routes each job, and checks that the record is complete.
|
|
32
|
+
- Superpowers gives the class a reliable build-and-test routine.
|
|
33
|
+
- Ponytail is the adviser who asks, "Can we make this with fewer unnecessary
|
|
34
|
+
parts?"
|
|
35
|
+
|
|
36
|
+
Installing every tool does not mean every tool should run all the time.
|
|
37
|
+
|
|
38
|
+
## Recommendation Table
|
|
39
|
+
|
|
40
|
+
| Tool | Recommendation | Best fit | Default behavior |
|
|
41
|
+
| --- | --- | --- | --- |
|
|
42
|
+
| `@pieai/pro-gov` | Required for package-based PGS adoption | Projects adopting PGS starter/profile assets | Use its read-only discovery, init, sync, doctor, and Lens commands. |
|
|
43
|
+
| `@pieai/doc-gov` | Required for package-based PGS adoption | All governed PGS projects | Run document, router, manifest, link, hook, and CI checks. |
|
|
44
|
+
| Superpowers | Recommended for engineering/runtime projects | Apps, games, services, browser products, and other code-heavy work | Use the matching workflow when the selected PGS lane requires it. |
|
|
45
|
+
| Ponytail | Recommended as an installed, optional adviser | Projects that need help resisting unnecessary complexity | Keep the global mode `off`; activate it explicitly for a bounded task or review. |
|
|
46
|
+
|
|
47
|
+
## Superpowers
|
|
48
|
+
|
|
49
|
+
Superpowers owns engineering workflow discipline:
|
|
50
|
+
|
|
51
|
+
- brainstorming before creative implementation;
|
|
52
|
+
- implementation plans;
|
|
53
|
+
- test-driven development;
|
|
54
|
+
- systematic debugging;
|
|
55
|
+
- verification before completion;
|
|
56
|
+
- isolated worktree usage.
|
|
57
|
+
|
|
58
|
+
PGS routes the task first. Superpowers then runs inside the selected lane.
|
|
59
|
+
|
|
60
|
+
Engineering/runtime projects usually benefit from Superpowers. Doc-only
|
|
61
|
+
projects should not inherit the full engineering ceremony unless their current
|
|
62
|
+
task actually involves runtime or code behavior.
|
|
63
|
+
|
|
64
|
+
Read `integrations/superpowers.md` for the exact boundary.
|
|
65
|
+
|
|
66
|
+
## Ponytail
|
|
67
|
+
|
|
68
|
+
Ponytail advises the AI to prefer smaller, less speculative solutions. That can
|
|
69
|
+
reduce unnecessary code, files, dependencies, and abstractions.
|
|
70
|
+
|
|
71
|
+
Keep its global mode `off`. When a low-risk task needs a simplicity comparison,
|
|
72
|
+
test `lite` in an isolated session first. Use `full` only as an optional stress
|
|
73
|
+
test after checking that requirements, tests, verification, security,
|
|
74
|
+
accessibility, and durable evidence remain intact.
|
|
75
|
+
|
|
76
|
+
Ponytail is not a replacement for PGS or Superpowers. Shorter work is valuable
|
|
77
|
+
only when it is still the complete, proven work the project asked for.
|
|
78
|
+
|
|
79
|
+
Read `integrations/ponytail.md` for the mode policy and comparison protocol.
|
|
80
|
+
|
|
81
|
+
## A Practical Default
|
|
82
|
+
|
|
83
|
+
For an engineering/runtime project:
|
|
84
|
+
|
|
85
|
+
```text
|
|
86
|
+
install PGS packages
|
|
87
|
+
-> keep Superpowers available for engineering workflows
|
|
88
|
+
-> install Ponytail but keep global mode off
|
|
89
|
+
-> activate Ponytail only when a bounded simplicity review would help
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
For a doc-only project:
|
|
93
|
+
|
|
94
|
+
```text
|
|
95
|
+
install PGS packages
|
|
96
|
+
-> use doc-only routing and evidence rules
|
|
97
|
+
-> add engineering workflow tools only for a real engineering task
|
|
98
|
+
-> keep Ponytail optional and off by default
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
## What PGS Does Not Do
|
|
102
|
+
|
|
103
|
+
PGS does not automatically install, enable, update, or remove these external
|
|
104
|
+
plugins in another person's AI host. It documents the recommended boundary and
|
|
105
|
+
lets each project or user adopt tools deliberately.
|
|
106
|
+
|
|
@@ -25,19 +25,20 @@ System as a public project page.
|
|
|
25
25
|
|
|
26
26
|
## Public Positioning
|
|
27
27
|
|
|
28
|
-
Project Governance System
|
|
29
|
-
|
|
28
|
+
Project Governance System keeps long-running AI-assisted projects understandable
|
|
29
|
+
and governable.
|
|
30
30
|
|
|
31
31
|
Beginner-friendly description:
|
|
32
32
|
|
|
33
|
-
>
|
|
34
|
-
>
|
|
35
|
-
>
|
|
36
|
-
>
|
|
37
|
-
> when old documents should retire.
|
|
33
|
+
> AI can create plans, specifications, rules, and reports faster than people can
|
|
34
|
+
> organize them. Project Governance System is the librarian, traffic desk, and
|
|
35
|
+
> inspection machine: it keeps current truth easy to find, sends each task down
|
|
36
|
+
> the right route, and checks that important project evidence is still connected.
|
|
38
37
|
|
|
39
38
|
## What To Emphasize
|
|
40
39
|
|
|
40
|
+
- It reduces the cognitive load of returning to an AI-assisted project after
|
|
41
|
+
days, weeks, or many different AI sessions.
|
|
41
42
|
- It keeps AI-generated specs, plans, decisions, references, and routing rules
|
|
42
43
|
from becoming unmanaged clutter.
|
|
43
44
|
- It separates central governance rules from project-local truth.
|
|
@@ -46,13 +47,18 @@ Beginner-friendly description:
|
|
|
46
47
|
checks, router integrity, health checks, and read-only migration checks.
|
|
47
48
|
- It provides `pro-gov` commands for packaged starter/profile assets,
|
|
48
49
|
read-only init planning, read-only sync checks, and package health checks.
|
|
49
|
-
- It
|
|
50
|
-
|
|
50
|
+
- It includes ProjectLens-style read-only inspection and a governed local agent
|
|
51
|
+
asset registry without publishing private or third-party skill bodies.
|
|
52
|
+
- It works with external workflow systems instead of replacing them:
|
|
53
|
+
Superpowers owns engineering process, while Ponytail may act as an optional
|
|
54
|
+
complexity adviser with global mode `off`.
|
|
51
55
|
|
|
52
56
|
## Do Not Overclaim
|
|
53
57
|
|
|
54
58
|
- Do not say it replaces Git.
|
|
55
59
|
- Do not say it replaces Superpowers.
|
|
60
|
+
- Do not say it requires or automatically enables Ponytail.
|
|
61
|
+
- Do not promise a fixed percentage reduction in code, tokens, time, or cost.
|
|
56
62
|
- Do not say it automatically migrates every project.
|
|
57
63
|
- Do not imply product prompts, generated media, or runtime assets must move
|
|
58
64
|
under `docs/**`.
|
|
@@ -70,11 +76,13 @@ Use the central repo's README.md, packages/doc-gov/README.md,
|
|
|
70
76
|
packages/pro-gov/README.md, docs/reference/adoption/public-release-checklist.md,
|
|
71
77
|
and docs/reference/adoption/site-publication-brief.md as source material.
|
|
72
78
|
|
|
73
|
-
Position it for normal readers as
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
79
|
+
Position it for normal readers as the system that keeps long-running AI-assisted
|
|
80
|
+
projects understandable and governable. Lead with the pain: AI creates useful
|
|
81
|
+
plans, specs, rules, and evidence faster than people can organize and retire
|
|
82
|
+
them. Use the librarian, traffic desk, and inspection-machine analogy before
|
|
83
|
+
technical package details. Explain how it fits next to Git, AGENTS.md,
|
|
84
|
+
Superpowers, optional Ponytail advice, pro-gov starter/profile distribution,
|
|
85
|
+
ProjectLens inspection, and project-local product truth.
|
|
78
86
|
|
|
79
87
|
Keep the copy confident but accurate. Do not claim automatic migration or
|
|
80
88
|
full replacement of existing workflow tools. npm publication is live, so include
|