OXYGENHUB
◆ v0.6.0 oxygen / src / cli / mod.rs
59.5 KiB · Rust · last changed A tag can be withdrawn, by a signed withdrawal (oxygenhub#301) 11 days ago source blame history raw
fce44ae9 Andy McCall ↶ 1 
//! Command-line definitions and dispatch.
2
b582948f Andy McCall ↶ 3 
mod approve;
ff1f62fe Andy McCall ↶ 4 
mod auth;
fce44ae9 Andy McCall ↶ 5 
mod format;
75167672 Andy McCall 6 
mod identity;
c6aa5bd9 Andy McCall ↶ 7 
mod json;
d82e4409 Andy McCall ↶ 8 
mod proposal;
fc1a466a Andy McCall ↶ 9 
mod receipt;
fce44ae9 Andy McCall ↶ 10 
mod sync;
e59512f2 Andy McCall ↶ 11 
mod tlog;
135212de Andy McCall ↶ 12 
pub mod ui;
fce44ae9 Andy McCall ↶ 13 
mod workspace;
14
15 
use anyhow::{Context, Result};
16 
use clap::{Parser, Subcommand};
17 
use oxy_core::repo::Repo;
18 
use std::path::PathBuf;
19
20 
#[derive(Parser)]
75167672 Andy McCall 21 
#[command(
22 
    name = "oxy",
e293c90d Andy McCall ↶ 23 
    version = env!("OXY_VERSION_LONG"),
75167672 Andy McCall 24 
    about = "Oxygen: breathing fresh air into version control"
25 
)]
fce44ae9 Andy McCall ↶ 26 
struct Cli {
135212de Andy McCall ↶ 27 
    /// Plain output: no colour, no spinner (also implied by NO_COLOR or a non-terminal)
28 
    #[arg(long, global = true)]
29 
    plain: bool,
98a1620a Andy McCall ↶ 30 
    /// Read the repository as it was after operation OP (an ID from oxy op log, @ or @-); commands that would change it are refused
31 
    #[arg(long, global = true, value_name = "OP")]
32 
    at_op: Option<String>,
fce44ae9 Andy McCall ↶ 33 
    #[command(subcommand)]
34 
    cmd: Cmd,
35 
}
36
98a1620a Andy McCall ↶ 37 
/// `--at-op`, for `open` to apply.
38 
static AT_OP: std::sync::OnceLock<Option<String>> = std::sync::OnceLock::new();
39
fce44ae9 Andy McCall ↶ 40 
#[derive(Subcommand)]
41 
enum Cmd {
42 
    /// Create a repository in PATH (default: current directory)
e02bf0cd Andy McCall ↶ 43 
    Init {
d42369ab Andy McCall 44 
        /// Directory to create the repository in (default: the current directory)
e02bf0cd Andy McCall ↶ 45 
        path: Option<PathBuf>,
46 
        /// No working copy: an object store and references only, for hosting
47 
        #[arg(long)]
48 
        bare: bool,
d069701a Andy McCall ↶ 49 
        /// Keep the objects and the operation log on this store
50 
        /// (dir://PATH, s3://BUCKET/PREFIX, gs://…, az://…) instead of
51 
        /// in .oxy, with a local cache in front (storage.cache, 2 GiB)
52 
        #[arg(long, value_name = "URL")]
53 
        store: Option<String>,
e02bf0cd Andy McCall ↶ 54 
    },
fce44ae9 Andy McCall ↶ 55 
    /// Clone a repository from a local path or an http(s) URL
b3c5a59a Andy McCall ↶ 56 
    Clone {
d42369ab Andy McCall 57 
        /// Local path or http(s) URL of the repository
b3c5a59a Andy McCall ↶ 58 
        url: String,
d42369ab Andy McCall 59 
        /// Directory to clone into (default: the last part of the URL)
b3c5a59a Andy McCall ↶ 60 
        dest: Option<PathBuf>,
61 
        /// Leave blobs larger than this (e.g. 1M) to be fetched on first read
62 
        #[arg(long)]
63 
        max_blob: Option<String>,
7421309f Andy McCall ↶ 64 
        /// Materialize only these paths (repeatable); implies lazy blobs
65 
        #[arg(long = "sparse")]
66 
        sparse: Vec<String>,
2863456a Andy McCall ↶ 67 
        /// Shallow clone: fetch only this many levels of history below the heads
68 
        #[arg(long)]
69 
        depth: Option<u32>,
14edbaaf Andy McCall ↶ 70 
        /// Clone the subrepos too (as oxy submodule update --init)
71 
        #[arg(long)]
72 
        recursive: bool,
b3c5a59a Andy McCall ↶ 73 
    },
2863456a Andy McCall ↶ 74 
    /// Fetch more history below a shallow clone's boundary
75 
    Deepen {
d42369ab Andy McCall 76 
        /// Levels of history to add below the boundary
2863456a Andy McCall ↶ 77 
        #[arg(default_value_t = 10)]
78 
        depth: u32,
d42369ab Andy McCall 79 
        /// Remote to fetch the history from
2863456a Andy McCall ↶ 80 
        #[arg(long, default_value = "origin")]
81 
        remote: String,
82 
    },
7421309f Andy McCall ↶ 83 
    /// Show or set the sparse filter (paths to materialize); re-checks out the bookmark
d42369ab Andy McCall 84 
    Sparse {
85 
        /// Paths to materialize; none prints the current filter
86 
        paths: Vec<String>,
87 
    },
fce44ae9 Andy McCall ↶ 88 
    /// Show the working copy: changed paths and conflicts
50a046e4 Andy McCall ↶ 89 
    Status {
90 
        /// Machine-readable output: paths, and every conflict with its kind and contributing changes
91 
        #[arg(long)]
92 
        json: bool,
93 
    },
135212de Andy McCall ↶ 94 
    /// One-line summary for shell prompts; fast and records nothing
95 
    Prompt {
694805cc Andy McCall ↶ 96 
        /// Placeholders: %b bookmark, %c change id, %h heads, %d dirty (*), %x conflict (!), %A/%D ahead/behind (+n/-n), %a/%B raw counts, %s state glyph, %U/%O ahead/behind arrows, %i icon
135212de Andy McCall ↶ 97 
        #[arg(long, default_value = oxy_core::repo::DEFAULT_PROMPT_FORMAT)]
98 
        format: String,
694805cc Andy McCall ↶ 99 
        /// Glyph format (%i %b %c %s%U%O) instead of the plain default
100 
        #[arg(long)]
101 
        glyphs: bool,
102 
        /// Colour by state (cyan clean, yellow dirty, red conflicted): raw escapes, or guarded for a bash or zsh PS1
103 
        #[arg(long, value_parser = ["raw", "bash", "zsh"])]
104 
        color: Option<String>,
135212de Andy McCall ↶ 105 
    },
fce44ae9 Andy McCall ↶ 106 
    /// Record the working copy as a change on the current bookmark
107 
    Commit {
d42369ab Andy McCall 108 
        /// The change's message: a subject line, then optionally a blank line and a body
6a81dbab Andy McCall ↶ 109 
        #[arg(short, long, required_unless_present = "file", conflicts_with = "file")]
110 
        message: Option<String>,
111 
        /// Read the message from FILE (`-` for standard input)
112 
        #[arg(short = 'F', long, value_name = "FILE")]
113 
        file: Option<PathBuf>,
fce44ae9 Andy McCall ↶ 114 
        /// Extra explicit dependencies (ChangeId prefix, #hash prefix)
115 
        #[arg(long = "depends-on")]
116 
        depends_on: Vec<String>,
957fee30 Andy McCall ↶ 117 
        /// Commit only these paths; the rest stays as uncommitted work
118 
        paths: Vec<String>,
119 
        /// Choose hunks one by one
120 
        #[arg(short, long)]
121 
        interactive: bool,
c6aa5bd9 Andy McCall ↶ 122 
        /// Commit these hunks (as `oxy hunks` numbers them), comma separated
123 
        #[arg(long, value_delimiter = ',')]
124 
        hunks: Vec<usize>,
fce44ae9 Andy McCall ↶ 125 
    },
728da0f9 Andy McCall ↶ 126 
    /// Fold CHANGE into one of its dependencies (keeps that change's id)
127 
    Squash {
d42369ab Andy McCall 128 
        /// The change to fold (ChangeId prefix, #hash prefix)
728da0f9 Andy McCall ↶ 129 
        change: String,
d42369ab Andy McCall 130 
        /// The dependency that absorbs it
728da0f9 Andy McCall ↶ 131 
        #[arg(long)]
132 
        into: String,
133 
    },
134 
    /// Re-express CHANGE against another base state
135 
    Rebase {
d42369ab Andy McCall 136 
        /// The change to re-express (ChangeId prefix, #hash prefix)
728da0f9 Andy McCall ↶ 137 
        change: String,
138 
        /// The changes, bookmark or tag whose state becomes the new base
139 
        #[arg(long, required = true, num_args = 1..)]
140 
        onto: Vec<String>,
e266b7d4 Andy McCall ↶ 141 
        /// Where the rebase would be conflicted, merge the target into the
142 
        /// current bookmark instead, leaving the conflict in the working
143 
        /// copy to fix and commit
144 
        #[arg(long)]
145 
        into_working_copy: bool,
728da0f9 Andy McCall ↶ 146 
    },
957fee30 Andy McCall ↶ 147 
    /// Show which change introduced each line of a file
148 
    Blame {
d42369ab Andy McCall 149 
        /// File to annotate, relative to the repository root
957fee30 Andy McCall ↶ 150 
        path: String,
d42369ab Andy McCall 151 
        /// Machine-readable output: one JSON document on stdout
957fee30 Andy McCall ↶ 152 
        #[arg(long)]
153 
        json: bool,
154 
    },
155 
    /// Find the change that introduced a regression
156 
    Bisect {
157 
        #[command(subcommand)]
158 
        cmd: BisectCmd,
159 
    },
fce44ae9 Andy McCall ↶ 160 
    /// List changes reachable from the bookmark and the working copy
94084087 Andy McCall ↶ 161 
    Log {
bf3a6781 Andy McCall ↶ 162 
        /// Show the changes a revset selects: `main` (a bookmark name means its
163 
        /// heads; `bookmark(main)` only ever the bookmark), `main..feature &
164 
        /// author(andy)`, `touches("src/**") & date(-7d..)` (see
165 
        /// docs/revset_query_language.md)
47ce8b8e Andy McCall ↶ 166 
        #[arg(short = 'r', long, value_name = "REVSET", conflicts_with_all = ["path", "lines"])]
167 
        revset: Option<String>,
94084087 Andy McCall ↶ 168 
        /// Show at most this many changes
169 
        #[arg(short = 'n', long)]
170 
        limit: Option<usize>,
171 
        /// Show full messages, dependencies, and signatures
172 
        #[arg(short, long)]
173 
        verbose: bool,
c6aa5bd9 Andy McCall ↶ 174 
        /// Only changes touching this path (renames followed)
175 
        #[arg(long)]
176 
        path: Option<String>,
83d61e80 Andy McCall ↶ 177 
        /// Only changes that wrote or deleted lines START to END of PATH
178 
        /// (numbered as in the working copy's base), or deleted lines from
179 
        /// between them: the history of a function
180 
        #[arg(short = 'L', value_name = "START,END:PATH", conflicts_with = "path")]
181 
        lines: Option<String>,
d42369ab Andy McCall 182 
        /// Machine-readable output: one JSON document on stdout
c6aa5bd9 Andy McCall ↶ 183 
        #[arg(long)]
184 
        json: bool,
94084087 Andy McCall ↶ 185 
    },
fce44ae9 Andy McCall ↶ 186 
    /// Show what the working copy changes against its base
c6aa5bd9 Andy McCall ↶ 187 
    Diff {
188 
        /// A change instead of the working copy
189 
        change: Option<String>,
d42369ab Andy McCall 190 
        /// Machine-readable output: one JSON document on stdout
c6aa5bd9 Andy McCall ↶ 191 
        #[arg(long)]
192 
        json: bool,
193 
    },
194 
    /// Print a file as it is in a state (default: the working copy's base)
195 
    Cat {
d42369ab Andy McCall 196 
        /// File to print, relative to the repository root
c6aa5bd9 Andy McCall ↶ 197 
        path: String,
b0a0c9af Andy McCall ↶ 198 
        /// A bookmark or tag (its state), or a change: a change means its
199 
        /// dependency closure, the change and what it depends on, so files
200 
        /// only later changes touched are absent or at older versions
c6aa5bd9 Andy McCall ↶ 201 
        #[arg(short = 'r', long)]
202 
        change: Option<String>,
203 
    },
204 
    /// Print the repository root, workspace, and bookmark
205 
    Root {
d42369ab Andy McCall 206 
        /// Machine-readable output: one JSON document on stdout
c6aa5bd9 Andy McCall ↶ 207 
        #[arg(long)]
208 
        json: bool,
209 
    },
210 
    /// Print the version of oxy, its repository format, and protocol
211 
    Version {
d42369ab Andy McCall 212 
        /// Machine-readable output: one JSON document on stdout
c6aa5bd9 Andy McCall ↶ 213 
        #[arg(long)]
214 
        json: bool,
215 
    },
216 
    /// Restore paths to the working copy's base, or undo chosen hunks
217 
    Discard {
d42369ab Andy McCall 218 
        /// Paths to restore; none with --hunks, or everything with neither
c6aa5bd9 Andy McCall ↶ 219 
        paths: Vec<String>,
220 
        /// Hunk indices as `oxy hunks` numbers them, comma separated
221 
        #[arg(long, value_delimiter = ',')]
222 
        hunks: Vec<usize>,
223 
    },
224 
    /// List the working copy's hunks, numbered as commit --hunks expects
225 
    Hunks {
d42369ab Andy McCall 226 
        /// Machine-readable output: one JSON document on stdout
c6aa5bd9 Andy McCall ↶ 227 
        #[arg(long)]
228 
        json: bool,
229 
    },
6a81dbab Andy McCall ↶ 230 
    /// With -m, change the message of a head; without, name the working
231 
    /// copy for a build: its tag, or the nearest tag plus distance and
232 
    /// change, or the bookmark and change, and -dirty
614541c3 Andy McCall ↶ 233 
    Describe {
d42369ab Andy McCall 234 
        /// The new message
614541c3 Andy McCall ↶ 235 
        #[arg(short, long)]
6a81dbab Andy McCall ↶ 236 
        message: Option<String>,
d42369ab Andy McCall 237 
        /// The head to describe (default: the one the working copy sits on)
614541c3 Andy McCall ↶ 238 
        change: Option<String>,
6a81dbab Andy McCall ↶ 239 
        /// Machine-readable output (naming only)
240 
        #[arg(long, conflicts_with = "message")]
241 
        json: bool,
614541c3 Andy McCall ↶ 242 
    },
23b217d7 Andy McCall ↶ 243 
    /// Fold the working copy into the head it sits on, or into CHANGE with --into
614541c3 Andy McCall ↶ 244 
    Amend {
d42369ab Andy McCall 245 
        /// Replace the message too
614541c3 Andy McCall ↶ 246 
        #[arg(short, long)]
247 
        message: Option<String>,
23b217d7 Andy McCall ↶ 248 
        /// Amend an older change; the edits must touch only lines it already knows
69953b50 Andy McCall ↶ 249 
        #[arg(long, conflicts_with = "paths")]
23b217d7 Andy McCall ↶ 250 
        into: Option<String>,
69953b50 Andy McCall ↶ 251 
        /// Fold in only these paths; the rest stays as uncommitted work
252 
        paths: Vec<String>,
614541c3 Andy McCall ↶ 253 
    },
23b217d7 Andy McCall ↶ 254 
    /// Split a head: the named paths become a separate first change
d42369ab Andy McCall 255 
    Split {
256 
        /// The head to split
257 
        change: String,
258 
        /// Paths whose edits become the first change
259 
        paths: Vec<String>,
260 
    },
2c9ddac3 Andy McCall ↶ 261 
    /// Drop a change from the bookmark; its content stays on disk as uncommitted work
d42369ab Andy McCall 262 
    Abandon {
2c9ddac3 Andy McCall ↶ 263 
        /// The change to drop (ChangeId prefix, #hash prefix)
264 
        #[arg(required_unless_present = "revset")]
265 
        change: Option<String>,
266 
        /// Drop every change a revset selects, newest first
267 
        #[arg(short = 'r', long, value_name = "REVSET", conflicts_with = "change")]
268 
        revset: Option<String>,
269 
        /// Drop more than five changes without asking
270 
        #[arg(long, short = 'y')]
271 
        yes: bool,
d42369ab Andy McCall 272 
    },
2c9ddac3 Andy McCall ↶ 273 
    /// Show one change (ChangeId prefix, #hash prefix, or @), or those a revset selects
c6aa5bd9 Andy McCall ↶ 274 
    Show {
d42369ab Andy McCall 275 
        /// ChangeId prefix, #hash prefix, or @ for the working copy
2c9ddac3 Andy McCall ↶ 276 
        #[arg(required_unless_present = "revset")]
277 
        change: Option<String>,
278 
        /// Show every change a revset selects
279 
        #[arg(short = 'r', long, value_name = "REVSET", conflicts_with = "change")]
280 
        revset: Option<String>,
0299076f Andy McCall ↶ 281 
        /// The files it touched with lines added and removed, instead of the diff
282 
        #[arg(long)]
283 
        stat: bool,
d42369ab Andy McCall 284 
        /// Machine-readable output: one JSON document on stdout
c6aa5bd9 Andy McCall ↶ 285 
        #[arg(long)]
286 
        json: bool,
287 
    },
fce44ae9 Andy McCall ↶ 288 
    /// Move the working copy to the state formed by CHANGE... (default: the bookmark heads)
289 
    Checkout {
d42369ab Andy McCall 290 
        /// Changes whose state to check out (default: the bookmark heads)
fce44ae9 Andy McCall ↶ 291 
        changes: Vec<String>,
292 
        /// Throw away uncommitted working-copy changes
293 
        #[arg(long)]
294 
        discard: bool,
1c2bd9ab Andy McCall ↶ 295 
        /// Take uncommitted changes along; refused when the target has
296 
        /// other versions of the files they touch
297 
        #[arg(long, conflicts_with = "discard")]
298 
        carry: bool,
fce44ae9 Andy McCall ↶ 299 
    },
300 
    /// Report which conflicts of the working copy's base are resolved by the current files
c6aa5bd9 Andy McCall ↶ 301 
    Resolve {
d42369ab Andy McCall 302 
        /// Machine-readable output: one JSON document on stdout
c6aa5bd9 Andy McCall ↶ 303 
        #[arg(long)]
304 
        json: bool,
305 
    },
fce44ae9 Andy McCall ↶ 306 
    /// Undo the last operation
307 
    Undo,
252e8cb2 Andy McCall ↶ 308 
    /// Write a checkpoint of the current bookmark's state now
309 
    Checkpoint,
d42369ab Andy McCall 310 
    /// Print a shell completion script: `oxy completions bash > ~/.local/share/bash-completion/completions/oxy`
311 
    Completions {
312 
        /// bash, zsh, fish, elvish or powershell
313 
        shell: clap_complete::Shell,
314 
    },
315 
    /// Write man pages (oxy.1 and one per command) into DIR, or print oxy.1
316 
    Man {
317 
        /// Directory to write every page into, e.g. ~/.local/share/man/man1
318 
        #[arg(long)]
319 
        dir: Option<PathBuf>,
320 
    },
3e5772cc Andy McCall ↶ 321 
    /// Check the identity, configuration and remotes, and say what to do about any problem
322 
    Doctor {
323 
        /// Do not contact the remotes
324 
        #[arg(long)]
325 
        offline: bool,
d42369ab Andy McCall 326 
        /// Machine-readable output: one JSON document on stdout
3e5772cc Andy McCall ↶ 327 
        #[arg(long)]
328 
        json: bool,
329 
    },
387335ff Andy McCall ↶ 330 
    /// Check the repository's integrity: objects, operation log, references, signatures, checkpoints
331 
    Fsck {
d42369ab Andy McCall 332 
        /// Machine-readable output: one JSON document on stdout
387335ff Andy McCall ↶ 333 
        #[arg(long)]
334 
        json: bool,
335 
    },
da652d63 Andy McCall ↶ 336 
    /// Prune unreachable objects older than the grace period and repack everything into one pack
ba160f60 Andy McCall ↶ 337 
    Gc {
338 
        /// Ignore the grace period (core.gc-grace) and prune immediately
339 
        #[arg(long)]
340 
        now: bool,
b689779e Andy McCall ↶ 341 
        /// Keep no past working-copy snapshots, only each workspace's current one, so files only they held go (core.snapshot-retention, default 7 days)
342 
        #[arg(long)]
343 
        expire_snapshots: bool,
d8d93678 Andy McCall ↶ 344 
        /// Instead: fold the bundles of a remote kept on a store into one, and remove the ones a gc superseded 7 days ago (or now, with --now)
345 
        #[arg(long, value_name = "NAME")]
346 
        remote: Option<String>,
ba160f60 Andy McCall ↶ 347 
    },
fce44ae9 Andy McCall ↶ 348 
    /// List operations
349 
    #[command(name = "op")]
350 
    Op {
351 
        #[command(subcommand)]
352 
        cmd: OpCmd,
353 
    },
cdb5beba Andy McCall ↶ 354 
    /// Take the advisory local lock on a lockable file, making it writable
d42369ab Andy McCall 355 
    Lock {
356 
        /// The lockable file
357 
        path: String,
358 
    },
cdb5beba Andy McCall ↶ 359 
    /// Release the local lock and make the file read-only again
d42369ab Andy McCall 360 
    Unlock {
361 
        /// The locked file
362 
        path: String,
363 
    },
4e88e774 Andy McCall ↶ 364 
    /// Workspaces: extra checkout directories sharing this repository
365 
    Workspace {
366 
        #[command(subcommand)]
367 
        cmd: WorkspaceCmd,
368 
    },
7b9809e6 Andy McCall ↶ 369 
    /// Bookmarks: named states; each workspace works on one
370 
    Bookmark {
371 
        #[command(subcommand)]
372 
        cmd: BookmarkCmd,
373 
    },
733ea16a Andy McCall ↶ 374 
    /// Union another bookmark's heads into the current one (no merge change):
375 
    /// a bookmark here, or a remote's (`origin/develop`) as last fetched
d42369ab Andy McCall 376 
    Merge {
377 
        /// The bookmark whose heads to add
378 
        bookmark: String,
379 
    },
ff1f62fe Andy McCall ↶ 380 
    /// Sign in to a hub once, for every repository on it
381 
    Auth {
382 
        #[command(subcommand)]
383 
        cmd: AuthCmd,
384 
    },
4dee277c Andy McCall ↶ 385 
    /// Subrepositories: nested repositories pinned to a state
386 
    Submodule {
387 
        #[command(subcommand)]
388 
        cmd: SubmoduleCmd,
389 
    },
51d4862a Andy McCall ↶ 390 
    /// Witness hubs' transparency logs: cosign each checkpoint that extends
391 
    /// the last one cosigned (spec §14.8)
392 
    Witness {
393 
        #[command(subcommand)]
394 
        cmd: WitnessCmd,
395 
    },
e59512f2 Andy McCall ↶ 396 
    /// Hubs' transparency logs: check that a hub shows everyone the same
397 
    /// history (spec §14.8)
398 
    Tlog {
399 
        #[command(subcommand)]
400 
        cmd: TlogCmd,
401 
    },
fc1a466a Andy McCall ↶ 402 
    /// Execution receipts: signed records of what a runner ran on a state
403 
    Receipt {
404 
        #[command(subcommand)]
405 
        cmd: ReceiptCmd,
406 
    },
132b884b Andy McCall ↶ 407 
    /// Tags: immutable named states
408 
    Tag {
409 
        #[command(subcommand)]
410 
        cmd: TagCmd,
411 
    },
fce44ae9 Andy McCall ↶ 412 
    /// Manage remotes
413 
    Remote {
414 
        #[command(subcommand)]
415 
        cmd: RemoteCmd,
416 
    },
417 
    /// Fetch every bookmark of a remote into its tracking references
c6aa5bd9 Andy McCall ↶ 418 
    Fetch {
d42369ab Andy McCall 419 
        /// Remote name (default: origin)
c6aa5bd9 Andy McCall ↶ 420 
        remote: Option<String>,
d42369ab Andy McCall 421 
        /// Machine-readable output: one JSON document on stdout
c6aa5bd9 Andy McCall ↶ 422 
        #[arg(long)]
423 
        json: bool,
424 
    },
fce44ae9 Andy McCall ↶ 425 
    /// Fetch, then union the remote bookmark into the local one (no merge change)
c6aa5bd9 Andy McCall ↶ 426 
    Pull {
d42369ab Andy McCall 427 
        /// Remote name (default: origin)
c6aa5bd9 Andy McCall ↶ 428 
        remote: Option<String>,
d42369ab Andy McCall 429 
        /// Machine-readable output: one JSON document on stdout
c6aa5bd9 Andy McCall ↶ 430 
        #[arg(long)]
431 
        json: bool,
432 
    },
fce44ae9 Andy McCall ↶ 433 
    /// Push the current bookmark to a remote
434 
    Push {
d42369ab Andy McCall 435 
        /// Remote name (default: origin)
fce44ae9 Andy McCall ↶ 436 
        remote: Option<String>,
437 
        /// Allow dropping heads the remote has
438 
        #[arg(long)]
439 
        force: bool,
7b9809e6 Andy McCall ↶ 440 
        /// Push this bookmark instead of the workspace's current one
441 
        #[arg(short = 'b', long)]
442 
        bookmark: Option<String>,
f8c69576 Andy McCall ↶ 443 
        /// Delete this bookmark on the remote (never its default bookmark);
b63fc7a7 Andy McCall ↶ 444 
        /// the local bookmark is kept. `tags/NAME` withdraws a tag there
445 
        /// (and here, as `oxy tag delete` does)
f8c69576 Andy McCall ↶ 446 
        #[arg(long, value_name = "NAME", conflicts_with_all = ["bookmark", "force"])]
447 
        delete: Option<String>,
d42369ab Andy McCall 448 
        /// Machine-readable output: one JSON document on stdout
c6aa5bd9 Andy McCall ↶ 449 
        #[arg(long)]
450 
        json: bool,
fce44ae9 Andy McCall ↶ 451 
    },
2b5ee371 Andy McCall ↶ 452 
    /// Serve repositories under ROOT over HTTPS (with --tls-cert/--tls-key) or plain HTTP
fce44ae9 Andy McCall ↶ 453 
    Serve {
454 
        /// Directory with one repository per subdirectory
455 
        #[arg(long, default_value = ".")]
456 
        root: PathBuf,
d42369ab Andy McCall 457 
        /// Address and port to listen on
fce44ae9 Andy McCall ↶ 458 
        #[arg(long, default_value = "127.0.0.1:8890")]
459 
        bind: String,
460 
        /// Bearer token allowed to push (repeatable); none means open
461 
        #[arg(long = "token")]
462 
        tokens: Vec<String>,
2b5ee371 Andy McCall ↶ 463 
        /// PEM certificate chain; enables HTTPS together with --tls-key
464 
        #[arg(long, requires = "tls_key")]
465 
        tls_cert: Option<PathBuf>,
466 
        /// PEM private key
467 
        #[arg(long, requires = "tls_cert")]
468 
        tls_key: Option<PathBuf>,
fce44ae9 Andy McCall ↶ 469 
    },
470 
    /// Manage the signing identity
471 
    Identity {
472 
        #[command(subcommand)]
473 
        cmd: IdentityCmd,
474 
    },
05e71ed6 Andy McCall ↶ 475 
    /// Seal changes with your key: named ones, or every change on the current bookmark you can authenticate but have not
476 
    Seal {
d42369ab Andy McCall 477 
        /// Changes to seal (default: every change on the bookmark you can authenticate and have not sealed)
05e71ed6 Andy McCall ↶ 478 
        changes: Vec<String>,
d82e4409 Andy McCall ↶ 479 
        /// Seal every change of a hub proposal and push the seal (your approval)
480 
        #[arg(long, conflicts_with = "changes")]
481 
        proposal: Option<String>,
b582948f Andy McCall ↶ 482 
        /// Approve a job of a hub run that waits for a sealed approval: `--flow https://hub/OWNER/NAME/flow/N --job apply`
483 
        #[arg(long, conflicts_with_all = ["changes", "proposal"], requires = "job")]
484 
        flow: Option<String>,
485 
        /// The job to approve, with --flow
486 
        #[arg(long, requires = "flow")]
487 
        job: Option<String>,
488 
        /// Reject the job instead of approving it, with --flow
489 
        #[arg(long, requires = "flow")]
490 
        reject: bool,
d42369ab Andy McCall 491 
        /// Machine-readable output: one JSON document on stdout
05e71ed6 Andy McCall ↶ 492 
        #[arg(long)]
493 
        json: bool,
494 
    },
d82e4409 Andy McCall ↶ 495 
    /// Hub proposals: show one, or land it from this client
496 
    Proposal {
497 
        #[command(subcommand)]
498 
        cmd: ProposalCmd,
499 
    },
fce44ae9 Andy McCall ↶ 500 
    /// Verify the signatures on a change (default: every change in the log)
c6aa5bd9 Andy McCall ↶ 501 
    Verify {
d42369ab Andy McCall 502 
        /// The change to verify (default: every change in the log)
c6aa5bd9 Andy McCall ↶ 503 
        change: Option<String>,
2c9ddac3 Andy McCall ↶ 504 
        /// Verify every change a revset selects: `release..main & unsigned()`
505 
        #[arg(short = 'r', long, value_name = "REVSET", conflicts_with = "change")]
506 
        revset: Option<String>,
d42369ab Andy McCall 507 
        /// Machine-readable output: one JSON document on stdout
c6aa5bd9 Andy McCall ↶ 508 
        #[arg(long)]
509 
        json: bool,
510 
    },
79ab8528 Andy McCall ↶ 511 
    /// Git interoperability
512 
    Git {
513 
        #[command(subcommand)]
514 
        cmd: GitCmd,
515 
    },
83e0677b Andy McCall ↶ 516 
    /// Manage the trust policy (who may update which bookmarks)
517 
    Policy {
518 
        #[command(subcommand)]
519 
        cmd: PolicyCmd,
520 
    },
5ad2b565 Andy McCall ↶ 521 
    /// Set a configuration key (author.*, core.sign, core.op-retention, core.gc-grace, core.checkpoint-interval, filter.max-blob, filter.paths, storage.cache, workspace.bookmark, remote.<name>.url|token|ca, auth.helper with --user)
fce44ae9 Andy McCall ↶ 522 
    Config {
d42369ab Andy McCall 523 
        /// The key, such as author.name or remote.origin.token
fce44ae9 Andy McCall ↶ 524 
        key: String,
8e9c64d1 Andy McCall ↶ 525 
        /// The value to set (none with --unset); `-` reads it from standard input, out of the shell's history
614f55e1 Andy McCall ↶ 526 
        #[arg(required_unless_present = "unset")]
527 
        value: Option<String>,
fce44ae9 Andy McCall ↶ 528 
        /// Write to the user file (~/.config/oxy/config.toml) instead of this repository
529 
        #[arg(long)]
530 
        user: bool,
614f55e1 Andy McCall ↶ 531 
        /// Remove the key from this repository's file (or the user file with --user)
532 
        #[arg(long)]
533 
        unset: bool,
fce44ae9 Andy McCall ↶ 534 
    },
535 
}
536
537 
#[derive(Subcommand)]
538 
enum OpCmd {
98a1620a Andy McCall ↶ 539 
    /// List operations, newest first, with what each changed
c6aa5bd9 Andy McCall ↶ 540 
    Log {
98a1620a Andy McCall ↶ 541 
        /// Show only the latest N (snapshots folded together count as one)
542 
        #[arg(short = 'n', long)]
543 
        limit: Option<usize>,
d42369ab Andy McCall 544 
        /// Machine-readable output: one JSON document on stdout
c6aa5bd9 Andy McCall ↶ 545 
        #[arg(long)]
546 
        json: bool,
98a1620a Andy McCall ↶ 547 
    },
548 
    /// Go back to the bookmarks and working copy as they were after OP (recorded as a new operation, so it can be undone)
549 
    Restore {
550 
        /// The operation: an ID prefix from oxy op log, @ or @-
551 
        op: String,
552 
        /// Throw away uncommitted working-copy changes
553 
        #[arg(long)]
554 
        discard: bool,
555 
    },
556 
    /// Undo OP alone, keeping every operation after it: the bookmarks it moved go back
557 
    Revert {
558 
        /// The operation: an ID prefix from oxy op log
559 
        op: String,
c6aa5bd9 Andy McCall ↶ 560 
    },
fce44ae9 Andy McCall ↶ 561 
}
562
563 
#[derive(Subcommand)]
4e88e774 Andy McCall ↶ 564 
enum WorkspaceCmd {
565 
    /// Create a workspace at PATH checked out on CHANGE... (default: the bookmark heads)
d42369ab Andy McCall 566 
    Add {
567 
        /// Directory for the new workspace (must be empty or absent)
568 
        path: PathBuf,
569 
        /// Changes whose state to check out there
570 
        changes: Vec<String>,
571 
    },
572 
    /// List workspaces and their working-copy changes
1196b29b Andy McCall ↶ 573 
    List {
d42369ab Andy McCall 574 
        /// Machine-readable output: one JSON document on stdout
1196b29b Andy McCall ↶ 575 
        #[arg(long)]
576 
        json: bool,
577 
    },
4e88e774 Andy McCall ↶ 578 
    /// Stop tracking a workspace (by id prefix or path); its files stay
d42369ab Andy McCall 579 
    Forget {
580 
        /// Workspace id prefix or path
581 
        workspace: String,
582 
    },
4e88e774 Andy McCall ↶ 583 
}
584
585 
#[derive(Subcommand)]
957fee30 Andy McCall ↶ 586 
enum BisectCmd {
587 
    /// Begin; remembers where the working copy was
588 
    Start,
589 
    /// Mark CHANGE... (or the state under test) as good
d42369ab Andy McCall 590 
    Good {
591 
        /// Changes known to be good (default: the state under test)
592 
        changes: Vec<String>,
593 
    },
957fee30 Andy McCall ↶ 594 
    /// Mark CHANGE... (or the state under test) as bad
d42369ab Andy McCall 595 
    Bad {
596 
        /// Changes known to be bad (default: the state under test)
597 
        changes: Vec<String>,
598 
    },
957fee30 Andy McCall ↶ 599 
    /// The state under test cannot be tested; try another
600 
    Skip,
601 
    /// Run a command for each step: exit 0 good, 125 skip, else bad
602 
    Run {
d42369ab Andy McCall 603 
        /// Command and arguments to run at each step
957fee30 Andy McCall ↶ 604 
        #[arg(required = true, trailing_var_arg = true)]
605 
        command: Vec<String>,
606 
    },
607 
    /// Where the search stands
c6aa5bd9 Andy McCall ↶ 608 
    Status {
d42369ab Andy McCall 609 
        /// Machine-readable output: one JSON document on stdout
c6aa5bd9 Andy McCall ↶ 610 
        #[arg(long)]
611 
        json: bool,
612 
    },
957fee30 Andy McCall ↶ 613 
    /// Restore the working copy and forget the search
614 
    Reset,
615 
}
616
617 
#[derive(Subcommand)]
7b9809e6 Andy McCall ↶ 618 
enum BookmarkCmd {
619 
    /// Create a bookmark at CHANGE... (default: the working copy's base)
d42369ab Andy McCall 620 
    Create {
621 
        /// Name of the new bookmark
622 
        name: String,
4fe7d604 Andy McCall ↶ 623 
        /// Its heads (default: the working copy's base). A state is its
624 
        /// heads and what they depend on: a change alone may leave out
625 
        /// earlier changes of the current state, which is refused unless
626 
        /// --upto or --only says which is meant
d42369ab Andy McCall 627 
        changes: Vec<String>,
4fe7d604 Andy McCall ↶ 628 
        /// Everything of the current state up to CHANGE..., as a Git
629 
        /// branch at a commit would hold
630 
        #[arg(long, conflicts_with = "only")]
631 
        upto: bool,
b9bf7eec Andy McCall ↶ 632 
        /// Just CHANGE... and what they depend on. Other changes to the
633 
        /// same files are left out, so a file can come out partly edited;
634 
        /// to add one change to a bookmark's work, give the bookmark's
635 
        /// heads with it instead: `bookmark set NAME <its heads> CHANGE`
4fe7d604 Andy McCall ↶ 636 
        #[arg(long)]
637 
        only: bool,
d42369ab Andy McCall 638 
    },
7b9809e6 Andy McCall ↶ 639 
    /// Point an existing bookmark at CHANGE...
d42369ab Andy McCall 640 
    Set {
641 
        /// The bookmark to move
642 
        name: String,
06d16dc2 Andy McCall ↶ 643 
        /// Its new heads. A change alone may leave out changes the
644 
        /// bookmark now holds that were recorded before it, which is
645 
        /// refused unless --upto or --only says which is meant
d42369ab Andy McCall 646 
        changes: Vec<String>,
06d16dc2 Andy McCall ↶ 647 
        /// Everything the bookmark holds up to CHANGE..., as a Git branch
648 
        /// moved to a commit would hold
649 
        #[arg(long, conflicts_with = "only")]
650 
        upto: bool,
b9bf7eec Andy McCall ↶ 651 
        /// Just CHANGE... and what they depend on. Other changes to the
652 
        /// same files are left out, so a file can come out partly edited;
653 
        /// to add one change to a bookmark's work, give the bookmark's
654 
        /// heads with it instead: `bookmark set NAME <its heads> CHANGE`
06d16dc2 Andy McCall ↶ 655 
        #[arg(long)]
656 
        only: bool,
d42369ab Andy McCall 657 
    },
7b9809e6 Andy McCall ↶ 658 
    /// Remove a bookmark; its changes stay
d42369ab Andy McCall 659 
    Delete {
660 
        /// The bookmark to remove
661 
        name: String,
662 
    },
7b9809e6 Andy McCall ↶ 663 
    /// List bookmarks with their heads and difference from origin
c6aa5bd9 Andy McCall ↶ 664 
    List {
14edbaaf Andy McCall ↶ 665 
        /// Also list remotes' bookmarks that have no local bookmark
666 
        #[arg(long, short)]
667 
        all: bool,
bf3a6781 Andy McCall ↶ 668 
        /// Each head of every bookmark, as `bookmark show` prints them
669 
        #[arg(long, short)]
670 
        verbose: bool,
d42369ab Andy McCall 671 
        /// Machine-readable output: one JSON document on stdout
c6aa5bd9 Andy McCall ↶ 672 
        #[arg(long)]
673 
        json: bool,
674 
    },
bf3a6781 Andy McCall ↶ 675 
    /// A bookmark's heads: each change nothing else on it depends on,
676 
    /// newest first. A bookmark name is also a revset for its heads
677 
    /// (`oxy log -r NAME`, or `bookmark(NAME)` to mean only the bookmark)
678 
    Show {
679 
        /// The bookmark, or REMOTE/NAME (default: the current one)
680 
        name: Option<String>,
681 
        /// Machine-readable output: one JSON document on stdout
682 
        #[arg(long)]
683 
        json: bool,
684 
    },
61e3bce7 Andy McCall ↶ 685 
    /// Make NAME this workspace's bookmark and check it out. Uncommitted work stops it; --carry takes the work along, --discard drops it
7b9809e6 Andy McCall ↶ 686 
    Switch {
14edbaaf Andy McCall ↶ 687 
        /// The bookmark to work on; one only a remote has (NAME or REMOTE/NAME) is created from it
7b9809e6 Andy McCall ↶ 688 
        name: String,
689 
        /// Throw away uncommitted working-copy changes
690 
        #[arg(long)]
691 
        discard: bool,
61e3bce7 Andy McCall ↶ 692 
        /// Take uncommitted changes along; refused when NAME has other
693 
        /// versions of the files they touch
694 
        #[arg(long, conflicts_with = "discard")]
695 
        carry: bool,
51d4862a Andy McCall ↶ 696 
    },
697 
}
698
699 
#[derive(Subcommand)]
700 
enum WitnessCmd {
701 
    /// Serve a witness (C2SP tlog-witness: POST /add-checkpoint), signing
702 
    /// with this oxy home's key (author.key)
703 
    Serve {
704 
        /// The witness's name in cosignatures: a host name
705 
        #[arg(long)]
706 
        name: String,
707 
        /// A log to witness, as ORIGIN=FILE: its origin (HOST/log) and its
708 
        /// key's identity file (a hub's /.well-known/oxyhub-key); repeatable
709 
        #[arg(long = "log", required = true)]
710 
        logs: Vec<String>,
711 
        /// Where to keep what it cosigned
712 
        #[arg(long, default_value = "witness-state")]
713 
        state: PathBuf,
714 
        /// Address and port to listen on
715 
        #[arg(long, default_value = "127.0.0.1:8891")]
716 
        bind: String,
717 
        /// PEM certificate chain; enables HTTPS together with --tls-key
718 
        #[arg(long, requires = "tls_key")]
719 
        tls_cert: Option<PathBuf>,
720 
        /// PEM private key for --tls-cert
721 
        #[arg(long, requires = "tls_cert")]
722 
        tls_key: Option<PathBuf>,
e59512f2 Andy McCall ↶ 723 
    },
724 
}
725
726 
#[derive(Subcommand)]
727 
enum TlogCmd {
728 
    /// Check a hub's whole log: its checkpoint against the log key and the
729 
    /// last checkpoint seen, and every entry against the root it signed;
730 
    /// then list this repository's entries (or a key's, or all)
731 
    Verify {
732 
        /// The hub, as https://oxygenhub.io (default: this checkout's remote)
733 
        hub: Option<String>,
734 
        /// List the entries a key signed (a KeyId) instead
735 
        #[arg(long, conflicts_with = "all")]
736 
        key: Option<String>,
737 
        /// List every entry
738 
        #[arg(long)]
739 
        all: bool,
740 
        /// Machine-readable output
741 
        #[arg(long)]
742 
        json: bool,
ff1f62fe Andy McCall ↶ 743 
    },
744 
}
745
746 
#[derive(Subcommand)]
747 
enum AuthCmd {
748 
    /// Sign in to HUB in the browser (device sign-in) and keep the token for
749 
    /// every repository there
750 
    Login {
751 
        /// The hub, as https://oxygenhub.io or oxygenhub.io (default: this checkout's origin)
752 
        hub: Option<String>,
753 
        /// Read a token from standard input instead (for CI and scripts)
754 
        #[arg(long)]
755 
        with_token: bool,
756 
        /// PEM file of extra roots to trust (a hub with a self-signed certificate)
757 
        #[arg(long)]
758 
        ca: Option<PathBuf>,
7b9809e6 Andy McCall ↶ 759 
    },
ff1f62fe Andy McCall ↶ 760 
    /// List the hubs you are signed in to, checking each token with its hub
761 
    Status,
762 
    /// Forget HUB's token and revoke it on the hub
763 
    Logout {
764 
        /// The hub (default: this checkout's origin, or the only one)
765 
        hub: Option<String>,
766 
    },
c895bc52 Andy McCall ↶ 767 
    /// Keep an agent grant token (from `oh agent grant`) for keyless
768 
    /// signing: with `author.signer = keyless`, commits and pushes are
769 
    /// signed by fresh keys the hub certifies, in the grantor's name
770 
    /// (the token is read from standard input, so it stays out of the
771 
    /// shell's history)
772 
    Grant {
773 
        /// The hub (default: this checkout's origin)
774 
        hub: Option<String>,
775 
    },
7b9809e6 Andy McCall ↶ 776 
}
777
778 
#[derive(Subcommand)]
4dee277c Andy McCall ↶ 779 
enum SubmoduleCmd {
780 
    /// Clone URL (Oxygen or Git) into PATH and register it in .oxymodules
781 
    Add {
d42369ab Andy McCall 782 
        /// URL or path of the Oxygen or Git repository
4dee277c Andy McCall ↶ 783 
        url: String,
d42369ab Andy McCall 784 
        /// Where to put it, relative to the repository root
4dee277c Andy McCall ↶ 785 
        path: String,
786 
        /// Bookmark (Oxygen) or branch (Git) to check out and track
787 
        #[arg(long)]
788 
        bookmark: Option<String>,
789 
    },
790 
    /// Bring nested repositories to their pins
791 
    Update {
792 
        /// Clone nested repositories that are absent
793 
        #[arg(long)]
794 
        init: bool,
d42369ab Andy McCall 795 
        /// Subrepos to update (default: all)
4dee277c Andy McCall ↶ 796 
        paths: Vec<String>,
797 
    },
798 
    /// List subrepos with their pins and on-disk state
c6aa5bd9 Andy McCall ↶ 799 
    Status {
d42369ab Andy McCall 800 
        /// Machine-readable output: one JSON document on stdout
c6aa5bd9 Andy McCall ↶ 801 
        #[arg(long)]
802 
        json: bool,
803 
    },
4dee277c Andy McCall ↶ 804 
    /// Unregister PATH; the directory stays, the node goes with the next commit
d42369ab Andy McCall 805 
    Remove {
806 
        /// The subrepo to unregister
807 
        path: String,
808 
    },
4dee277c Andy McCall ↶ 809 
}
810
811 
#[derive(Subcommand)]
fc1a466a Andy McCall ↶ 812 
enum ReceiptCmd {
813 
    /// The receipts kept for a state (default: the bookmark heads)
814 
    List {
815 
        /// Change, bookmark or tag whose state to look at
816 
        rev: Option<String>,
817 
        /// Machine-readable output: one JSON document on stdout
818 
        #[arg(long)]
819 
        json: bool,
820 
    },
821 
    /// One receipt in full, and whether its signature verifies
822 
    Show {
823 
        /// The receipt (a prefix of its hash, as `list` shows it)
824 
        receipt: String,
825 
        /// Change, bookmark or tag whose state holds it
826 
        #[arg(long)]
827 
        rev: Option<String>,
828 
        /// Machine-readable output: one JSON document on stdout
829 
        #[arg(long)]
830 
        json: bool,
831 
    },
832 
    /// Write a signed receipt to FILE
833 
    Export {
834 
        /// The receipt (a prefix of its hash, as `list` shows it)
835 
        receipt: String,
836 
        /// Where to write it
837 
        file: String,
838 
        /// Change, bookmark or tag whose state holds it
839 
        #[arg(long)]
840 
        rev: Option<String>,
a39754d0 Andy McCall ↶ 841 
        /// `oxygen`: the runner's signed receipt, as `verify` and `import`
842 
        /// read it. `slsa`: SLSA provenance in a DSSE envelope, signed with
843 
        /// your key, for in-toto and cosign (`oxy identity export --pem`
844 
        /// gives the key they check it with)
845 
        #[arg(long, default_value = "oxygen", value_parser = ["oxygen", "slsa"])]
846 
        format: String,
fc1a466a Andy McCall ↶ 847 
    },
848 
    /// Check a signed receipt in FILE without keeping it
849 
    Verify {
850 
        /// A signed receipt, as a runner or `export` writes it
851 
        file: String,
852 
        /// Machine-readable output: one JSON document on stdout
853 
        #[arg(long)]
854 
        json: bool,
855 
    },
856 
    /// Verify a signed receipt in FILE and keep it with its state
857 
    Import {
858 
        /// A signed receipt, as a runner or `export` writes it
859 
        file: String,
860 
    },
861 
}
862
863 
#[derive(Subcommand)]
132b884b Andy McCall ↶ 864 
enum TagCmd {
865 
    /// Tag the state of CHANGE... (default: the bookmark heads)
866 
    Create {
d42369ab Andy McCall 867 
        /// Name of the tag; tags never move
132b884b Andy McCall ↶ 868 
        name: String,
d42369ab Andy McCall 869 
        /// Changes whose state to tag (default: the bookmark heads)
132b884b Andy McCall ↶ 870 
        changes: Vec<String>,
d42369ab Andy McCall 871 
        /// A message recorded with the tag
132b884b Andy McCall ↶ 872 
        #[arg(short, long, default_value = "")]
873 
        message: String,
874 
    },
b63fc7a7 Andy McCall ↶ 875 
    /// Withdraw a tag: a signed withdrawal, kept beside the tag's creation;
876 
    /// `oxy push` sends it to a remote that has the tag (the name is never
877 
    /// used again)
878 
    Delete {
879 
        /// Name of the tag
880 
        name: String,
881 
        /// Why it is withdrawn, recorded with the withdrawal
882 
        #[arg(short, long, default_value = "")]
883 
        reason: String,
884 
    },
d42369ab Andy McCall 885 
    /// List tags and the states they name
1196b29b Andy McCall ↶ 886 
    List {
d42369ab Andy McCall 887 
        /// Machine-readable output: one JSON document on stdout
1196b29b Andy McCall ↶ 888 
        #[arg(long)]
889 
        json: bool,
890 
    },
132b884b Andy McCall ↶ 891 
}
892
893 
#[derive(Subcommand)]
fce44ae9 Andy McCall ↶ 894 
enum RemoteCmd {
d42369ab Andy McCall 895 
    /// Add a remote
75167672 Andy McCall 896 
    Add {
d42369ab Andy McCall 897 
        /// Name to refer to the remote by, such as origin
75167672 Andy McCall 898 
        name: String,
9aa39904 Andy McCall ↶ 899 
        /// A local path or the http(s) URL of a hub repository; or a store the repository is kept on: s3://BUCKET/PREFIX, gs://BUCKET/PREFIX, az://ACCOUNT/CONTAINER/PREFIX, dir://PATH
75167672 Andy McCall 900 
        url: String,
9aa39904 Andy McCall ↶ 901 
        /// For an s3:// store: the AWS profile to use (default: AWS_PROFILE, else "default")
902 
        #[arg(long)]
903 
        profile: Option<String>,
904 
        /// For an s3:// store: its region (default: the environment, the profile, else asked of S3)
905 
        #[arg(long)]
906 
        region: Option<String>,
907 
        /// For an s3://, gs:// or az:// store: another endpoint, such as an S3-compatible service
908 
        #[arg(long)]
909 
        endpoint: Option<String>,
910 
        /// For a gs:// store: a service account key file, or application default credentials
911 
        #[arg(long)]
912 
        credentials: Option<String>,
75167672 Andy McCall 913 
    },
9aa39904 Andy McCall ↶ 914 
    /// Check a remote: that it is reachable with the credentials in hand, what it holds, and (for a store) that it behaves
915 
    Check {
916 
        /// The remote to check
917 
        name: String,
918 
    },
d42369ab Andy McCall 919 
    /// Remove a remote
75167672 Andy McCall 920 
    Remove {
d42369ab Andy McCall 921 
        /// The remote to remove
75167672 Andy McCall 922 
        name: String,
923 
    },
d42369ab Andy McCall 924 
    /// List remotes and their URLs
c6aa5bd9 Andy McCall ↶ 925 
    List {
d42369ab Andy McCall 926 
        /// Machine-readable output: one JSON document on stdout
c6aa5bd9 Andy McCall ↶ 927 
        #[arg(long)]
928 
        json: bool,
929 
    },
fce44ae9 Andy McCall ↶ 930 
}
931
932 
#[derive(Subcommand)]
d82e4409 Andy McCall ↶ 933 
enum ProposalCmd {
934 
    /// Show a proposal by its hub URL
935 
    Show {
d42369ab Andy McCall 936 
        /// The proposal's URL on the hub
d82e4409 Andy McCall ↶ 937 
        url: String,
d42369ab Andy McCall 938 
        /// Machine-readable output: one JSON document on stdout
d82e4409 Andy McCall ↶ 939 
        #[arg(long)]
940 
        json: bool,
941 
    },
942 
    /// Fetch the proposal's changes, set the target bookmark to the projected state, and push with your key
943 
    Land {
d42369ab Andy McCall 944 
        /// The proposal's URL on the hub
d82e4409 Andy McCall ↶ 945 
        url: String,
946 
        /// Land even when the hub reports blockers
947 
        #[arg(long)]
948 
        force: bool,
949 
    },
950 
}
951
952 
#[derive(Subcommand)]
fce44ae9 Andy McCall ↶ 953 
enum IdentityCmd {
954 
    /// Generate a composite Ed25519 + ML-DSA-65 key pair and make it your author identity
955 
    Create {
d42369ab Andy McCall 956 
        /// Your name (default: author.name)
fce44ae9 Andy McCall ↶ 957 
        #[arg(long)]
958 
        name: Option<String>,
d42369ab Andy McCall 959 
        /// Your email (default: author.email)
fce44ae9 Andy McCall ↶ 960 
        #[arg(long)]
961 
        email: Option<String>,
962 
        /// Record the author in this repository only, not in the user config
963 
        #[arg(long)]
964 
        local: bool,
28fc23d7 Andy McCall ↶ 965 
        /// Expire the identity this many days from now
966 
        #[arg(long)]
967 
        expires: Option<u64>,
fce44ae9 Andy McCall ↶ 968 
    },
969 
    /// Show the configured identity
970 
    Show,
83e0677b Andy McCall ↶ 971 
    /// Write your identity object to a file, to hand to a policy holder
d42369ab Andy McCall 972 
    Export {
a39754d0 Andy McCall ↶ 973 
        /// File to write (default: <key>.identity, or <key>.pem with --pem, in the current directory)
d42369ab Andy McCall 974 
        path: Option<PathBuf>,
a39754d0 Andy McCall ↶ 975 
        /// Write the Ed25519 public key as PEM instead, as cosign's --key and
976 
        /// other DSSE verifiers take it
977 
        #[arg(long)]
978 
        pem: bool,
d42369ab Andy McCall 979 
    },
7aa2dc93 Andy McCall ↶ 980 
    /// Sign a host's challenge (hex, at least 16 bytes) to prove you hold your key; prints the signature as hex
981 
    SignChallenge {
d42369ab Andy McCall 982 
        /// The host's challenge, as hex
7aa2dc93 Andy McCall ↶ 983 
        challenge: String,
d42369ab Andy McCall 984 
        /// Machine-readable output: one JSON document on stdout
7aa2dc93 Andy McCall ↶ 985 
        #[arg(long)]
986 
        json: bool,
987 
    },
28fc23d7 Andy McCall ↶ 988 
    /// Move to a fresh key pair; the policy follows if it names your key
989 
    Rotate,
990 
    /// Re-issue your identity with a new expiry (in days from now; 0 = never)
991 
    Renew {
d42369ab Andy McCall 992 
        /// Days from now until it expires; 0 for never
28fc23d7 Andy McCall ↶ 993 
        #[arg(long)]
994 
        expires: u64,
995 
    },
996 
    /// Revoke a key: yours by default, or any key if you hold a policy root
997 
    Revoke {
998 
        /// KeyId prefix (default: your own key)
999 
        key: Option<String>,
d42369ab Andy McCall 1000 
        /// Why, recorded in the revocation
28fc23d7 Andy McCall ↶ 1001 
        #[arg(long, default_value = "")]
1002 
        reason: String,
1003 
    },
1004 
    /// Keys allowed to sign or seal on your behalf
1005 
    Delegate {
1006 
        #[command(subcommand)]
1007 
        cmd: DelegateCmd,
1008 
    },
1009 
}
1010
1011 
#[derive(Subcommand)]
1012 
enum DelegateCmd {
1013 
    /// Add a delegate from an exported identity file
d42369ab Andy McCall 1014 
    Add {
614f55e1 Andy McCall ↶ 1015 
        /// The delegates' exported identity files: one rotation for all of them
1016 
        #[arg(required = true)]
1017 
        identity_file: Vec<PathBuf>,
7ba155f2 Andy McCall ↶ 1018 
        /// What it may do for you: changes, refs, seal (comma-separated) or all.
1019 
        /// An agent gets `changes`; a host that lands for you needs `changes,refs`
1020 
        #[arg(long, default_value = "changes")]
1021 
        scope: String,
1022 
        /// How long for: 30m, 8h, 7d, or a number of days (default: until removed)
1023 
        #[arg(long)]
1024 
        expires: Option<String>,
d42369ab Andy McCall 1025 
    },
28fc23d7 Andy McCall ↶ 1026 
    /// Remove a delegate by KeyId prefix
d42369ab Andy McCall 1027 
    Remove {
1028 
        /// KeyId prefix of the delegate
1029 
        key: String,
1030 
    },
28fc23d7 Andy McCall ↶ 1031 
    /// List delegates
1032 
    List,
fce44ae9 Andy McCall ↶ 1033 
}
1034
83e0677b Andy McCall ↶ 1035 
#[derive(Subcommand)]
79ab8528 Andy McCall ↶ 1036 
enum GitCmd {
1037 
    /// Export the current bookmark to a Git repository (created bare if absent)
30ea9c1e Andy McCall ↶ 1038 
    Export {
d42369ab Andy McCall 1039 
        /// Git repository to write to (created bare if absent)
30ea9c1e Andy McCall ↶ 1040 
        git_dir: PathBuf,
1041 
        /// Git branch to write (default: the bookmark name)
1042 
        #[arg(long)]
1043 
        branch: Option<String>,
1044 
    },
1045 
    /// Fetch a branch from a Git remote (path or URL) into the current bookmark
1046 
    Fetch {
d42369ab Andy McCall 1047 
        /// Git remote: a path or URL
30ea9c1e Andy McCall ↶ 1048 
        url: String,
d42369ab Andy McCall 1049 
        /// Branch to fetch
30ea9c1e Andy McCall ↶ 1050 
        #[arg(long, default_value = "main")]
1051 
        branch: String,
d6e0d5b8 Andy McCall ↶ 1052 
        /// Author your own commits (Git author email = your identity's) with your key; sets git.claim
1053 
        #[arg(long)]
1054 
        claim: bool,
30ea9c1e Andy McCall ↶ 1055 
    },
1056 
    /// Push the current bookmark to a branch of a Git remote (fetch first)
1057 
    Push {
d42369ab Andy McCall 1058 
        /// Git remote: a path or URL
30ea9c1e Andy McCall ↶ 1059 
        url: String,
d42369ab Andy McCall 1060 
        /// Branch to push to
30ea9c1e Andy McCall ↶ 1061 
        #[arg(long, default_value = "main")]
1062 
        branch: String,
1063 
    },
54e2e630 Andy McCall ↶ 1064 
    /// Recover an import that stopped before it moved the bookmark: point the bookmark at every imported commit's change in the store, so oxy git fetch carries on from there
1065 
    Recover,
62794ecc Andy McCall ↶ 1066 
    /// Check this repository's import of a Git branch: every commit's tree must be reproduced exactly
1067 
    Verify {
1068 
        /// The Git repository the import came from
1069 
        git_dir: PathBuf,
1070 
        /// Branch that was imported
1071 
        #[arg(long, default_value = "main")]
1072 
        branch: String,
7eac74ab Andy McCall ↶ 1073 
        /// Rebuild only the last N commits (the others are followed, not checked)
1074 
        #[arg(long, value_name = "N")]
1075 
        last: Option<usize>,
8b7986dd Andy McCall ↶ 1076 
        /// Stop after N differences (0: check every commit whatever it finds)
1077 
        #[arg(long, value_name = "N", default_value_t = 50)]
1078 
        max_differences: usize,
62794ecc Andy McCall ↶ 1079 
    },
c3069537 Andy McCall ↶ 1080 
    /// Import a Git branch into a new Oxygen repository at DEST
1081 
    Import {
d42369ab Andy McCall 1082 
        /// Git repository to read
c3069537 Andy McCall ↶ 1083 
        git_dir: PathBuf,
d42369ab Andy McCall 1084 
        /// Directory for the new Oxygen repository
c3069537 Andy McCall ↶ 1085 
        dest: PathBuf,
d42369ab Andy McCall 1086 
        /// Branch to import
c3069537 Andy McCall ↶ 1087 
        #[arg(long, default_value = "main")]
1088 
        branch: String,
d6e0d5b8 Andy McCall ↶ 1089 
        /// Author your own commits (Git author email = your identity's) with your key; sets git.claim
1090 
        #[arg(long)]
1091 
        claim: bool,
c3069537 Andy McCall ↶ 1092 
    },
79ab8528 Andy McCall ↶ 1093 
}
1094
1095 
#[derive(Subcommand)]
83e0677b Andy McCall ↶ 1096 
enum PolicyCmd {
1097 
    /// Create the initial policy with your identity as the only root
1098 
    Init,
1099 
    /// Show the current policy
c6aa5bd9 Andy McCall ↶ 1100 
    Show {
d42369ab Andy McCall 1101 
        /// Machine-readable output: one JSON document on stdout
c6aa5bd9 Andy McCall ↶ 1102 
        #[arg(long)]
1103 
        json: bool,
1104 
    },
83e0677b Andy McCall ↶ 1105 
    /// Allow an identity (from `oxy identity export`) to update bookmarks
1106 
    Grant {
d42369ab Andy McCall 1107 
        /// The identity to grant, exported with `oxy identity export`
83e0677b Andy McCall ↶ 1108 
        identity_file: PathBuf,
1109 
        /// Reference pattern the grant applies to (default: every bookmark)
1110 
        #[arg(long)]
1111 
        pattern: Option<String>,
28fc23d7 Andy McCall ↶ 1112 
        /// Where to write the proposal when more root signatures are needed
1113 
        #[arg(long)]
1114 
        out: Option<PathBuf>,
83e0677b Andy McCall ↶ 1115 
    },
3a6effc7 Andy McCall ↶ 1116 
    /// Allow holders of an issuer's certificates for SUBJECT to sign (keyless)
1117 
    GrantSubject {
1118 
        /// Who: `repo:OWNER/NAME:bookmark:main`, `agent:NAME@ACCOUNT`; `*` matches any run of characters
1119 
        subject: String,
1120 
        /// The issuer's identity file, e.g. a hub's /.well-known/oxyhub-key
1121 
        #[arg(long)]
1122 
        issuer: PathBuf,
1123 
        /// What its keys may sign: changes, refs, seal
1124 
        #[arg(long, default_value = "changes,refs")]
1125 
        scope: String,
1126 
        /// Reference pattern the grant applies to (default: every bookmark)
1127 
        #[arg(long)]
1128 
        pattern: Option<String>,
1129 
        /// Where to write the proposal when more root signatures are needed
1130 
        #[arg(long)]
1131 
        out: Option<PathBuf>,
1132 
    },
83e0677b Andy McCall ↶ 1133 
    /// Revoke a key (KeyId prefix of an identity in the policy)
28fc23d7 Andy McCall ↶ 1134 
    Revoke {
d42369ab Andy McCall 1135 
        /// KeyId prefix of the identity
28fc23d7 Andy McCall ↶ 1136 
        key: String,
1137 
        /// Where to write the proposal when more root signatures are needed
1138 
        #[arg(long)]
1139 
        out: Option<PathBuf>,
1140 
    },
1141 
    /// Manage root keys and the signature threshold for policy updates
1142 
    Root {
1143 
        #[command(subcommand)]
1144 
        cmd: RootCmd,
1145 
    },
1146 
    /// Add your root signature to a proposal file; applies it once the threshold is met
1147 
    Sign {
d42369ab Andy McCall 1148 
        /// The proposal file to sign
28fc23d7 Andy McCall ↶ 1149 
        proposal: PathBuf,
1150 
        /// Where to write the proposal if it still needs signatures (default: in place)
1151 
        #[arg(long)]
1152 
        out: Option<PathBuf>,
1153 
    },
1154 
}
1155
1156 
#[derive(Subcommand)]
1157 
enum RootCmd {
1158 
    /// Make an exported identity a root key
1159 
    Add {
d42369ab Andy McCall 1160 
        /// The identity to make a root, exported with `oxy identity export`
28fc23d7 Andy McCall ↶ 1161 
        identity_file: PathBuf,
d42369ab Andy McCall 1162 
        /// Where to write the proposal when more root signatures are needed
28fc23d7 Andy McCall ↶ 1163 
        #[arg(long)]
1164 
        out: Option<PathBuf>,
1165 
    },
1166 
    /// Remove a root key by KeyId prefix
1167 
    Remove {
d42369ab Andy McCall 1168 
        /// KeyId prefix of the root key
28fc23d7 Andy McCall ↶ 1169 
        key: String,
d42369ab Andy McCall 1170 
        /// Where to write the proposal when more root signatures are needed
28fc23d7 Andy McCall ↶ 1171 
        #[arg(long)]
1172 
        out: Option<PathBuf>,
1173 
    },
1174 
    /// Require this many root signatures on policy updates
1175 
    Threshold {
d42369ab Andy McCall 1176 
        /// Number of root signatures
28fc23d7 Andy McCall ↶ 1177 
        n: u32,
d42369ab Andy McCall 1178 
        /// Where to write the proposal when more root signatures are needed
28fc23d7 Andy McCall ↶ 1179 
        #[arg(long)]
1180 
        out: Option<PathBuf>,
1181 
    },
83e0677b Andy McCall ↶ 1182 
}
1183
fce44ae9 Andy McCall ↶ 1184 
/// Open the repository containing the current directory.
1185 
fn open() -> Result<Repo> {
98a1620a Andy McCall ↶ 1186 
    let repo = Repo::open(&std::env::current_dir()?).context("opening repository")?;
1187 
    match AT_OP.get().and_then(|o| o.as_deref()) {
1188 
        Some(op) => Ok(repo.at_op(op)?),
1189 
        None => Ok(repo),
1190 
    }
fce44ae9 Andy McCall ↶ 1191 
}
1192
d42369ab Andy McCall 1193 
/// `oxy man`: every page into `dir`, or the top-level page on stdout.
1194 
fn man(dir: Option<PathBuf>) -> Result<i32> {
1195 
    use clap::CommandFactory;
1196 
    let cmd = Cli::command();
1197 
    match dir {
1198 
        Some(dir) => {
1199 
            std::fs::create_dir_all(&dir)?;
1200 
            clap_mangen::generate_to(cmd, &dir)?;
1201 
            let pages = std::fs::read_dir(&dir)?
1202 
                .filter(|e| {
1203 
                    e.as_ref()
1204 
                        .is_ok_and(|e| e.path().extension().is_some_and(|x| x == "1"))
1205 
                })
1206 
                .count();
1207 
            println!(
1208 
                "{}",
1209 
                ui::done(format!("Wrote {pages} man pages to {}", dir.display()))
1210 
            );
1211 
        }
1212 
        None => clap_mangen::Man::new(cmd).render(&mut std::io::stdout())?,
1213 
    }
1214 
    Ok(0)
1215 
}
1216
fce44ae9 Andy McCall ↶ 1217 
/// Parse arguments and run; returns the process exit code.
1218 
pub fn run() -> Result<i32> {
8d803563 Andy McCall ↶ 1219 
    // The cloud stores (s3://, gs://, az://) for remotes kept on them.
1220 
    oxy_strata::register();
fce44ae9 Andy McCall ↶ 1221 
    let cli = Cli::parse();
135212de Andy McCall ↶ 1222 
    ui::init(cli.plain);
98a1620a Andy McCall ↶ 1223 
    AT_OP.set(cli.at_op.clone()).ok();
fce44ae9 Andy McCall ↶ 1224 
    match cli.cmd {
d42369ab Andy McCall 1225 
        Cmd::Completions { shell } => {
1226 
            use clap::CommandFactory;
1227 
            clap_complete::generate(shell, &mut Cli::command(), "oxy", &mut std::io::stdout());
1228 
            Ok(0)
1229 
        }
1230 
        Cmd::Man { dir } => man(dir),
d069701a Andy McCall ↶ 1231 
        Cmd::Init { path, bare, store } => workspace::init(path, bare, store.as_deref()),
50a046e4 Andy McCall ↶ 1232 
        Cmd::Status { json } => workspace::status(json),
75167672 Andy McCall 1233 
        Cmd::Prompt {
1234 
            format,
1235 
            glyphs,
1236 
            color,
1237 
        } => workspace::prompt(&format, glyphs, color.as_deref()),
1238 
        Cmd::Commit {
1239 
            message,
6a81dbab Andy McCall ↶ 1240 
            file,
75167672 Andy McCall 1241 
            depends_on,
1242 
            paths,
1243 
            interactive,
1244 
            hunks,
6a81dbab Andy McCall ↶ 1245 
        } => {
1246 
            let message = match (message, file) {
1247 
                (Some(m), _) => m,
1248 
                (None, Some(f)) if f.as_os_str() == "-" => {
1249 
                    let mut s = String::new();
1250 
                    std::io::Read::read_to_string(&mut std::io::stdin(), &mut s)?;
1251 
                    s
1252 
                }
1253 
                (None, Some(f)) => std::fs::read_to_string(&f).map_err(|e| {
1254 
                    anyhow::anyhow!("reading the message from {}: {e}", f.display())
1255 
                })?,
1256 
                (None, None) => anyhow::bail!("a commit message is required (-m or -F)"),
1257 
            };
1258 
            workspace::commit(&message, &depends_on, &paths, interactive, &hunks)
1259 
        }
c6aa5bd9 Andy McCall ↶ 1260 
        Cmd::Cat { path, change } => workspace::cat(&path, change.as_deref()),
1261 
        Cmd::Root { json } => workspace::root(json),
1262 
        Cmd::Version { json } => workspace::version(json),
1263 
        Cmd::Discard { paths, hunks } => workspace::discard(&paths, &hunks),
1264 
        Cmd::Hunks { json } => workspace::hunks(json),
728da0f9 Andy McCall ↶ 1265 
        Cmd::Squash { change, into } => workspace::squash(&change, &into),
e266b7d4 Andy McCall ↶ 1266 
        Cmd::Rebase {
1267 
            change,
1268 
            onto,
1269 
            into_working_copy,
1270 
        } => workspace::rebase(&change, &onto, into_working_copy),
957fee30 Andy McCall ↶ 1271 
        Cmd::Blame { path, json } => workspace::blame(&path, json),
1272 
        Cmd::Bisect { cmd } => match cmd {
1273 
            BisectCmd::Start => workspace::bisect_start(),
1274 
            BisectCmd::Good { changes } => workspace::bisect_mark(Some(true), &changes),
1275 
            BisectCmd::Bad { changes } => workspace::bisect_mark(Some(false), &changes),
1276 
            BisectCmd::Skip => workspace::bisect_mark(None, &[]),
1277 
            BisectCmd::Run { command } => workspace::bisect_run(&command),
c6aa5bd9 Andy McCall ↶ 1278 
            BisectCmd::Status { json } => workspace::bisect_status(json),
957fee30 Andy McCall ↶ 1279 
            BisectCmd::Reset => workspace::bisect_reset(),
1280 
        },
75167672 Andy McCall 1281 
        Cmd::Log {
47ce8b8e Andy McCall ↶ 1282 
            revset,
75167672 Andy McCall 1283 
            limit,
1284 
            verbose,
1285 
            path,
83d61e80 Andy McCall ↶ 1286 
            lines,
75167672 Andy McCall 1287 
            json,
47ce8b8e Andy McCall ↶ 1288 
        } => workspace::log(
1289 
            revset.as_deref(),
1290 
            limit,
1291 
            verbose,
1292 
            path.as_deref(),
1293 
            lines.as_deref(),
1294 
            json,
1295 
        ),
c6aa5bd9 Andy McCall ↶ 1296 
        Cmd::Diff { change, json } => workspace::diff(change.as_deref(), json),
6a81dbab Andy McCall ↶ 1297 
        Cmd::Describe {
1298 
            message,
1299 
            change,
1300 
            json,
1301 
        } => match message {
1302 
            Some(m) => workspace::describe(&m, change.as_deref()),
1303 
            None if change.is_some() => {
1304 
                anyhow::bail!(
1305 
                    "naming works on the working copy; to change a head's message pass -m"
1306 
                )
1307 
            }
1308 
            None => workspace::describe_name(json),
1309 
        },
69953b50 Andy McCall ↶ 1310 
        Cmd::Amend {
1311 
            message,
1312 
            into,
1313 
            paths,
1314 
        } => workspace::amend(message.as_deref(), into.as_deref(), &paths),
23b217d7 Andy McCall ↶ 1315 
        Cmd::Split { change, paths } => workspace::split(&change, &paths),
2c9ddac3 Andy McCall ↶ 1316 
        Cmd::Abandon {
1317 
            change,
1318 
            revset,
1319 
            yes,
1320 
        } => workspace::abandon(change.as_deref(), revset.as_deref(), yes),
1321 
        Cmd::Show {
1322 
            change,
1323 
            revset,
0299076f Andy McCall ↶ 1324 
            stat,
2c9ddac3 Andy McCall ↶ 1325 
            json,
0299076f Andy McCall ↶ 1326 
        } => workspace::show(change.as_deref(), revset.as_deref(), stat, json),
1c2bd9ab Andy McCall ↶ 1327 
        Cmd::Checkout {
1328 
            changes,
1329 
            discard,
1330 
            carry,
1331 
        } => workspace::checkout(&changes, discard, carry),
c6aa5bd9 Andy McCall ↶ 1332 
        Cmd::Resolve { json } => workspace::resolve(json),
fce44ae9 Andy McCall ↶ 1333 
        Cmd::Undo => workspace::undo(),
b689779e Andy McCall ↶ 1334 
        Cmd::Gc {
1335 
            now,
1336 
            expire_snapshots,
1337 
            remote,
1338 
        } => match remote {
d8d93678 Andy McCall ↶ 1339 
            Some(name) => workspace::gc_remote(&name, now),
b689779e Andy McCall ↶ 1340 
            None => workspace::gc(now, expire_snapshots),
d8d93678 Andy McCall ↶ 1341 
        },
387335ff Andy McCall ↶ 1342 
        Cmd::Fsck { json } => workspace::fsck(json),
3e5772cc Andy McCall ↶ 1343 
        Cmd::Doctor { offline, json } => workspace::doctor(offline, json),
252e8cb2 Andy McCall ↶ 1344 
        Cmd::Checkpoint => workspace::checkpoint(),
98a1620a Andy McCall ↶ 1345 
        Cmd::Op { cmd } => match cmd {
1346 
            OpCmd::Log { limit, json } => workspace::op_log(limit, json),
1347 
            OpCmd::Restore { op, discard } => workspace::op_restore(&op, discard),
1348 
            OpCmd::Revert { op } => workspace::op_revert(&op),
1349 
        },
75167672 Andy McCall 1350 
        Cmd::Clone {
1351 
            url,
1352 
            dest,
1353 
            max_blob,
1354 
            sparse,
1355 
            depth,
14edbaaf Andy McCall ↶ 1356 
            recursive,
1357 
        } => sync::clone(&url, dest, max_blob.as_deref(), &sparse, depth, recursive),
2863456a Andy McCall ↶ 1358 
        Cmd::Deepen { depth, remote } => sync::deepen(&remote, depth),
7421309f Andy McCall ↶ 1359 
        Cmd::Sparse { paths } => workspace::sparse(&paths),
cdb5beba Andy McCall ↶ 1360 
        Cmd::Lock { path } => workspace::lock(&path),
1361 
        Cmd::Unlock { path } => workspace::unlock(&path),
4e88e774 Andy McCall ↶ 1362 
        Cmd::Workspace { cmd } => match cmd {
1363 
            WorkspaceCmd::Add { path, changes } => workspace::workspace_add(&path, &changes),
1196b29b Andy McCall ↶ 1364 
            WorkspaceCmd::List { json } => workspace::workspace_list(json),
4e88e774 Andy McCall ↶ 1365 
            WorkspaceCmd::Forget { workspace } => workspace::workspace_forget(&workspace),
1366 
        },
7b9809e6 Andy McCall ↶ 1367 
        Cmd::Bookmark { cmd } => match cmd {
4fe7d604 Andy McCall ↶ 1368 
            BookmarkCmd::Create {
1369 
                name,
1370 
                changes,
1371 
                upto,
1372 
                only,
1373 
            } => workspace::bookmark_create(&name, &changes, upto, only),
06d16dc2 Andy McCall ↶ 1374 
            BookmarkCmd::Set {
1375 
                name,
1376 
                changes,
1377 
                upto,
1378 
                only,
1379 
            } => workspace::bookmark_set(&name, &changes, upto, only),
7b9809e6 Andy McCall ↶ 1380 
            BookmarkCmd::Delete { name } => workspace::bookmark_delete(&name),
bf3a6781 Andy McCall ↶ 1381 
            BookmarkCmd::List { all, verbose, json } => {
1382 
                workspace::bookmark_list(all, verbose, json)
1383 
            }
1384 
            BookmarkCmd::Show { name, json } => workspace::bookmark_show(name.as_deref(), json),
61e3bce7 Andy McCall ↶ 1385 
            BookmarkCmd::Switch {
1386 
                name,
1387 
                discard,
1388 
                carry,
1389 
            } => workspace::bookmark_switch(&name, discard, carry),
7b9809e6 Andy McCall ↶ 1390 
        },
1391 
        Cmd::Merge { bookmark } => workspace::merge(&bookmark),
ff1f62fe Andy McCall ↶ 1392 
        Cmd::Auth { cmd } => match cmd {
1393 
            AuthCmd::Login {
1394 
                hub,
1395 
                with_token,
1396 
                ca,
1397 
            } => auth::login(hub.as_deref(), with_token, ca),
1398 
            AuthCmd::Status => auth::status(),
1399 
            AuthCmd::Logout { hub } => auth::logout(hub.as_deref()),
c895bc52 Andy McCall ↶ 1400 
            AuthCmd::Grant { hub } => auth::grant(hub.as_deref()),
ff1f62fe Andy McCall ↶ 1401 
        },
4dee277c Andy McCall ↶ 1402 
        Cmd::Submodule { cmd } => match cmd {
75167672 Andy McCall 1403 
            SubmoduleCmd::Add {
1404 
                url,
1405 
                path,
1406 
                bookmark,
1407 
            } => sync::submodule_add(&url, &path, bookmark.as_deref()),
4dee277c Andy McCall ↶ 1408 
            SubmoduleCmd::Update { init, paths } => sync::submodule_update(init, &paths),
c6aa5bd9 Andy McCall ↶ 1409 
            SubmoduleCmd::Status { json } => sync::submodule_status(json),
4dee277c Andy McCall ↶ 1410 
            SubmoduleCmd::Remove { path } => sync::submodule_remove(&path),
e59512f2 Andy McCall ↶ 1411 
        },
51d4862a Andy McCall ↶ 1412 
        Cmd::Witness {
1413 
            cmd:
1414 
                WitnessCmd::Serve {
1415 
                    name,
1416 
                    logs,
1417 
                    state,
1418 
                    bind,
1419 
                    tls_cert,
1420 
                    tls_key,
1421 
                },
1422 
        } => tlog::witness_serve(&name, &logs, state, &bind, tls_cert.zip(tls_key)),
e59512f2 Andy McCall ↶ 1423 
        Cmd::Tlog { cmd } => match cmd {
1424 
            TlogCmd::Verify {
1425 
                hub,
1426 
                key,
1427 
                all,
1428 
                json,
1429 
            } => tlog::verify(hub.as_deref(), key.as_deref(), all, json),
fc1a466a Andy McCall ↶ 1430 
        },
1431 
        Cmd::Receipt { cmd } => match cmd {
1432 
            ReceiptCmd::List { rev, json } => receipt::list(rev.as_deref(), json),
1433 
            ReceiptCmd::Show {
1434 
                receipt: r,
1435 
                rev,
1436 
                json,
1437 
            } => receipt::show(&r, rev.as_deref(), json),
1438 
            ReceiptCmd::Export {
1439 
                receipt: r,
1440 
                file,
1441 
                rev,
a39754d0 Andy McCall ↶ 1442 
                format,
1443 
            } => receipt::export(&r, &file, rev.as_deref(), &format),
fc1a466a Andy McCall ↶ 1444 
            ReceiptCmd::Verify { file, json } => receipt::verify(&file, json),
1445 
            ReceiptCmd::Import { file } => receipt::import(&file),
4dee277c Andy McCall ↶ 1446 
        },
132b884b Andy McCall ↶ 1447 
        Cmd::Tag { cmd } => match cmd {
75167672 Andy McCall 1448 
            TagCmd::Create {
1449 
                name,
1450 
                changes,
1451 
                message,
1452 
            } => workspace::tag_create(&name, &changes, &message),
b63fc7a7 Andy McCall ↶ 1453 
            TagCmd::Delete { name, reason } => workspace::tag_delete(&name, &reason),
1196b29b Andy McCall ↶ 1454 
            TagCmd::List { json } => workspace::tag_list(json),
132b884b Andy McCall ↶ 1455 
        },
fce44ae9 Andy McCall ↶ 1456 
        Cmd::Remote { cmd } => match cmd {
9aa39904 Andy McCall ↶ 1457 
            RemoteCmd::Add {
1458 
                name,
1459 
                url,
1460 
                profile,
1461 
                region,
1462 
                endpoint,
1463 
                credentials,
1464 
            } => sync::remote_add(
1465 
                &name,
1466 
                &url,
1467 
                &[
1468 
                    ("profile", profile),
1469 
                    ("region", region),
1470 
                    ("endpoint", endpoint),
1471 
                    ("credentials", credentials),
1472 
                ],
1473 
            ),
1474 
            RemoteCmd::Check { name } => sync::remote_check(&name),
fce44ae9 Andy McCall ↶ 1475 
            RemoteCmd::Remove { name } => sync::remote_remove(&name),
c6aa5bd9 Andy McCall ↶ 1476 
            RemoteCmd::List { json } => sync::remote_list(json),
fce44ae9 Andy McCall ↶ 1477 
        },
c6aa5bd9 Andy McCall ↶ 1478 
        Cmd::Fetch { remote, json } => sync::fetch(remote.as_deref(), json),
1479 
        Cmd::Pull { remote, json } => sync::pull(remote.as_deref(), json),
75167672 Andy McCall 1480 
        Cmd::Push {
1481 
            remote,
1482 
            force,
1483 
            bookmark,
f8c69576 Andy McCall ↶ 1484 
            delete,
75167672 Andy McCall 1485 
            json,
f8c69576 Andy McCall ↶ 1486 
        } => match delete {
1487 
            Some(name) => sync::push_delete(remote.as_deref(), &name, json),
1488 
            None => sync::push(remote.as_deref(), force, bookmark.as_deref(), json),
1489 
        },
75167672 Andy McCall 1490 
        Cmd::Serve {
1491 
            root,
1492 
            bind,
1493 
            tokens,
1494 
            tls_cert,
1495 
            tls_key,
1496 
        } => sync::serve(root, &bind, tokens, tls_cert.zip(tls_key)),
fce44ae9 Andy McCall ↶ 1497 
        Cmd::Identity { cmd } => match cmd {
75167672 Andy McCall 1498 
            IdentityCmd::Create {
1499 
                name,
1500 
                email,
1501 
                local,
1502 
                expires,
1503 
            } => identity::create(name, email, local, expires),
fce44ae9 Andy McCall ↶ 1504 
            IdentityCmd::Show => identity::show(),
a39754d0 Andy McCall ↶ 1505 
            IdentityCmd::Export { path, pem } => identity::export(path, pem),
119bbf50 Andy McCall ↶ 1506 
            IdentityCmd::SignChallenge { challenge, json } => {
1507 
                identity::sign_challenge(&challenge, json)
1508 
            }
28fc23d7 Andy McCall ↶ 1509 
            IdentityCmd::Rotate => identity::rotate(),
1510 
            IdentityCmd::Renew { expires } => identity::renew(expires),
1511 
            IdentityCmd::Revoke { key, reason } => identity::revoke(key.as_deref(), &reason),
1512 
            IdentityCmd::Delegate { cmd } => match cmd {
7ba155f2 Andy McCall ↶ 1513 
                DelegateCmd::Add {
1514 
                    identity_file,
1515 
                    scope,
1516 
                    expires,
1517 
                } => identity::delegate_add(&identity_file, &scope, expires.as_deref()),
28fc23d7 Andy McCall ↶ 1518 
                DelegateCmd::Remove { key } => identity::delegate_remove(&key),
1519 
                DelegateCmd::List => identity::delegate_list(),
1520 
            },
83e0677b Andy McCall ↶ 1521 
        },
75167672 Andy McCall 1522 
        Cmd::Git {
1523 
            cmd: GitCmd::Export { git_dir, branch },
1524 
        } => sync::git_export(&git_dir, branch.as_deref()),
1525 
        Cmd::Git {
d6e0d5b8 Andy McCall ↶ 1526 
            cmd: GitCmd::Fetch { url, branch, claim },
1527 
        } => sync::git_fetch(&url, &branch, claim),
75167672 Andy McCall 1528 
        Cmd::Git {
1529 
            cmd: GitCmd::Push { url, branch },
1530 
        } => sync::git_push(&url, &branch),
1531 
        Cmd::Git {
54e2e630 Andy McCall ↶ 1532 
            cmd: GitCmd::Recover,
1533 
        } => sync::git_recover(),
1534 
        Cmd::Git {
75167672 Andy McCall 1535 
            cmd:
1536 
                GitCmd::Import {
1537 
                    git_dir,
1538 
                    dest,
1539 
                    branch,
d6e0d5b8 Andy McCall ↶ 1540 
                    claim,
75167672 Andy McCall 1541 
                },
d6e0d5b8 Andy McCall ↶ 1542 
        } => sync::git_import(&git_dir, &dest, &branch, claim),
62794ecc Andy McCall ↶ 1543 
        Cmd::Git {
7eac74ab Andy McCall ↶ 1544 
            cmd:
1545 
                GitCmd::Verify {
1546 
                    git_dir,
1547 
                    branch,
1548 
                    last,
8b7986dd Andy McCall ↶ 1549 
                    max_differences,
7eac74ab Andy McCall ↶ 1550 
                },
8b7986dd Andy McCall ↶ 1551 
        } => sync::git_verify(&git_dir, &branch, last, max_differences),
83e0677b Andy McCall ↶ 1552 
        Cmd::Policy { cmd } => match cmd {
1553 
            PolicyCmd::Init => identity::policy_init(),
c6aa5bd9 Andy McCall ↶ 1554 
            PolicyCmd::Show { json } => identity::policy_show(json),
75167672 Andy McCall 1555 
            PolicyCmd::Grant {
1556 
                identity_file,
1557 
                pattern,
1558 
                out,
1559 
            } => identity::policy_grant(&identity_file, pattern.as_deref(), out),
3a6effc7 Andy McCall ↶ 1560 
            PolicyCmd::GrantSubject {
1561 
                subject,
1562 
                issuer,
1563 
                scope,
1564 
                pattern,
1565 
                out,
1566 
            } => identity::policy_grant_subject(&subject, &issuer, &scope, pattern.as_deref(), out),
28fc23d7 Andy McCall ↶ 1567 
            PolicyCmd::Revoke { key, out } => identity::policy_revoke(&key, out),
1568 
            PolicyCmd::Root { cmd } => match cmd {
75167672 Andy McCall 1569 
                RootCmd::Add { identity_file, out } => {
1570 
                    identity::policy_root_add(&identity_file, out)
1571 
                }
28fc23d7 Andy McCall ↶ 1572 
                RootCmd::Remove { key, out } => identity::policy_root_remove(&key, out),
1573 
                RootCmd::Threshold { n, out } => identity::policy_threshold(n, out),
1574 
            },
1575 
            PolicyCmd::Sign { proposal, out } => identity::policy_sign(&proposal, out),
fce44ae9 Andy McCall ↶ 1576 
        },
4213c41d Andy McCall ↶ 1577 
        Cmd::Seal {
b582948f Andy McCall ↶ 1578 
            flow: Some(url),
1579 
            job: Some(job),
1580 
            reject,
1581 
            json,
1582 
            ..
1583 
        } => approve::seal(&url, &job, reject, json),
1584 
        Cmd::Seal {
4213c41d Andy McCall ↶ 1585 
            changes,
1586 
            proposal: Some(url),
1587 
            json,
b582948f Andy McCall ↶ 1588 
            ..
4213c41d Andy McCall ↶ 1589 
        } if changes.is_empty() => proposal::seal(&url, json),
d82e4409 Andy McCall ↶ 1590 
        Cmd::Seal { changes, json, .. } => identity::seal(&changes, json),
1591 
        Cmd::Proposal { cmd } => match cmd {
1592 
            ProposalCmd::Show { url, json } => proposal::show(&url, json),
1593 
            ProposalCmd::Land { url, force } => proposal::land(&url, force),
1594 
        },
2c9ddac3 Andy McCall ↶ 1595 
        Cmd::Verify {
1596 
            change,
1597 
            revset,
1598 
            json,
1599 
        } => identity::verify(change.as_deref(), revset.as_deref(), json),
614f55e1 Andy McCall ↶ 1600 
        Cmd::Config {
1601 
            key,
1602 
            value,
1603 
            user,
1604 
            unset,
1605 
        } => identity::config(&key, value.as_deref().unwrap_or(""), user, unset),
fce44ae9 Andy McCall ↶ 1606 
    }
1607 
}
d42369ab Andy McCall 1608
1609 
#[cfg(test)]
1610 
mod help_tests {
1611 
    use super::Cli;
1612 
    use clap::CommandFactory;
1613
1614 
    /// Every command and every argument explains itself, so `--help`,
1615 
    /// completions and the man pages are complete.
1616 
    #[test]
1617 
    fn every_command_and_argument_has_help() {
1618 
        fn walk(cmd: &clap::Command, path: &str, missing: &mut Vec<String>) {
1619 
            let here = format!("{path} {}", cmd.get_name()).trim().to_string();
99e3e0af Andy McCall ↶ 1620 
            if cmd.get_about().is_none() && !path.is_empty() {
d42369ab Andy McCall 1621 
                missing.push(format!("{here} (command)"));
1622 
            }
1623 
            for a in cmd.get_arguments() {
1624 
                let id = a.get_id().as_str();
99e3e0af Andy McCall ↶ 1625 
                if id == "help" || id == "version" || (a.is_global_set() && !path.is_empty()) {
d42369ab Andy McCall 1626 
                    continue;
1627 
                }
1628 
                if a.get_help().is_none() && a.get_long_help().is_none() {
1629 
                    missing.push(format!("{here} {id}"));
1630 
                }
1631 
            }
1632 
            for sub in cmd.get_subcommands() {
1633 
                walk(sub, &here, missing);
1634 
            }
1635 
        }
1636 
        let mut missing = Vec::new();
1637 
        walk(&Cli::command(), "", &mut missing);
1638 
        assert!(
1639 
            missing.is_empty(),
1640 
            "{} without help:\n{}",
1641 
            missing.len(),
1642 
            missing.join("\n")
1643 
        );
1644 
    }
1645 
}