primary.md
1 # Primary Commands 2 3 ## auths init 4 5 ```bash 6 auths init 7 ``` 8 9 <!-- BEGIN GENERATED: auths init --> 10 Set up your cryptographic identity and Git signing 11 12 <div class="flags-container"> 13 <input type="checkbox" id="flags---non-interactive" class="flags-state"> 14 <table> 15 <thead><tr><th>Flag</th><th>Default</th><th>Description</th></tr></thead> 16 <tbody> 17 <tr><td><code>--non-interactive</code></td><td>—</td><td>Skip interactive prompts and use sensible defaults</td></tr> 18 <tr><td><code>--profile <PROFILE></code></td><td>—</td><td>Preset profile: developer, ci, or agent</td></tr> 19 <tr><td><code>--key-alias <KEY_ALIAS></code></td><td><code>main</code></td><td>Key alias for the identity key (default: main)</td></tr> 20 <tr><td><code>--force</code></td><td>—</td><td>Force overwrite if identity already exists</td></tr> 21 <tr><td><code>--dry-run</code></td><td>—</td><td>Preview agent configuration without creating files or identities</td></tr> 22 </tbody> 23 <tbody class="flags-overflow"> 24 <tr><td><code>--registry <REGISTRY></code></td><td><code>https://auths-registry.fly.dev</code></td><td>Registry URL for automatic identity registration</td></tr> 25 <tr><td><code>--skip-registration</code></td><td>—</td><td>Skip automatic registry registration during setup</td></tr> 26 <tr><td><code>--json</code></td><td>—</td><td>Emit machine-readable JSON</td></tr> 27 <tr><td><code>-q, --quiet</code></td><td>—</td><td>Suppress non-essential output</td></tr> 28 <tr><td><code>--repo <REPO></code></td><td>—</td><td>Override the local storage directory (default: ~/.auths)</td></tr> 29 </tbody> 30 </table> 31 <label for="flags---non-interactive" class="flags-toggle"><span class="flags-show">Show all flags</span><span class="flags-hide">Show less</span></label> 32 </div> 33 <!-- END GENERATED: auths init --> 34 35 --- 36 37 ## auths sign 38 39 ```bash 40 auths sign <TARGET> 41 ``` 42 43 <!-- BEGIN GENERATED: auths sign --> 44 Sign a Git commit or artifact file. 45 46 <div class="flags-container"> 47 <input type="checkbox" id="flags-TARGET" class="flags-state"> 48 <table> 49 <thead><tr><th>Flag</th><th>Default</th><th>Description</th></tr></thead> 50 <tbody> 51 <tr><td><code><TARGET></code></td><td>—</td><td>Commit ref, range, or artifact file path</td></tr> 52 <tr><td><code>--sig-output <PATH></code></td><td>—</td><td>Output path for the signature file. Defaults to <FILE>.auths.json</td></tr> 53 <tr><td><code>--identity-key-alias <IDENTITY_KEY_ALIAS></code></td><td>—</td><td>Local alias of the identity key (for artifact signing)</td></tr> 54 <tr><td><code>--device-key-alias <DEVICE_KEY_ALIAS></code></td><td>—</td><td>Local alias of the device key (for artifact signing, required for files)</td></tr> 55 <tr><td><code>--expires-in-days <N></code></td><td>—</td><td>Number of days until the signature expires (for artifact signing) [aliases: --days]</td></tr> 56 </tbody> 57 <tbody class="flags-overflow"> 58 <tr><td><code>--note <NOTE></code></td><td>—</td><td>Optional note to embed in the attestation (for artifact signing)</td></tr> 59 <tr><td><code>--json</code></td><td>—</td><td>Emit machine-readable JSON</td></tr> 60 <tr><td><code>-q, --quiet</code></td><td>—</td><td>Suppress non-essential output</td></tr> 61 <tr><td><code>--repo <REPO></code></td><td>—</td><td>Override the local storage directory (default: ~/.auths)</td></tr> 62 </tbody> 63 </table> 64 <label for="flags-TARGET" class="flags-toggle"><span class="flags-show">Show all flags</span><span class="flags-hide">Show less</span></label> 65 </div> 66 <!-- END GENERATED: auths sign --> 67 68 --- 69 70 ## auths verify 71 72 ```bash 73 auths verify 74 ``` 75 76 <!-- BEGIN GENERATED: auths verify --> 77 Verify a signed commit or attestation. 78 79 <div class="flags-container"> 80 <input type="checkbox" id="flags---allowed-signersALLOWEDSIGNERS" class="flags-state"> 81 <table> 82 <thead><tr><th>Flag</th><th>Default</th><th>Description</th></tr></thead> 83 <tbody> 84 <tr><td><code>--allowed-signers <ALLOWED_SIGNERS></code></td><td><code>.auths/allowed_signers</code></td><td>Path to allowed signers file (commit verification)</td></tr> 85 <tr><td><code>--identity-bundle <IDENTITY_BUNDLE></code></td><td>—</td><td>Path to identity bundle JSON (for CI/CD stateless commit verification)</td></tr> 86 <tr><td><code>--issuer-pk <ISSUER_PK></code></td><td>—</td><td>Issuer public key in hex format (attestation verification)</td></tr> 87 <tr><td><code>--issuer-did <ISSUER_DID></code></td><td>—</td><td>Issuer identity ID for attestation trust-based key resolution [aliases: --issuer]</td></tr> 88 <tr><td><code>--witness-receipts <WITNESS_RECEIPTS></code></td><td>—</td><td>Path to witness receipts JSON file</td></tr> 89 </tbody> 90 <tbody class="flags-overflow"> 91 <tr><td><code>--witness-threshold <WITNESS_THRESHOLD></code></td><td><code>1</code></td><td>Witness quorum threshold</td></tr> 92 <tr><td><code>--witness-keys <WITNESS_KEYS>...</code></td><td>—</td><td>Witness public keys as DID:hex pairs</td></tr> 93 <tr><td><code>--json</code></td><td>—</td><td>Emit machine-readable JSON</td></tr> 94 <tr><td><code>-q, --quiet</code></td><td>—</td><td>Suppress non-essential output</td></tr> 95 <tr><td><code>--repo <REPO></code></td><td>—</td><td>Override the local storage directory (default: ~/.auths)</td></tr> 96 </tbody> 97 </table> 98 <label for="flags---allowed-signersALLOWEDSIGNERS" class="flags-toggle"><span class="flags-show">Show all flags</span><span class="flags-hide">Show less</span></label> 99 </div> 100 <!-- END GENERATED: auths verify --> 101 102 --- 103 104 ## auths status 105 106 ```bash 107 auths status 108 ``` 109 110 <!-- BEGIN GENERATED: auths status --> 111 Show identity and agent status overview 112 113 <table> 114 <thead><tr><th>Flag</th><th>Default</th><th>Description</th></tr></thead> 115 <tbody> 116 <tr><td><code>--json</code></td><td>—</td><td>Emit machine-readable JSON</td></tr> 117 <tr><td><code>-q, --quiet</code></td><td>—</td><td>Suppress non-essential output</td></tr> 118 <tr><td><code>--repo <REPO></code></td><td>—</td><td>Override the local storage directory (default: ~/.auths)</td></tr> 119 </tbody> 120 </table> 121 <!-- END GENERATED: auths status --> 122 123 --- 124 125 ## auths whoami 126 127 ```bash 128 auths whoami 129 ``` 130 131 <!-- BEGIN GENERATED: auths whoami --> 132 Show the current identity on this machine 133 134 <table> 135 <thead><tr><th>Flag</th><th>Default</th><th>Description</th></tr></thead> 136 <tbody> 137 <tr><td><code>--json</code></td><td>—</td><td>Emit machine-readable JSON</td></tr> 138 <tr><td><code>-q, --quiet</code></td><td>—</td><td>Suppress non-essential output</td></tr> 139 <tr><td><code>--repo <REPO></code></td><td>—</td><td>Override the local storage directory (default: ~/.auths)</td></tr> 140 </tbody> 141 </table> 142 <!-- END GENERATED: auths whoami --> 143 144 --- 145 146 ## auths tutorial 147 148 ```bash 149 auths tutorial 150 ``` 151 152 <!-- BEGIN GENERATED: auths tutorial --> 153 Interactive tutorial for learning Auths concepts 154 155 <div class="flags-container"> 156 <input type="checkbox" id="flags--s--skipSECTION" class="flags-state"> 157 <table> 158 <thead><tr><th>Flag</th><th>Default</th><th>Description</th></tr></thead> 159 <tbody> 160 <tr><td><code>-s, --skip <SECTION></code></td><td>—</td><td>Skip to a specific section (1-6)</td></tr> 161 <tr><td><code>--reset</code></td><td>—</td><td>Reset progress and start from the beginning</td></tr> 162 <tr><td><code>--list</code></td><td>—</td><td>List all tutorial sections</td></tr> 163 <tr><td><code>--json</code></td><td>—</td><td>Emit machine-readable JSON</td></tr> 164 <tr><td><code>-q, --quiet</code></td><td>—</td><td>Suppress non-essential output</td></tr> 165 </tbody> 166 <tbody class="flags-overflow"> 167 <tr><td><code>--repo <REPO></code></td><td>—</td><td>Override the local storage directory (default: ~/.auths)</td></tr> 168 </tbody> 169 </table> 170 <label for="flags--s--skipSECTION" class="flags-toggle"><span class="flags-show">Show all flags</span><span class="flags-hide">Show less</span></label> 171 </div> 172 <!-- END GENERATED: auths tutorial --> 173 174 --- 175 176 ## auths doctor 177 178 ```bash 179 auths doctor 180 ``` 181 182 <!-- BEGIN GENERATED: auths doctor --> 183 Run comprehensive health checks 184 185 <table> 186 <thead><tr><th>Flag</th><th>Default</th><th>Description</th></tr></thead> 187 <tbody> 188 <tr><td><code>--json</code></td><td>—</td><td>Emit machine-readable JSON</td></tr> 189 <tr><td><code>-q, --quiet</code></td><td>—</td><td>Suppress non-essential output</td></tr> 190 <tr><td><code>--repo <REPO></code></td><td>—</td><td>Override the local storage directory (default: ~/.auths)</td></tr> 191 </tbody> 192 </table> 193 <!-- END GENERATED: auths doctor --> 194 195 --- 196 197 ## auths pair 198 199 ```bash 200 auths pair 201 ``` 202 203 <!-- BEGIN GENERATED: auths pair --> 204 Link devices to your identity 205 206 <div class="flags-container"> 207 <input type="checkbox" id="flags---joinCODE" class="flags-state"> 208 <table> 209 <thead><tr><th>Flag</th><th>Default</th><th>Description</th></tr></thead> 210 <tbody> 211 <tr><td><code>--join <CODE></code></td><td>—</td><td>Join an existing pairing session using a short code</td></tr> 212 <tr><td><code>--registry <URL></code></td><td>—</td><td>Registry URL for pairing relay (omit for LAN mode)</td></tr> 213 <tr><td><code>--timeout <SECONDS></code></td><td><code>300</code></td><td>Custom timeout in seconds for the pairing session (default: 300 = 5 minutes) [aliases: --expiry]</td></tr> 214 <tr><td><code>--json</code></td><td>—</td><td>Emit machine-readable JSON</td></tr> 215 <tr><td><code>-q, --quiet</code></td><td>—</td><td>Suppress non-essential output</td></tr> 216 </tbody> 217 <tbody class="flags-overflow"> 218 <tr><td><code>--repo <REPO></code></td><td>—</td><td>Override the local storage directory (default: ~/.auths)</td></tr> 219 </tbody> 220 </table> 221 <label for="flags---joinCODE" class="flags-toggle"><span class="flags-show">Show all flags</span><span class="flags-hide">Show less</span></label> 222 </div> 223 <!-- END GENERATED: auths pair -->