Skip to content

Commit 4baf628

Browse files
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-26
1 parent 9d35376 commit 4baf628

9 files changed

Lines changed: 191 additions & 124 deletions

File tree

docs/concepts/trust-model.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ Trust levels indicate the validation rigor applied during badge issuance:
184184
| **4** | Extended Validated (EV) | OV + manual security audit | CapiscIO CA | Regulated industries |
185185

186186
!!! warning "Level 0 in Production"
187-
Self-signed (Level 0) badges are for **development only**. In production, verifiers should reject Level 0 badges by default. Use `--accept-self-signed` (CLI) or `accept_self_signed=True` (SDK) to explicitly opt in during development.
187+
Self-signed (Level 0) badges are for **development only**. In production, verifiers should reject Level 0 badges by default. Use `--offline` (CLI) for trust store verification, or `accept_self_signed=True` (SDK) to explicitly opt in during development.
188188

189189
### DID Methods by Level
190190

docs/getting-started/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ npm install -g capiscio # or: pip install capiscio
2828
Generate a DID for your agent in 60 seconds.
2929

3030
```bash
31-
capiscio keygen
31+
capiscio key gen
3232
```
3333

3434
[:octicons-arrow-right-24: Identity Guide](../identity/index.md)
@@ -101,7 +101,7 @@ EOF
101101
capiscio validate agent-card.json
102102
103103
# 4. Generate identity
104-
capiscio keygen --output ./capiscio_keys
104+
mkdir -p capiscio_keys && cd capiscio_keys && capiscio key gen && cd ..
105105
```
106106

107107
**Done!** You have a validated agent card and a cryptographic identity.
@@ -112,7 +112,7 @@ capiscio keygen --output ./capiscio_keys
112112

113113
| Path | Requirements |
114114
|------|--------------|
115-
| CLI (validate, keygen) | Node.js 18+ or Python 3.10+ |
115+
| CLI (validate, key gen) | Node.js 18+ or Python 3.10+ |
116116
| Python SDK (SimpleGuard) | Python 3.10+, FastAPI or similar |
117117
| CI/CD | GitHub repository |
118118

docs/how-to/security/badges.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,10 +144,10 @@ For development and testing, issue self-signed badges:
144144

145145
```bash
146146
# Issue a self-signed badge (Level 0)
147-
capiscio badge issue --self-sign > badge.jwt
147+
capiscio badge issue --self-sign --sub did:web:example.com:agents:test > badge.jwt
148148

149-
# Verify with explicit self-signed acceptance
150-
capiscio badge verify --accept-self-signed < badge.jwt
149+
# Verify offline (uses trust store)
150+
capiscio badge verify --offline < badge.jwt
151151
```
152152

153153
=== "Python SDK"

docs/identity/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ This DID:
4646
No registration needed. Generate a `did:key` identity locally:
4747

4848
```bash
49-
capiscio keygen --output ./capiscio_keys
49+
mkdir -p capiscio_keys && cd capiscio_keys && capiscio key gen && cd ..
5050
```
5151

5252
```
@@ -55,8 +55,8 @@ This DID:
5555
Your Agent DID: did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK
5656

5757
Files created:
58-
./capiscio_keys/private.pem (keep secret!)
59-
./capiscio_keys/public.pem
58+
./capiscio_keys/private.jwk (keep secret!)
59+
./capiscio_keys/public.jwk
6060
```
6161

6262
**Trust Level:** 0 (self-signed) — Great for development and testing.
@@ -66,15 +66,15 @@ This DID:
6666
Use `did:key` for development and self-signed badges:
6767

6868
```bash
69-
capiscio keygen
69+
capiscio key gen
7070
```
7171

7272
```
7373
✅ Keys generated!
7474

7575
DID: did:key:z6Mk...
76-
Private key: capiscio_keys/private.pem
77-
Public key: capiscio_keys/public.pem
76+
Private key: private.jwk
77+
Public key: public.jwk
7878

7979
Next: Use this DID in your agent card.
8080
```

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -200,7 +200,7 @@ We obsess over developer experience. Every feature works in **three commands or
200200
=== "Generate Identity"
201201

202202
```bash
203-
capiscio keygen
203+
capiscio key gen
204204
# ✅ did:key:z6Mk... generated
205205
```
206206

@@ -214,8 +214,8 @@ We obsess over developer experience. Every feature works in **three commands or
214214
=== "Issue Badge"
215215

216216
```bash
217-
capiscio badge sign --trust-level 2
218-
# ✅ Badge signed with private key
217+
capiscio badge issue --self-sign
218+
# ✅ Badge issued with did:key identity
219219
```
220220

221221
=== "Add to Your App"

0 commit comments

Comments
 (0)