OXYGENHUB
# 2951f8023f40 oxygen / src / cli / mod.rs
41.7 KiB · Rust · last changed Execution receipts: the receipt object and attestation 1 month ago source blame history raw
1 
//! Command-line definitions and dispatch.
2
3 
mod format;
4 
mod identity;
5 
mod json;
6 
mod proposal;
7 
mod receipt;
8 
mod sync;
9 
pub mod ui;
10 
mod workspace;
11
12 
use anyhow::{Context, Result};
13 
use clap::{Parser, Subcommand};
14 
use oxy_core::repo::Repo;
15 
use std::path::PathBuf;
16
17 
#[derive(Parser)]
18 
#[command(
19 
    name = "oxy",
20 
    version,
21 
    about = "Oxygen: breathing fresh air into version control"
22 
)]
23 
struct Cli {
24 
    /// Plain output: no colour, no spinner (also implied by NO_COLOR or a non-terminal)
25 
    #[arg(long, global = true)]
26 
    plain: bool,
27 
    #[command(subcommand)]
28 
    cmd: Cmd,
29 
}
30
31 
#[derive(Subcommand)]
32 
enum Cmd {
33 
    /// Create a repository in PATH (default: current directory)
34 
    Init {
35 
        /// Directory to create the repository in (default: the current directory)
36 
        path: Option<PathBuf>,
37 
        /// No working copy: an object store and references only, for hosting
38 
        #[arg(long)]
39 
        bare: bool,
40 
    },
41 
    /// Clone a repository from a local path or an http(s) URL
42 
    Clone {
43 
        /// Local path or http(s) URL of the repository
44 
        url: String,
45 
        /// Directory to clone into (default: the last part of the URL)
46 
        dest: Option<PathBuf>,
47 
        /// Leave blobs larger than this (e.g. 1M) to be fetched on first read
48 
        #[arg(long)]
49 
        max_blob: Option<String>,
50 
        /// Materialize only these paths (repeatable); implies lazy blobs
51 
        #[arg(long = "sparse")]
52 
        sparse: Vec<String>,
53 
        /// Shallow clone: fetch only this many levels of history below the heads
54 
        #[arg(long)]
55 
        depth: Option<u32>,
56 
    },
57 
    /// Fetch more history below a shallow clone's boundary
58 
    Deepen {
59 
        /// Levels of history to add below the boundary
60 
        #[arg(default_value_t = 10)]
61 
        depth: u32,
62 
        /// Remote to fetch the history from
63 
        #[arg(long, default_value = "origin")]
64 
        remote: String,
65 
    },
66 
    /// Show or set the sparse filter (paths to materialize); re-checks out the bookmark
67 
    Sparse {
68 
        /// Paths to materialize; none prints the current filter
69 
        paths: Vec<String>,
70 
    },
71 
    /// Show the working copy: changed paths and conflicts
72 
    Status {
73 
        /// Machine-readable output: paths, and every conflict with its kind and contributing changes
74 
        #[arg(long)]
75 
        json: bool,
76 
    },
77 
    /// One-line summary for shell prompts; fast and records nothing
78 
    Prompt {
79 
        /// 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
80 
        #[arg(long, default_value = oxy_core::repo::DEFAULT_PROMPT_FORMAT)]
81 
        format: String,
82 
        /// Glyph format (%i %b %c %s%U%O) instead of the plain default
83 
        #[arg(long)]
84 
        glyphs: bool,
85 
        /// Colour by state (cyan clean, yellow dirty, red conflicted): raw escapes, or guarded for a bash or zsh PS1
86 
        #[arg(long, value_parser = ["raw", "bash", "zsh"])]
87 
        color: Option<String>,
88 
    },
89 
    /// Record the working copy as a change on the current bookmark
90 
    Commit {
91 
        /// The change's message: a subject line, then optionally a blank line and a body
92 
        #[arg(short, long, required_unless_present = "file", conflicts_with = "file")]
93 
        message: Option<String>,
94 
        /// Read the message from FILE (`-` for standard input)
95 
        #[arg(short = 'F', long, value_name = "FILE")]
96 
        file: Option<PathBuf>,
97 
        /// Extra explicit dependencies (ChangeId prefix, #hash prefix)
98 
        #[arg(long = "depends-on")]
99 
        depends_on: Vec<String>,
100 
        /// Commit only these paths; the rest stays as uncommitted work
101 
        paths: Vec<String>,
102 
        /// Choose hunks one by one
103 
        #[arg(short, long)]
104 
        interactive: bool,
105 
        /// Commit these hunks (as `oxy hunks` numbers them), comma separated
106 
        #[arg(long, value_delimiter = ',')]
107 
        hunks: Vec<usize>,
108 
    },
109 
    /// Fold CHANGE into one of its dependencies (keeps that change's id)
110 
    Squash {
111 
        /// The change to fold (ChangeId prefix, #hash prefix)
112 
        change: String,
113 
        /// The dependency that absorbs it
114 
        #[arg(long)]
115 
        into: String,
116 
    },
117 
    /// Re-express CHANGE against another base state
118 
    Rebase {
119 
        /// The change to re-express (ChangeId prefix, #hash prefix)
120 
        change: String,
121 
        /// The changes, bookmark or tag whose state becomes the new base
122 
        #[arg(long, required = true, num_args = 1..)]
123 
        onto: Vec<String>,
124 
    },
125 
    /// Show which change introduced each line of a file
126 
    Blame {
127 
        /// File to annotate, relative to the repository root
128 
        path: String,
129 
        /// Machine-readable output: one JSON document on stdout
130 
        #[arg(long)]
131 
        json: bool,
132 
    },
133 
    /// Find the change that introduced a regression
134 
    Bisect {
135 
        #[command(subcommand)]
136 
        cmd: BisectCmd,
137 
    },
138 
    /// List changes reachable from the bookmark and the working copy
139 
    Log {
140 
        /// Show at most this many changes
141 
        #[arg(short = 'n', long)]
142 
        limit: Option<usize>,
143 
        /// Show full messages, dependencies, and signatures
144 
        #[arg(short, long)]
145 
        verbose: bool,
146 
        /// Only changes touching this path (renames followed)
147 
        #[arg(long)]
148 
        path: Option<String>,
149 
        /// Only changes that wrote or deleted lines START to END of PATH
150 
        /// (numbered as in the working copy's base), or deleted lines from
151 
        /// between them: the history of a function
152 
        #[arg(short = 'L', value_name = "START,END:PATH", conflicts_with = "path")]
153 
        lines: Option<String>,
154 
        /// Machine-readable output: one JSON document on stdout
155 
        #[arg(long)]
156 
        json: bool,
157 
    },
158 
    /// Show what the working copy changes against its base
159 
    Diff {
160 
        /// A change instead of the working copy
161 
        change: Option<String>,
162 
        /// Machine-readable output: one JSON document on stdout
163 
        #[arg(long)]
164 
        json: bool,
165 
    },
166 
    /// Print a file as it is in a state (default: the working copy's base)
167 
    Cat {
168 
        /// File to print, relative to the repository root
169 
        path: String,
170 
        /// A change, bookmark, or tag
171 
        #[arg(short = 'r', long)]
172 
        change: Option<String>,
173 
    },
174 
    /// Print the repository root, workspace, and bookmark
175 
    Root {
176 
        /// Machine-readable output: one JSON document on stdout
177 
        #[arg(long)]
178 
        json: bool,
179 
    },
180 
    /// Print the version of oxy, its repository format, and protocol
181 
    Version {
182 
        /// Machine-readable output: one JSON document on stdout
183 
        #[arg(long)]
184 
        json: bool,
185 
    },
186 
    /// Restore paths to the working copy's base, or undo chosen hunks
187 
    Discard {
188 
        /// Paths to restore; none with --hunks, or everything with neither
189 
        paths: Vec<String>,
190 
        /// Hunk indices as `oxy hunks` numbers them, comma separated
191 
        #[arg(long, value_delimiter = ',')]
192 
        hunks: Vec<usize>,
193 
    },
194 
    /// List the working copy's hunks, numbered as commit --hunks expects
195 
    Hunks {
196 
        /// Machine-readable output: one JSON document on stdout
197 
        #[arg(long)]
198 
        json: bool,
199 
    },
200 
    /// With -m, change the message of a head; without, name the working
201 
    /// copy for a build: its tag, or the nearest tag plus distance and
202 
    /// change, or the bookmark and change, and -dirty
203 
    Describe {
204 
        /// The new message
205 
        #[arg(short, long)]
206 
        message: Option<String>,
207 
        /// The head to describe (default: the one the working copy sits on)
208 
        change: Option<String>,
209 
        /// Machine-readable output (naming only)
210 
        #[arg(long, conflicts_with = "message")]
211 
        json: bool,
212 
    },
213 
    /// Fold the working copy into the head it sits on, or into CHANGE with --into
214 
    Amend {
215 
        /// Replace the message too
216 
        #[arg(short, long)]
217 
        message: Option<String>,
218 
        /// Amend an older change; the edits must touch only lines it already knows
219 
        #[arg(long)]
220 
        into: Option<String>,
221 
    },
222 
    /// Split a head: the named paths become a separate first change
223 
    Split {
224 
        /// The head to split
225 
        change: String,
226 
        /// Paths whose edits become the first change
227 
        paths: Vec<String>,
228 
    },
229 
    /// Drop a head from the bookmark; its content stays on disk as uncommitted work
230 
    Abandon {
231 
        /// The head to drop (ChangeId prefix, #hash prefix)
232 
        change: String,
233 
    },
234 
    /// Show one change (ChangeId prefix, #hash prefix, or @)
235 
    Show {
236 
        /// ChangeId prefix, #hash prefix, or @ for the working copy
237 
        change: String,
238 
        /// Machine-readable output: one JSON document on stdout
239 
        #[arg(long)]
240 
        json: bool,
241 
    },
242 
    /// Move the working copy to the state formed by CHANGE... (default: the bookmark heads)
243 
    Checkout {
244 
        /// Changes whose state to check out (default: the bookmark heads)
245 
        changes: Vec<String>,
246 
        /// Throw away uncommitted working-copy changes
247 
        #[arg(long)]
248 
        discard: bool,
249 
        /// Take uncommitted changes along; refused when the target has
250 
        /// other versions of the files they touch
251 
        #[arg(long, conflicts_with = "discard")]
252 
        carry: bool,
253 
    },
254 
    /// Report which conflicts of the working copy's base are resolved by the current files
255 
    Resolve {
256 
        /// Machine-readable output: one JSON document on stdout
257 
        #[arg(long)]
258 
        json: bool,
259 
    },
260 
    /// Undo the last operation
261 
    Undo,
262 
    /// Write a checkpoint of the current bookmark's state now
263 
    Checkpoint,
264 
    /// Print a shell completion script: `oxy completions bash > ~/.local/share/bash-completion/completions/oxy`
265 
    Completions {
266 
        /// bash, zsh, fish, elvish or powershell
267 
        shell: clap_complete::Shell,
268 
    },
269 
    /// Write man pages (oxy.1 and one per command) into DIR, or print oxy.1
270 
    Man {
271 
        /// Directory to write every page into, e.g. ~/.local/share/man/man1
272 
        #[arg(long)]
273 
        dir: Option<PathBuf>,
274 
    },
275 
    /// Check the identity, configuration and remotes, and say what to do about any problem
276 
    Doctor {
277 
        /// Do not contact the remotes
278 
        #[arg(long)]
279 
        offline: bool,
280 
        /// Machine-readable output: one JSON document on stdout
281 
        #[arg(long)]
282 
        json: bool,
283 
    },
284 
    /// Check the repository's integrity: objects, operation log, references, signatures, checkpoints
285 
    Fsck {
286 
        /// Machine-readable output: one JSON document on stdout
287 
        #[arg(long)]
288 
        json: bool,
289 
    },
290 
    /// Pack loose objects and prune unreachable ones older than the grace period
291 
    Gc {
292 
        /// Ignore the grace period (core.gc-grace) and prune immediately
293 
        #[arg(long)]
294 
        now: bool,
295 
    },
296 
    /// List operations
297 
    #[command(name = "op")]
298 
    Op {
299 
        #[command(subcommand)]
300 
        cmd: OpCmd,
301 
    },
302 
    /// Take the advisory local lock on a lockable file, making it writable
303 
    Lock {
304 
        /// The lockable file
305 
        path: String,
306 
    },
307 
    /// Release the local lock and make the file read-only again
308 
    Unlock {
309 
        /// The locked file
310 
        path: String,
311 
    },
312 
    /// Workspaces: extra checkout directories sharing this repository
313 
    Workspace {
314 
        #[command(subcommand)]
315 
        cmd: WorkspaceCmd,
316 
    },
317 
    /// Bookmarks: named states; each workspace works on one
318 
    Bookmark {
319 
        #[command(subcommand)]
320 
        cmd: BookmarkCmd,
321 
    },
322 
    /// Union another bookmark's heads into the current one (no merge change)
323 
    Merge {
324 
        /// The bookmark whose heads to add
325 
        bookmark: String,
326 
    },
327 
    /// Subrepositories: nested repositories pinned to a state
328 
    Submodule {
329 
        #[command(subcommand)]
330 
        cmd: SubmoduleCmd,
331 
    },
332 
    /// Execution receipts: signed records of what a runner ran on a state
333 
    Receipt {
334 
        #[command(subcommand)]
335 
        cmd: ReceiptCmd,
336 
    },
337 
    /// Tags: immutable named states
338 
    Tag {
339 
        #[command(subcommand)]
340 
        cmd: TagCmd,
341 
    },
342 
    /// Manage remotes
343 
    Remote {
344 
        #[command(subcommand)]
345 
        cmd: RemoteCmd,
346 
    },
347 
    /// Fetch every bookmark of a remote into its tracking references
348 
    Fetch {
349 
        /// Remote name (default: origin)
350 
        remote: Option<String>,
351 
        /// Machine-readable output: one JSON document on stdout
352 
        #[arg(long)]
353 
        json: bool,
354 
    },
355 
    /// Fetch, then union the remote bookmark into the local one (no merge change)
356 
    Pull {
357 
        /// Remote name (default: origin)
358 
        remote: Option<String>,
359 
        /// Machine-readable output: one JSON document on stdout
360 
        #[arg(long)]
361 
        json: bool,
362 
    },
363 
    /// Push the current bookmark to a remote
364 
    Push {
365 
        /// Remote name (default: origin)
366 
        remote: Option<String>,
367 
        /// Allow dropping heads the remote has
368 
        #[arg(long)]
369 
        force: bool,
370 
        /// Push this bookmark instead of the workspace's current one
371 
        #[arg(short = 'b', long)]
372 
        bookmark: Option<String>,
373 
        /// Delete this bookmark on the remote (never its default bookmark);
374 
        /// the local bookmark is kept
375 
        #[arg(long, value_name = "NAME", conflicts_with_all = ["bookmark", "force"])]
376 
        delete: Option<String>,
377 
        /// Machine-readable output: one JSON document on stdout
378 
        #[arg(long)]
379 
        json: bool,
380 
    },
381 
    /// Serve repositories under ROOT over HTTPS (with --tls-cert/--tls-key) or plain HTTP
382 
    Serve {
383 
        /// Directory with one repository per subdirectory
384 
        #[arg(long, default_value = ".")]
385 
        root: PathBuf,
386 
        /// Address and port to listen on
387 
        #[arg(long, default_value = "127.0.0.1:8890")]
388 
        bind: String,
389 
        /// Bearer token allowed to push (repeatable); none means open
390 
        #[arg(long = "token")]
391 
        tokens: Vec<String>,
392 
        /// PEM certificate chain; enables HTTPS together with --tls-key
393 
        #[arg(long, requires = "tls_key")]
394 
        tls_cert: Option<PathBuf>,
395 
        /// PEM private key
396 
        #[arg(long, requires = "tls_cert")]
397 
        tls_key: Option<PathBuf>,
398 
    },
399 
    /// Manage the signing identity
400 
    Identity {
401 
        #[command(subcommand)]
402 
        cmd: IdentityCmd,
403 
    },
404 
    /// Seal changes with your key: named ones, or every change on the current bookmark you can authenticate but have not
405 
    Seal {
406 
        /// Changes to seal (default: every change on the bookmark you can authenticate and have not sealed)
407 
        changes: Vec<String>,
408 
        /// Seal every change of a hub proposal and push the seal (your approval)
409 
        #[arg(long, conflicts_with = "changes")]
410 
        proposal: Option<String>,
411 
        /// Machine-readable output: one JSON document on stdout
412 
        #[arg(long)]
413 
        json: bool,
414 
    },
415 
    /// Hub proposals: show one, or land it from this client
416 
    Proposal {
417 
        #[command(subcommand)]
418 
        cmd: ProposalCmd,
419 
    },
420 
    /// Verify the signatures on a change (default: every change in the log)
421 
    Verify {
422 
        /// The change to verify (default: every change in the log)
423 
        change: Option<String>,
424 
        /// Machine-readable output: one JSON document on stdout
425 
        #[arg(long)]
426 
        json: bool,
427 
    },
428 
    /// Git interoperability
429 
    Git {
430 
        #[command(subcommand)]
431 
        cmd: GitCmd,
432 
    },
433 
    /// Manage the trust policy (who may update which bookmarks)
434 
    Policy {
435 
        #[command(subcommand)]
436 
        cmd: PolicyCmd,
437 
    },
438 
    /// Set a configuration key (author.*, core.sign, core.op-retention, core.gc-grace, core.checkpoint-interval, filter.max-blob, filter.paths, workspace.bookmark, remote.<name>.url|token|ca)
439 
    Config {
440 
        /// The key, such as author.name or remote.origin.token
441 
        key: String,
442 
        /// The value to set
443 
        value: String,
444 
        /// Write to the user file (~/.config/oxy/config.toml) instead of this repository
445 
        #[arg(long)]
446 
        user: bool,
447 
    },
448 
}
449
450 
#[derive(Subcommand)]
451 
enum OpCmd {
452 
    /// List operations, newest first
453 
    Log {
454 
        /// Machine-readable output: one JSON document on stdout
455 
        #[arg(long)]
456 
        json: bool,
457 
    },
458 
}
459
460 
#[derive(Subcommand)]
461 
enum WorkspaceCmd {
462 
    /// Create a workspace at PATH checked out on CHANGE... (default: the bookmark heads)
463 
    Add {
464 
        /// Directory for the new workspace (must be empty or absent)
465 
        path: PathBuf,
466 
        /// Changes whose state to check out there
467 
        changes: Vec<String>,
468 
    },
469 
    /// List workspaces and their working-copy changes
470 
    List {
471 
        /// Machine-readable output: one JSON document on stdout
472 
        #[arg(long)]
473 
        json: bool,
474 
    },
475 
    /// Stop tracking a workspace (by id prefix or path); its files stay
476 
    Forget {
477 
        /// Workspace id prefix or path
478 
        workspace: String,
479 
    },
480 
}
481
482 
#[derive(Subcommand)]
483 
enum BisectCmd {
484 
    /// Begin; remembers where the working copy was
485 
    Start,
486 
    /// Mark CHANGE... (or the state under test) as good
487 
    Good {
488 
        /// Changes known to be good (default: the state under test)
489 
        changes: Vec<String>,
490 
    },
491 
    /// Mark CHANGE... (or the state under test) as bad
492 
    Bad {
493 
        /// Changes known to be bad (default: the state under test)
494 
        changes: Vec<String>,
495 
    },
496 
    /// The state under test cannot be tested; try another
497 
    Skip,
498 
    /// Run a command for each step: exit 0 good, 125 skip, else bad
499 
    Run {
500 
        /// Command and arguments to run at each step
501 
        #[arg(required = true, trailing_var_arg = true)]
502 
        command: Vec<String>,
503 
    },
504 
    /// Where the search stands
505 
    Status {
506 
        /// Machine-readable output: one JSON document on stdout
507 
        #[arg(long)]
508 
        json: bool,
509 
    },
510 
    /// Restore the working copy and forget the search
511 
    Reset,
512 
}
513
514 
#[derive(Subcommand)]
515 
enum BookmarkCmd {
516 
    /// Create a bookmark at CHANGE... (default: the working copy's base)
517 
    Create {
518 
        /// Name of the new bookmark
519 
        name: String,
520 
        /// Its heads (default: the working copy's base)
521 
        changes: Vec<String>,
522 
    },
523 
    /// Point an existing bookmark at CHANGE...
524 
    Set {
525 
        /// The bookmark to move
526 
        name: String,
527 
        /// Its new heads
528 
        changes: Vec<String>,
529 
    },
530 
    /// Remove a bookmark; its changes stay
531 
    Delete {
532 
        /// The bookmark to remove
533 
        name: String,
534 
    },
535 
    /// List bookmarks with their heads and difference from origin
536 
    List {
537 
        /// Machine-readable output: one JSON document on stdout
538 
        #[arg(long)]
539 
        json: bool,
540 
    },
541 
    /// Make NAME this workspace's bookmark and check it out. Uncommitted work stops it; --carry takes the work along, --discard drops it
542 
    Switch {
543 
        /// The bookmark to work on
544 
        name: String,
545 
        /// Throw away uncommitted working-copy changes
546 
        #[arg(long)]
547 
        discard: bool,
548 
        /// Take uncommitted changes along; refused when NAME has other
549 
        /// versions of the files they touch
550 
        #[arg(long, conflicts_with = "discard")]
551 
        carry: bool,
552 
    },
553 
}
554
555 
#[derive(Subcommand)]
556 
enum SubmoduleCmd {
557 
    /// Clone URL (Oxygen or Git) into PATH and register it in .oxymodules
558 
    Add {
559 
        /// URL or path of the Oxygen or Git repository
560 
        url: String,
561 
        /// Where to put it, relative to the repository root
562 
        path: String,
563 
        /// Bookmark (Oxygen) or branch (Git) to check out and track
564 
        #[arg(long)]
565 
        bookmark: Option<String>,
566 
    },
567 
    /// Bring nested repositories to their pins
568 
    Update {
569 
        /// Clone nested repositories that are absent
570 
        #[arg(long)]
571 
        init: bool,
572 
        /// Subrepos to update (default: all)
573 
        paths: Vec<String>,
574 
    },
575 
    /// List subrepos with their pins and on-disk state
576 
    Status {
577 
        /// Machine-readable output: one JSON document on stdout
578 
        #[arg(long)]
579 
        json: bool,
580 
    },
581 
    /// Unregister PATH; the directory stays, the node goes with the next commit
582 
    Remove {
583 
        /// The subrepo to unregister
584 
        path: String,
585 
    },
586 
}
587
588 
#[derive(Subcommand)]
589 
enum ReceiptCmd {
590 
    /// The receipts kept for a state (default: the bookmark heads)
591 
    List {
592 
        /// Change, bookmark or tag whose state to look at
593 
        rev: Option<String>,
594 
        /// Machine-readable output: one JSON document on stdout
595 
        #[arg(long)]
596 
        json: bool,
597 
    },
598 
    /// One receipt in full, and whether its signature verifies
599 
    Show {
600 
        /// The receipt (a prefix of its hash, as `list` shows it)
601 
        receipt: String,
602 
        /// Change, bookmark or tag whose state holds it
603 
        #[arg(long)]
604 
        rev: Option<String>,
605 
        /// Machine-readable output: one JSON document on stdout
606 
        #[arg(long)]
607 
        json: bool,
608 
    },
609 
    /// Write a signed receipt to FILE
610 
    Export {
611 
        /// The receipt (a prefix of its hash, as `list` shows it)
612 
        receipt: String,
613 
        /// Where to write it
614 
        file: String,
615 
        /// Change, bookmark or tag whose state holds it
616 
        #[arg(long)]
617 
        rev: Option<String>,
618 
    },
619 
    /// Check a signed receipt in FILE without keeping it
620 
    Verify {
621 
        /// A signed receipt, as a runner or `export` writes it
622 
        file: String,
623 
        /// Machine-readable output: one JSON document on stdout
624 
        #[arg(long)]
625 
        json: bool,
626 
    },
627 
    /// Verify a signed receipt in FILE and keep it with its state
628 
    Import {
629 
        /// A signed receipt, as a runner or `export` writes it
630 
        file: String,
631 
    },
632 
}
633
634 
#[derive(Subcommand)]
635 
enum TagCmd {
636 
    /// Tag the state of CHANGE... (default: the bookmark heads)
637 
    Create {
638 
        /// Name of the tag; tags never move
639 
        name: String,
640 
        /// Changes whose state to tag (default: the bookmark heads)
641 
        changes: Vec<String>,
642 
        /// A message recorded with the tag
643 
        #[arg(short, long, default_value = "")]
644 
        message: String,
645 
    },
646 
    /// List tags and the states they name
647 
    List {
648 
        /// Machine-readable output: one JSON document on stdout
649 
        #[arg(long)]
650 
        json: bool,
651 
    },
652 
}
653
654 
#[derive(Subcommand)]
655 
enum RemoteCmd {
656 
    /// Add a remote
657 
    Add {
658 
        /// Name to refer to the remote by, such as origin
659 
        name: String,
660 
        /// Local path or http(s) URL of the repository
661 
        url: String,
662 
    },
663 
    /// Remove a remote
664 
    Remove {
665 
        /// The remote to remove
666 
        name: String,
667 
    },
668 
    /// List remotes and their URLs
669 
    List {
670 
        /// Machine-readable output: one JSON document on stdout
671 
        #[arg(long)]
672 
        json: bool,
673 
    },
674 
}
675
676 
#[derive(Subcommand)]
677 
enum ProposalCmd {
678 
    /// Show a proposal by its hub URL
679 
    Show {
680 
        /// The proposal's URL on the hub
681 
        url: String,
682 
        /// Machine-readable output: one JSON document on stdout
683 
        #[arg(long)]
684 
        json: bool,
685 
    },
686 
    /// Fetch the proposal's changes, set the target bookmark to the projected state, and push with your key
687 
    Land {
688 
        /// The proposal's URL on the hub
689 
        url: String,
690 
        /// Land even when the hub reports blockers
691 
        #[arg(long)]
692 
        force: bool,
693 
    },
694 
}
695
696 
#[derive(Subcommand)]
697 
enum IdentityCmd {
698 
    /// Generate a composite Ed25519 + ML-DSA-65 key pair and make it your author identity
699 
    Create {
700 
        /// Your name (default: author.name)
701 
        #[arg(long)]
702 
        name: Option<String>,
703 
        /// Your email (default: author.email)
704 
        #[arg(long)]
705 
        email: Option<String>,
706 
        /// Record the author in this repository only, not in the user config
707 
        #[arg(long)]
708 
        local: bool,
709 
        /// Expire the identity this many days from now
710 
        #[arg(long)]
711 
        expires: Option<u64>,
712 
    },
713 
    /// Show the configured identity
714 
    Show,
715 
    /// Write your identity object to a file, to hand to a policy holder
716 
    Export {
717 
        /// File to write (default: <key>.identity in the current directory)
718 
        path: Option<PathBuf>,
719 
    },
720 
    /// Sign a host's challenge (hex, at least 16 bytes) to prove you hold your key; prints the signature as hex
721 
    SignChallenge {
722 
        /// The host's challenge, as hex
723 
        challenge: String,
724 
        /// Machine-readable output: one JSON document on stdout
725 
        #[arg(long)]
726 
        json: bool,
727 
    },
728 
    /// Move to a fresh key pair; the policy follows if it names your key
729 
    Rotate,
730 
    /// Re-issue your identity with a new expiry (in days from now; 0 = never)
731 
    Renew {
732 
        /// Days from now until it expires; 0 for never
733 
        #[arg(long)]
734 
        expires: u64,
735 
    },
736 
    /// Revoke a key: yours by default, or any key if you hold a policy root
737 
    Revoke {
738 
        /// KeyId prefix (default: your own key)
739 
        key: Option<String>,
740 
        /// Why, recorded in the revocation
741 
        #[arg(long, default_value = "")]
742 
        reason: String,
743 
    },
744 
    /// Keys allowed to sign or seal on your behalf
745 
    Delegate {
746 
        #[command(subcommand)]
747 
        cmd: DelegateCmd,
748 
    },
749 
}
750
751 
#[derive(Subcommand)]
752 
enum DelegateCmd {
753 
    /// Add a delegate from an exported identity file
754 
    Add {
755 
        /// The delegate's exported identity file
756 
        identity_file: PathBuf,
757 
    },
758 
    /// Remove a delegate by KeyId prefix
759 
    Remove {
760 
        /// KeyId prefix of the delegate
761 
        key: String,
762 
    },
763 
    /// List delegates
764 
    List,
765 
}
766
767 
#[derive(Subcommand)]
768 
enum GitCmd {
769 
    /// Export the current bookmark to a Git repository (created bare if absent)
770 
    Export {
771 
        /// Git repository to write to (created bare if absent)
772 
        git_dir: PathBuf,
773 
        /// Git branch to write (default: the bookmark name)
774 
        #[arg(long)]
775 
        branch: Option<String>,
776 
    },
777 
    /// Fetch a branch from a Git remote (path or URL) into the current bookmark
778 
    Fetch {
779 
        /// Git remote: a path or URL
780 
        url: String,
781 
        /// Branch to fetch
782 
        #[arg(long, default_value = "main")]
783 
        branch: String,
784 
    },
785 
    /// Push the current bookmark to a branch of a Git remote (fetch first)
786 
    Push {
787 
        /// Git remote: a path or URL
788 
        url: String,
789 
        /// Branch to push to
790 
        #[arg(long, default_value = "main")]
791 
        branch: String,
792 
    },
793 
    /// Check this repository's import of a Git branch: every commit's tree must be reproduced exactly
794 
    Verify {
795 
        /// The Git repository the import came from
796 
        git_dir: PathBuf,
797 
        /// Branch that was imported
798 
        #[arg(long, default_value = "main")]
799 
        branch: String,
800 
    },
801 
    /// Import a Git branch into a new Oxygen repository at DEST
802 
    Import {
803 
        /// Git repository to read
804 
        git_dir: PathBuf,
805 
        /// Directory for the new Oxygen repository
806 
        dest: PathBuf,
807 
        /// Branch to import
808 
        #[arg(long, default_value = "main")]
809 
        branch: String,
810 
    },
811 
}
812
813 
#[derive(Subcommand)]
814 
enum PolicyCmd {
815 
    /// Create the initial policy with your identity as the only root
816 
    Init,
817 
    /// Show the current policy
818 
    Show {
819 
        /// Machine-readable output: one JSON document on stdout
820 
        #[arg(long)]
821 
        json: bool,
822 
    },
823 
    /// Allow an identity (from `oxy identity export`) to update bookmarks
824 
    Grant {
825 
        /// The identity to grant, exported with `oxy identity export`
826 
        identity_file: PathBuf,
827 
        /// Reference pattern the grant applies to (default: every bookmark)
828 
        #[arg(long)]
829 
        pattern: Option<String>,
830 
        /// Where to write the proposal when more root signatures are needed
831 
        #[arg(long)]
832 
        out: Option<PathBuf>,
833 
    },
834 
    /// Revoke a key (KeyId prefix of an identity in the policy)
835 
    Revoke {
836 
        /// KeyId prefix of the identity
837 
        key: String,
838 
        /// Where to write the proposal when more root signatures are needed
839 
        #[arg(long)]
840 
        out: Option<PathBuf>,
841 
    },
842 
    /// Manage root keys and the signature threshold for policy updates
843 
    Root {
844 
        #[command(subcommand)]
845 
        cmd: RootCmd,
846 
    },
847 
    /// Add your root signature to a proposal file; applies it once the threshold is met
848 
    Sign {
849 
        /// The proposal file to sign
850 
        proposal: PathBuf,
851 
        /// Where to write the proposal if it still needs signatures (default: in place)
852 
        #[arg(long)]
853 
        out: Option<PathBuf>,
854 
    },
855 
}
856
857 
#[derive(Subcommand)]
858 
enum RootCmd {
859 
    /// Make an exported identity a root key
860 
    Add {
861 
        /// The identity to make a root, exported with `oxy identity export`
862 
        identity_file: PathBuf,
863 
        /// Where to write the proposal when more root signatures are needed
864 
        #[arg(long)]
865 
        out: Option<PathBuf>,
866 
    },
867 
    /// Remove a root key by KeyId prefix
868 
    Remove {
869 
        /// KeyId prefix of the root key
870 
        key: String,
871 
        /// Where to write the proposal when more root signatures are needed
872 
        #[arg(long)]
873 
        out: Option<PathBuf>,
874 
    },
875 
    /// Require this many root signatures on policy updates
876 
    Threshold {
877 
        /// Number of root signatures
878 
        n: u32,
879 
        /// Where to write the proposal when more root signatures are needed
880 
        #[arg(long)]
881 
        out: Option<PathBuf>,
882 
    },
883 
}
884
885 
/// Open the repository containing the current directory.
886 
fn open() -> Result<Repo> {
887 
    Repo::open(&std::env::current_dir()?).context("opening repository")
888 
}
889
890 
/// `oxy man`: every page into `dir`, or the top-level page on stdout.
891 
fn man(dir: Option<PathBuf>) -> Result<i32> {
892 
    use clap::CommandFactory;
893 
    let cmd = Cli::command();
894 
    match dir {
895 
        Some(dir) => {
896 
            std::fs::create_dir_all(&dir)?;
897 
            clap_mangen::generate_to(cmd, &dir)?;
898 
            let pages = std::fs::read_dir(&dir)?
899 
                .filter(|e| {
900 
                    e.as_ref()
901 
                        .is_ok_and(|e| e.path().extension().is_some_and(|x| x == "1"))
902 
                })
903 
                .count();
904 
            println!(
905 
                "{}",
906 
                ui::done(format!("Wrote {pages} man pages to {}", dir.display()))
907 
            );
908 
        }
909 
        None => clap_mangen::Man::new(cmd).render(&mut std::io::stdout())?,
910 
    }
911 
    Ok(0)
912 
}
913
914 
/// Parse arguments and run; returns the process exit code.
915 
pub fn run() -> Result<i32> {
916 
    let cli = Cli::parse();
917 
    ui::init(cli.plain);
918 
    match cli.cmd {
919 
        Cmd::Completions { shell } => {
920 
            use clap::CommandFactory;
921 
            clap_complete::generate(shell, &mut Cli::command(), "oxy", &mut std::io::stdout());
922 
            Ok(0)
923 
        }
924 
        Cmd::Man { dir } => man(dir),
925 
        Cmd::Init { path, bare } => workspace::init(path, bare),
926 
        Cmd::Status { json } => workspace::status(json),
927 
        Cmd::Prompt {
928 
            format,
929 
            glyphs,
930 
            color,
931 
        } => workspace::prompt(&format, glyphs, color.as_deref()),
932 
        Cmd::Commit {
933 
            message,
934 
            file,
935 
            depends_on,
936 
            paths,
937 
            interactive,
938 
            hunks,
939 
        } => {
940 
            let message = match (message, file) {
941 
                (Some(m), _) => m,
942 
                (None, Some(f)) if f.as_os_str() == "-" => {
943 
                    let mut s = String::new();
944 
                    std::io::Read::read_to_string(&mut std::io::stdin(), &mut s)?;
945 
                    s
946 
                }
947 
                (None, Some(f)) => std::fs::read_to_string(&f).map_err(|e| {
948 
                    anyhow::anyhow!("reading the message from {}: {e}", f.display())
949 
                })?,
950 
                (None, None) => anyhow::bail!("a commit message is required (-m or -F)"),
951 
            };
952 
            workspace::commit(&message, &depends_on, &paths, interactive, &hunks)
953 
        }
954 
        Cmd::Cat { path, change } => workspace::cat(&path, change.as_deref()),
955 
        Cmd::Root { json } => workspace::root(json),
956 
        Cmd::Version { json } => workspace::version(json),
957 
        Cmd::Discard { paths, hunks } => workspace::discard(&paths, &hunks),
958 
        Cmd::Hunks { json } => workspace::hunks(json),
959 
        Cmd::Squash { change, into } => workspace::squash(&change, &into),
960 
        Cmd::Rebase { change, onto } => workspace::rebase(&change, &onto),
961 
        Cmd::Blame { path, json } => workspace::blame(&path, json),
962 
        Cmd::Bisect { cmd } => match cmd {
963 
            BisectCmd::Start => workspace::bisect_start(),
964 
            BisectCmd::Good { changes } => workspace::bisect_mark(Some(true), &changes),
965 
            BisectCmd::Bad { changes } => workspace::bisect_mark(Some(false), &changes),
966 
            BisectCmd::Skip => workspace::bisect_mark(None, &[]),
967 
            BisectCmd::Run { command } => workspace::bisect_run(&command),
968 
            BisectCmd::Status { json } => workspace::bisect_status(json),
969 
            BisectCmd::Reset => workspace::bisect_reset(),
970 
        },
971 
        Cmd::Log {
972 
            limit,
973 
            verbose,
974 
            path,
975 
            lines,
976 
            json,
977 
        } => workspace::log(limit, verbose, path.as_deref(), lines.as_deref(), json),
978 
        Cmd::Diff { change, json } => workspace::diff(change.as_deref(), json),
979 
        Cmd::Describe {
980 
            message,
981 
            change,
982 
            json,
983 
        } => match message {
984 
            Some(m) => workspace::describe(&m, change.as_deref()),
985 
            None if change.is_some() => {
986 
                anyhow::bail!(
987 
                    "naming works on the working copy; to change a head's message pass -m"
988 
                )
989 
            }
990 
            None => workspace::describe_name(json),
991 
        },
992 
        Cmd::Amend { message, into } => workspace::amend(message.as_deref(), into.as_deref()),
993 
        Cmd::Split { change, paths } => workspace::split(&change, &paths),
994 
        Cmd::Abandon { change } => workspace::abandon(&change),
995 
        Cmd::Show { change, json } => workspace::show(&change, json),
996 
        Cmd::Checkout {
997 
            changes,
998 
            discard,
999 
            carry,
1000 
        } => workspace::checkout(&changes, discard, carry),
1001 
        Cmd::Resolve { json } => workspace::resolve(json),
1002 
        Cmd::Undo => workspace::undo(),
1003 
        Cmd::Gc { now } => workspace::gc(now),
1004 
        Cmd::Fsck { json } => workspace::fsck(json),
1005 
        Cmd::Doctor { offline, json } => workspace::doctor(offline, json),
1006 
        Cmd::Checkpoint => workspace::checkpoint(),
1007 
        Cmd::Op {
1008 
            cmd: OpCmd::Log { json },
1009 
        } => workspace::op_log(json),
1010 
        Cmd::Clone {
1011 
            url,
1012 
            dest,
1013 
            max_blob,
1014 
            sparse,
1015 
            depth,
1016 
        } => sync::clone(&url, dest, max_blob.as_deref(), &sparse, depth),
1017 
        Cmd::Deepen { depth, remote } => sync::deepen(&remote, depth),
1018 
        Cmd::Sparse { paths } => workspace::sparse(&paths),
1019 
        Cmd::Lock { path } => workspace::lock(&path),
1020 
        Cmd::Unlock { path } => workspace::unlock(&path),
1021 
        Cmd::Workspace { cmd } => match cmd {
1022 
            WorkspaceCmd::Add { path, changes } => workspace::workspace_add(&path, &changes),
1023 
            WorkspaceCmd::List { json } => workspace::workspace_list(json),
1024 
            WorkspaceCmd::Forget { workspace } => workspace::workspace_forget(&workspace),
1025 
        },
1026 
        Cmd::Bookmark { cmd } => match cmd {
1027 
            BookmarkCmd::Create { name, changes } => workspace::bookmark_create(&name, &changes),
1028 
            BookmarkCmd::Set { name, changes } => workspace::bookmark_set(&name, &changes),
1029 
            BookmarkCmd::Delete { name } => workspace::bookmark_delete(&name),
1030 
            BookmarkCmd::List { json } => workspace::bookmark_list(json),
1031 
            BookmarkCmd::Switch {
1032 
                name,
1033 
                discard,
1034 
                carry,
1035 
            } => workspace::bookmark_switch(&name, discard, carry),
1036 
        },
1037 
        Cmd::Merge { bookmark } => workspace::merge(&bookmark),
1038 
        Cmd::Submodule { cmd } => match cmd {
1039 
            SubmoduleCmd::Add {
1040 
                url,
1041 
                path,
1042 
                bookmark,
1043 
            } => sync::submodule_add(&url, &path, bookmark.as_deref()),
1044 
            SubmoduleCmd::Update { init, paths } => sync::submodule_update(init, &paths),
1045 
            SubmoduleCmd::Status { json } => sync::submodule_status(json),
1046 
            SubmoduleCmd::Remove { path } => sync::submodule_remove(&path),
1047 
        },
1048 
        Cmd::Receipt { cmd } => match cmd {
1049 
            ReceiptCmd::List { rev, json } => receipt::list(rev.as_deref(), json),
1050 
            ReceiptCmd::Show {
1051 
                receipt: r,
1052 
                rev,
1053 
                json,
1054 
            } => receipt::show(&r, rev.as_deref(), json),
1055 
            ReceiptCmd::Export {
1056 
                receipt: r,
1057 
                file,
1058 
                rev,
1059 
            } => receipt::export(&r, &file, rev.as_deref()),
1060 
            ReceiptCmd::Verify { file, json } => receipt::verify(&file, json),
1061 
            ReceiptCmd::Import { file } => receipt::import(&file),
1062 
        },
1063 
        Cmd::Tag { cmd } => match cmd {
1064 
            TagCmd::Create {
1065 
                name,
1066 
                changes,
1067 
                message,
1068 
            } => workspace::tag_create(&name, &changes, &message),
1069 
            TagCmd::List { json } => workspace::tag_list(json),
1070 
        },
1071 
        Cmd::Remote { cmd } => match cmd {
1072 
            RemoteCmd::Add { name, url } => sync::remote_add(&name, &url),
1073 
            RemoteCmd::Remove { name } => sync::remote_remove(&name),
1074 
            RemoteCmd::List { json } => sync::remote_list(json),
1075 
        },
1076 
        Cmd::Fetch { remote, json } => sync::fetch(remote.as_deref(), json),
1077 
        Cmd::Pull { remote, json } => sync::pull(remote.as_deref(), json),
1078 
        Cmd::Push {
1079 
            remote,
1080 
            force,
1081 
            bookmark,
1082 
            delete,
1083 
            json,
1084 
        } => match delete {
1085 
            Some(name) => sync::push_delete(remote.as_deref(), &name, json),
1086 
            None => sync::push(remote.as_deref(), force, bookmark.as_deref(), json),
1087 
        },
1088 
        Cmd::Serve {
1089 
            root,
1090 
            bind,
1091 
            tokens,
1092 
            tls_cert,
1093 
            tls_key,
1094 
        } => sync::serve(root, &bind, tokens, tls_cert.zip(tls_key)),
1095 
        Cmd::Identity { cmd } => match cmd {
1096 
            IdentityCmd::Create {
1097 
                name,
1098 
                email,
1099 
                local,
1100 
                expires,
1101 
            } => identity::create(name, email, local, expires),
1102 
            IdentityCmd::Show => identity::show(),
1103 
            IdentityCmd::Export { path } => identity::export(path),
1104 
            IdentityCmd::SignChallenge { challenge, json } => {
1105 
                identity::sign_challenge(&challenge, json)
1106 
            }
1107 
            IdentityCmd::Rotate => identity::rotate(),
1108 
            IdentityCmd::Renew { expires } => identity::renew(expires),
1109 
            IdentityCmd::Revoke { key, reason } => identity::revoke(key.as_deref(), &reason),
1110 
            IdentityCmd::Delegate { cmd } => match cmd {
1111 
                DelegateCmd::Add { identity_file } => identity::delegate_add(&identity_file),
1112 
                DelegateCmd::Remove { key } => identity::delegate_remove(&key),
1113 
                DelegateCmd::List => identity::delegate_list(),
1114 
            },
1115 
        },
1116 
        Cmd::Git {
1117 
            cmd: GitCmd::Export { git_dir, branch },
1118 
        } => sync::git_export(&git_dir, branch.as_deref()),
1119 
        Cmd::Git {
1120 
            cmd: GitCmd::Fetch { url, branch },
1121 
        } => sync::git_fetch(&url, &branch),
1122 
        Cmd::Git {
1123 
            cmd: GitCmd::Push { url, branch },
1124 
        } => sync::git_push(&url, &branch),
1125 
        Cmd::Git {
1126 
            cmd:
1127 
                GitCmd::Import {
1128 
                    git_dir,
1129 
                    dest,
1130 
                    branch,
1131 
                },
1132 
        } => sync::git_import(&git_dir, &dest, &branch),
1133 
        Cmd::Git {
1134 
            cmd: GitCmd::Verify { git_dir, branch },
1135 
        } => sync::git_verify(&git_dir, &branch),
1136 
        Cmd::Policy { cmd } => match cmd {
1137 
            PolicyCmd::Init => identity::policy_init(),
1138 
            PolicyCmd::Show { json } => identity::policy_show(json),
1139 
            PolicyCmd::Grant {
1140 
                identity_file,
1141 
                pattern,
1142 
                out,
1143 
            } => identity::policy_grant(&identity_file, pattern.as_deref(), out),
1144 
            PolicyCmd::Revoke { key, out } => identity::policy_revoke(&key, out),
1145 
            PolicyCmd::Root { cmd } => match cmd {
1146 
                RootCmd::Add { identity_file, out } => {
1147 
                    identity::policy_root_add(&identity_file, out)
1148 
                }
1149 
                RootCmd::Remove { key, out } => identity::policy_root_remove(&key, out),
1150 
                RootCmd::Threshold { n, out } => identity::policy_threshold(n, out),
1151 
            },
1152 
            PolicyCmd::Sign { proposal, out } => identity::policy_sign(&proposal, out),
1153 
        },
1154 
        Cmd::Seal {
1155 
            changes,
1156 
            proposal: Some(url),
1157 
            json,
1158 
        } if changes.is_empty() => proposal::seal(&url, json),
1159 
        Cmd::Seal { changes, json, .. } => identity::seal(&changes, json),
1160 
        Cmd::Proposal { cmd } => match cmd {
1161 
            ProposalCmd::Show { url, json } => proposal::show(&url, json),
1162 
            ProposalCmd::Land { url, force } => proposal::land(&url, force),
1163 
        },
1164 
        Cmd::Verify { change, json } => identity::verify(change.as_deref(), json),
1165 
        Cmd::Config { key, value, user } => identity::config(&key, &value, user),
1166 
    }
1167 
}
1168
1169 
#[cfg(test)]
1170 
mod help_tests {
1171 
    use super::Cli;
1172 
    use clap::CommandFactory;
1173
1174 
    /// Every command and every argument explains itself, so `--help`,
1175 
    /// completions and the man pages are complete.
1176 
    #[test]
1177 
    fn every_command_and_argument_has_help() {
1178 
        fn walk(cmd: &clap::Command, path: &str, missing: &mut Vec<String>) {
1179 
            let here = format!("{path} {}", cmd.get_name()).trim().to_string();
1180 
            if cmd.get_about().is_none() && path != "" {
1181 
                missing.push(format!("{here} (command)"));
1182 
            }
1183 
            for a in cmd.get_arguments() {
1184 
                let id = a.get_id().as_str();
1185 
                if id == "help" || id == "version" || a.is_global_set() && path != "" {
1186 
                    continue;
1187 
                }
1188 
                if a.get_help().is_none() && a.get_long_help().is_none() {
1189 
                    missing.push(format!("{here} {id}"));
1190 
                }
1191 
            }
1192 
            for sub in cmd.get_subcommands() {
1193 
                walk(sub, &here, missing);
1194 
            }
1195 
        }
1196 
        let mut missing = Vec::new();
1197 
        walk(&Cli::command(), "", &mut missing);
1198 
        assert!(
1199 
            missing.is_empty(),
1200 
            "{} without help:\n{}",
1201 
            missing.len(),
1202 
            missing.join("\n")
1203 
        );
1204 
    }
1205 
}