Released docs. You are viewing the documentation published with v0.20.1. Development docs are available at Latest.
evidencectl request prepare command reference
Prepare the request, authorization header, and verification context.
Contract status
Section titled “Contract status”This page is generated from the public Clap command tree. Hidden implementation commands are omitted.
evidencectl request prepare [OPTIONS] --purpose <PURPOSE> --name <NAME> <--subject <SUBJECT>|--subjects-file <PATH>> <QUESTION>Constraints
Section titled “Constraints”| Condition | Requirement |
|---|---|
| Command invocation | Exactly one of --subject <SUBJECT>, --subjects-file <PATH> is required. |
Arguments
Section titled “Arguments”| Argument | Always required | Default | Values | Environment | Description |
|---|---|---|---|---|---|
<QUESTION> | Yes | n/a | n/a | n/a | Question defined by the active local project |
Options
Section titled “Options”| Option | Always required | Repeatable | Default | Values | Environment | Description |
|---|---|---|---|---|---|---|
--purpose <PURPOSE> | Yes | No | n/a | n/a | n/a | Exact purpose declared by the question |
--subject <SUBJECT> | No | Yes | n/a | n/a | n/a | Subject selector. Repeat role:field=value for a multi-subject question |
--subjects-file <PATH> | No | No | n/a | n/a | n/a | Owner-only JSON file containing the complete subject selector set |
--name <NAME> | Yes | No | n/a | n/a | n/a | Safe name for this retained request |
--client <CLIENT> | No | No | n/a | n/a | n/a | Registered local application used to request authorization |
--format <FORMAT> | No | No | signed-jws | signed-jws, sd-jwt-vc | n/a | Response format to request and verify |
-h, --help | No | No | n/a | n/a | n/a | Print help |
Generation contract
Section titled “Generation contract”Run npm run generate from docs/site after changing a public command, argument, option, default, environment binding, or help description.