@pieai/pro-gov 0.3.7 → 0.3.8

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.
@@ -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` and `sync` are read-only in the first release. They report planned files,
30
- missing files, or changed files, but they do not overwrite target projects.
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's control repository. PGS provides the format and commands; it does
58
- not publish a real user's private downstream project list.
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 sync --check
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
  ```