docs: fix trust level taxonomy, add missing CLI commands (P1-2, P1-11, P2-13)#68
Merged
docs: fix trust level taxonomy, add missing CLI commands (P1-2, P1-11, P2-13)#68
Conversation
…, P2-13) - Fix trust levels from SS/DV/OV/EV/CV to SS/REG/DV/OV/EV per RFC-002 - Fix badge keep flags (--agent-id, remove stale --sub/--iss, mark --ca/--api-key as working) - Add missing commands: badge request, badge dv, envelope (all subcommands), policy (validate/context) - Fix Go version in workspace example (1.24.0 → 1.25.9) Ref: DOCS_REMEDIATION_PLAN P1-2, P1-11, P2-13
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates project documentation to align trust-level taxonomy and CLI reference with current capiscio command set and flags (including newly documented subcommands).
Changes:
- Correct trust level naming/mapping (SS/REG/DV/OV/EV) in README and CLI reference.
- Expand
docs/reference/cli.mdto document additional CLI commands/subcommands (badge request,badge dv,envelope,policy) and update existing command options. - Update the README
go.workexample Go version to match the repository toolchain version.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
docs/reference/cli.md |
Fixes trust-level wording and updates/extends CLI command documentation (badge/envelope/policy). |
README.md |
Updates trust-level taxonomy mentions and refreshes the go.work Go version example. |
| - `--domain <string>`: Agent domain (optional). | ||
| - `--exp <duration>`: Expiration duration (default 5m). | ||
| - `--key <path>`: Path to private key file (required for `--self-sign`). | ||
| - `--level <0-4>`: Trust level: 0 (SS), 1 (REG), 2 (DV), 3 (OV), 4 (EV) per RFC-002 (default "1"). |
Member
Author
There was a problem hiding this comment.
Fixed in 3d0d3c2 — updated to <1-4> with a note that level 0 (SS) is implied by --self-sign.
| - `--subject <did>`: Subject DID (required). | ||
| - `--capability <string>`: Capability class (must be within parent scope). | ||
| - `--depth <int>`: Delegation depth remaining (must be less than parent). | ||
| - `--key <path>`: Path to issuer private key file (JWK). |
Member
Author
There was a problem hiding this comment.
These flags (--issuer and --badge-jti) are already present in the file at lines 380–381 — they were included in the original commit. The reviewer may have been looking at a cached version of the diff.
Address review comment: Level 0 (SS) is implied by --self-sign, CLI help only documents 1-4 for CA mode. Added clarifying note.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fix trust level taxonomy across README and CLI reference. Add missing command documentation for
envelope,policy,badge request, andbadge dv.Documentation Audit Reference
Phase: P1-2, P1-11, P2-13
Severity: High
Changes
README.md: Fix trust level table (SS/DV/OV/EV/CV → SS/REG/DV/OV/EV per RFC-002 and actual CLI)README.md: Fix go.work example Go version (1.24.0 → 1.25.9)docs/reference/cli.md: Fixbadge issuelevel descriptiondocs/reference/cli.md: Fixbadge keepflags (add --agent-id, remove stale --sub/--iss)docs/reference/cli.md: Addbadge requestcommand (RFC-003 PoP)docs/reference/cli.md: Addbadge dvcommand (ACME-Lite DV orders)docs/reference/cli.md: Addenvelopecommand with all subcommands (RFC-008)docs/reference/cli.md: Addpolicycommand with validate/context subcommandsVerification
go run ./cmd/capiscio <cmd> --help0=SS, 1=REG, 2=DV, 3=OV, 4=EV