Commit 4baf628
authored
docs: comprehensive CLI documentation audit and fixes (#12)
* docs: comprehensive CLI reference update to match implementation
- Remove non-existent 'rpc' command (gRPC server auto-starts via SDK)
- Update badge issue flags: add --self-sign, --level, --aud
- Update badge verify flags: add --offline, --audience, --skip-revocation, --skip-agent-status, --trusted-issuers
- Update badge keep flags to match actual CLI
- Add trust command section (add/list/remove)
- Fix default values to match actual defaults (5m exp instead of 1h)
- Add Node.js wrapper commands to wrapper section
- Update gRPC section to explain auto-start behavior and list all 7 services
- Update verification date to 2025-12-26
* docs: comprehensive CLI documentation audit and fixes
BREAKING CHANGES in documentation:
- capiscio keygen → capiscio key gen (command doesn't exist)
- capiscio badge sign → capiscio badge issue (command doesn't exist)
- capiscio badge revoke → Registry API (command doesn't exist)
- capiscio rpc → auto-managed by SDK (command doesn't exist)
- --accept-self-signed → --offline (flag doesn't exist)
- --output → --out-priv/--out-pub (flag doesn't exist)
Fixed files:
- docs/getting-started/index.md: key gen command, prerequisites table
- docs/identity/index.md: key gen command, file extensions (.jwk not .pem)
- docs/trust/index.md: badge issue/request commands, revocation via API
- docs/index.md: key gen and badge issue commands
- docs/reference/cli/index.md: badge issue examples
- docs/reference/grpc.md: removed non-existent CLI Usage section
- docs/reference/wrappers/node.md: badge verify flags
- docs/how-to/security/badgeserify flags
- docs/concepts/trust-model.md: --offline flag reference
Verified against: capiscio-core v2.2.0 --help output
Audit date: 2025-12-261 parent 9d35376 commit 4baf628
9 files changed
Lines changed: 191 additions & 124 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
184 | 184 | | |
185 | 185 | | |
186 | 186 | | |
187 | | - | |
| 187 | + | |
188 | 188 | | |
189 | 189 | | |
190 | 190 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
31 | | - | |
| 31 | + | |
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
| |||
101 | 101 | | |
102 | 102 | | |
103 | 103 | | |
104 | | - | |
| 104 | + | |
105 | 105 | | |
106 | 106 | | |
107 | 107 | | |
| |||
112 | 112 | | |
113 | 113 | | |
114 | 114 | | |
115 | | - | |
| 115 | + | |
116 | 116 | | |
117 | 117 | | |
118 | 118 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
144 | 144 | | |
145 | 145 | | |
146 | 146 | | |
147 | | - | |
| 147 | + | |
148 | 148 | | |
149 | | - | |
150 | | - | |
| 149 | + | |
| 150 | + | |
151 | 151 | | |
152 | 152 | | |
153 | 153 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
46 | 46 | | |
47 | 47 | | |
48 | 48 | | |
49 | | - | |
| 49 | + | |
50 | 50 | | |
51 | 51 | | |
52 | 52 | | |
| |||
55 | 55 | | |
56 | 56 | | |
57 | 57 | | |
58 | | - | |
59 | | - | |
| 58 | + | |
| 59 | + | |
60 | 60 | | |
61 | 61 | | |
62 | 62 | | |
| |||
66 | 66 | | |
67 | 67 | | |
68 | 68 | | |
69 | | - | |
| 69 | + | |
70 | 70 | | |
71 | 71 | | |
72 | 72 | | |
73 | 73 | | |
74 | 74 | | |
75 | 75 | | |
76 | | - | |
77 | | - | |
| 76 | + | |
| 77 | + | |
78 | 78 | | |
79 | 79 | | |
80 | 80 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
200 | 200 | | |
201 | 201 | | |
202 | 202 | | |
203 | | - | |
| 203 | + | |
204 | 204 | | |
205 | 205 | | |
206 | 206 | | |
| |||
214 | 214 | | |
215 | 215 | | |
216 | 216 | | |
217 | | - | |
218 | | - | |
| 217 | + | |
| 218 | + | |
219 | 219 | | |
220 | 220 | | |
221 | 221 | | |
| |||
0 commit comments