@stackbilt/cli 0.1.8 → 0.1.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.
Files changed (2) hide show
  1. package/README.md +72 -19
  2. package/package.json +7 -7
package/README.md CHANGED
@@ -10,7 +10,8 @@ CLI entry point for Charter Kit -- a local-first governance toolkit for software
10
10
  npm install -g @stackbilt/cli
11
11
  ```
12
12
 
13
- This pulls in all Charter Kit packages automatically. You get the `charter` command globally.
13
+ This pulls in all Charter Kit packages automatically. You get the `charter` command globally.
14
+ Use `charter setup` inside each repo to scaffold governance baseline files.
14
15
 
15
16
  For CI pipelines, install as a dev dependency instead:
16
17
 
@@ -18,24 +19,76 @@ For CI pipelines, install as a dev dependency instead:
18
19
  npm install --save-dev @stackbilt/cli
19
20
  ```
20
21
 
21
- Requires Node >= 18.
22
-
23
- ## Quick Start
24
-
25
- ```bash
26
- charter setup # bootstrap .charter/ directory
27
- charter doctor # check CLI + config health
28
- charter validate # validate commit governance trailers
29
- charter drift # scan for blessed-stack drift
30
- charter audit # generate governance audit report
31
- charter classify "migrate auth provider"
32
- ```
22
+ Requires Node >= 18.
23
+
24
+ ## Quick Start
25
+
26
+ ```bash
27
+ charter # quick value/risk snapshot + next action
28
+ charter why # why teams adopt Charter and expected payoff
29
+ charter setup # bootstrap .charter/ directory + policy baseline
30
+ charter doctor # check CLI + config health
31
+ charter validate # validate commit governance trailers
32
+ charter drift # scan for blessed-stack drift
33
+ charter audit # generate governance audit report
34
+ charter classify "migrate auth provider"
35
+ ```
36
+
37
+ ## Human Onboarding (Copy/Paste)
38
+
39
+ Run this in the target repository:
40
+
41
+ ```bash
42
+ npm install -g @stackbilt/cli
43
+ charter
44
+ charter setup --ci github
45
+ charter doctor --format json
46
+ charter validate --format text
47
+ charter drift --format text
48
+ charter audit --format text
49
+ ```
50
+
51
+ This ensures people immediately see:
52
+ - what Charter is doing in their repo
53
+ - where baseline files were created (`.charter/*`)
54
+ - how policy checks behave before merge
55
+
56
+ ## LM Agent Onboarding (Deterministic)
57
+
58
+ Use JSON output and explicit CI semantics:
59
+
60
+ ```bash
61
+ charter --format json
62
+ charter setup --ci github --yes --format json
63
+ charter doctor --format json
64
+ charter validate --format json --ci
65
+ charter drift --format json --ci
66
+ charter audit --format json
67
+ ```
68
+
69
+ Agent handling contract:
70
+ - `exit 0`: pass
71
+ - `exit 1`: policy violation (action required)
72
+ - `exit 2`: runtime/usage failure
33
73
 
34
74
  ## Commands
35
75
 
36
- ### `charter setup`
37
-
38
- Bootstrap `.charter/` with config, patterns, and policies. Optionally generates a GitHub Actions workflow.
76
+ ### `charter` (no args)
77
+
78
+ Default first-run experience. Shows:
79
+ - repository governance baseline status
80
+ - commit governance coverage snapshot
81
+ - high-risk unlinked commit count
82
+ - one recommended next action
83
+
84
+ ### `charter why`
85
+
86
+ Explains the adoption case in plain terms (problem, what Charter enforces, expected operational payoff).
87
+
88
+ ### `charter setup`
89
+
90
+ Bootstrap `.charter/` with config, patterns, and policies. Optionally generates a GitHub Actions workflow.
91
+ This is the command that applies Charter governance into a repository.
39
92
 
40
93
  ```bash
41
94
  charter setup --ci github --yes
@@ -69,13 +122,13 @@ charter drift --path ./src --ci
69
122
 
70
123
  Generate a governance audit report covering trailers, risk, and drift.
71
124
 
72
- ### `charter classify`
125
+ ### `charter classify`
73
126
 
74
127
  Classify a change as `SURFACE`, `LOCAL`, or `CROSS_CUTTING`.
75
128
 
76
129
  ```bash
77
- charter classify "update button color"
78
- ```
130
+ charter classify "update button color"
131
+ ```
79
132
 
80
133
  ## Global Options
81
134
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stackbilt/cli",
3
- "version": "0.1.8",
3
+ "version": "0.1.9",
4
4
  "description": "Charter CLI — repo-level governance checks",
5
5
  "bin": {
6
6
  "charter": "./dist/bin.js"
@@ -37,12 +37,12 @@
37
37
  "build": "pnpm exec tsc -p tsconfig.json"
38
38
  },
39
39
  "dependencies": {
40
- "@stackbilt/types": "^0.1.3",
41
- "@stackbilt/core": "^0.1.3",
42
- "@stackbilt/git": "^0.1.4",
43
- "@stackbilt/classify": "^0.1.4",
44
- "@stackbilt/validate": "^0.1.4",
45
- "@stackbilt/drift": "^0.1.4"
40
+ "@stackbilt/types": "^0.1.9",
41
+ "@stackbilt/core": "^0.1.9",
42
+ "@stackbilt/git": "^0.1.9",
43
+ "@stackbilt/classify": "^0.1.9",
44
+ "@stackbilt/validate": "^0.1.9",
45
+ "@stackbilt/drift": "^0.1.9"
46
46
  },
47
47
  "license": "Apache-2.0"
48
48
  }