OXYGENHUB
# 4afab467e35f oxygen / src / cli / mod.rs
42.8 KiB · Rust · last changed bookmark set asks before losing changes; rebase names the way through a conflict 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). A state is its
521 
        /// heads and what they depend on: a change alone may leave out
522 
        /// earlier changes of the current state, which is refused unless
523 
        /// --upto or --only says which is meant
524 
        changes: Vec<String>,
525 
        /// Everything of the current state up to CHANGE..., as a Git
526 
        /// branch at a commit would hold
527 
        #[arg(long, conflicts_with = "only")]
528 
        upto: bool,
529 
        /// Just CHANGE... and what they depend on
530 
        #[arg(long)]
531 
        only: bool,
532 
    },
533 
    /// Point an existing bookmark at CHANGE...
534 
    Set {
535 
        /// The bookmark to move
536 
        name: String,
537 
        /// Its new heads. A change alone may leave out changes the
538 
        /// bookmark now holds that were recorded before it, which is
539 
        /// refused unless --upto or --only says which is meant
540 
        changes: Vec<String>,
541 
        /// Everything the bookmark holds up to CHANGE..., as a Git branch
542 
        /// moved to a commit would hold
543 
        #[arg(long, conflicts_with = "only")]
544 
        upto: bool,
545 
        /// Just CHANGE... and what they depend on
546 
        #[arg(long)]
547 
        only: bool,
548 
    },
549 
    /// Remove a bookmark; its changes stay
550 
    Delete {
551 
        /// The bookmark to remove
552 
        name: String,
553 
    },
554 
    /// List bookmarks with their heads and difference from origin
555 
    List {
556 
        /// Machine-readable output: one JSON document on stdout
557 
        #[arg(long)]
558 
        json: bool,
559 
    },
560 
    /// Make NAME this workspace's bookmark and check it out. Uncommitted work stops it; --carry takes the work along, --discard drops it
561 
    Switch {
562 
        /// The bookmark to work on
563 
        name: String,
564 
        /// Throw away uncommitted working-copy changes
565 
        #[arg(long)]
566 
        discard: bool,
567 
        /// Take uncommitted changes along; refused when NAME has other
568 
        /// versions of the files they touch
569 
        #[arg(long, conflicts_with = "discard")]
570 
        carry: bool,
571 
    },
572 
}
573
574 
#[derive(Subcommand)]
575 
enum SubmoduleCmd {
576 
    /// Clone URL (Oxygen or Git) into PATH and register it in .oxymodules
577 
    Add {
578 
        /// URL or path of the Oxygen or Git repository
579 
        url: String,
580 
        /// Where to put it, relative to the repository root
581 
        path: String,
582 
        /// Bookmark (Oxygen) or branch (Git) to check out and track
583 
        #[arg(long)]
584 
        bookmark: Option<String>,
585 
    },
586 
    /// Bring nested repositories to their pins
587 
    Update {
588 
        /// Clone nested repositories that are absent
589 
        #[arg(long)]
590 
        init: bool,
591 
        /// Subrepos to update (default: all)
592 
        paths: Vec<String>,
593 
    },
594 
    /// List subrepos with their pins and on-disk state
595 
    Status {
596 
        /// Machine-readable output: one JSON document on stdout
597 
        #[arg(long)]
598 
        json: bool,
599 
    },
600 
    /// Unregister PATH; the directory stays, the node goes with the next commit
601 
    Remove {
602 
        /// The subrepo to unregister
603 
        path: String,
604 
    },
605 
}
606
607 
#[derive(Subcommand)]
608 
enum ReceiptCmd {
609 
    /// The receipts kept for a state (default: the bookmark heads)
610 
    List {
611 
        /// Change, bookmark or tag whose state to look at
612 
        rev: Option<String>,
613 
        /// Machine-readable output: one JSON document on stdout
614 
        #[arg(long)]
615 
        json: bool,
616 
    },
617 
    /// One receipt in full, and whether its signature verifies
618 
    Show {
619 
        /// The receipt (a prefix of its hash, as `list` shows it)
620 
        receipt: String,
621 
        /// Change, bookmark or tag whose state holds it
622 
        #[arg(long)]
623 
        rev: Option<String>,
624 
        /// Machine-readable output: one JSON document on stdout
625 
        #[arg(long)]
626 
        json: bool,
627 
    },
628 
    /// Write a signed receipt to FILE
629 
    Export {
630 
        /// The receipt (a prefix of its hash, as `list` shows it)
631 
        receipt: String,
632 
        /// Where to write it
633 
        file: String,
634 
        /// Change, bookmark or tag whose state holds it
635 
        #[arg(long)]
636 
        rev: Option<String>,
637 
    },
638 
    /// Check a signed receipt in FILE without keeping it
639 
    Verify {
640 
        /// A signed receipt, as a runner or `export` writes it
641 
        file: String,
642 
        /// Machine-readable output: one JSON document on stdout
643 
        #[arg(long)]
644 
        json: bool,
645 
    },
646 
    /// Verify a signed receipt in FILE and keep it with its state
647 
    Import {
648 
        /// A signed receipt, as a runner or `export` writes it
649 
        file: String,
650 
    },
651 
}
652
653 
#[derive(Subcommand)]
654 
enum TagCmd {
655 
    /// Tag the state of CHANGE... (default: the bookmark heads)
656 
    Create {
657 
        /// Name of the tag; tags never move
658 
        name: String,
659 
        /// Changes whose state to tag (default: the bookmark heads)
660 
        changes: Vec<String>,
661 
        /// A message recorded with the tag
662 
        #[arg(short, long, default_value = "")]
663 
        message: String,
664 
    },
665 
    /// List tags and the states they name
666 
    List {
667 
        /// Machine-readable output: one JSON document on stdout
668 
        #[arg(long)]
669 
        json: bool,
670 
    },
671 
}
672
673 
#[derive(Subcommand)]
674 
enum RemoteCmd {
675 
    /// Add a remote
676 
    Add {
677 
        /// Name to refer to the remote by, such as origin
678 
        name: String,
679 
        /// Local path or http(s) URL of the repository
680 
        url: String,
681 
    },
682 
    /// Remove a remote
683 
    Remove {
684 
        /// The remote to remove
685 
        name: String,
686 
    },
687 
    /// List remotes and their URLs
688 
    List {
689 
        /// Machine-readable output: one JSON document on stdout
690 
        #[arg(long)]
691 
        json: bool,
692 
    },
693 
}
694
695 
#[derive(Subcommand)]
696 
enum ProposalCmd {
697 
    /// Show a proposal by its hub URL
698 
    Show {
699 
        /// The proposal's URL on the hub
700 
        url: String,
701 
        /// Machine-readable output: one JSON document on stdout
702 
        #[arg(long)]
703 
        json: bool,
704 
    },
705 
    /// Fetch the proposal's changes, set the target bookmark to the projected state, and push with your key
706 
    Land {
707 
        /// The proposal's URL on the hub
708 
        url: String,
709 
        /// Land even when the hub reports blockers
710 
        #[arg(long)]
711 
        force: bool,
712 
    },
713 
}
714
715 
#[derive(Subcommand)]
716 
enum IdentityCmd {
717 
    /// Generate a composite Ed25519 + ML-DSA-65 key pair and make it your author identity
718 
    Create {
719 
        /// Your name (default: author.name)
720 
        #[arg(long)]
721 
        name: Option<String>,
722 
        /// Your email (default: author.email)
723 
        #[arg(long)]
724 
        email: Option<String>,
725 
        /// Record the author in this repository only, not in the user config
726 
        #[arg(long)]
727 
        local: bool,
728 
        /// Expire the identity this many days from now
729 
        #[arg(long)]
730 
        expires: Option<u64>,
731 
    },
732 
    /// Show the configured identity
733 
    Show,
734 
    /// Write your identity object to a file, to hand to a policy holder
735 
    Export {
736 
        /// File to write (default: <key>.identity in the current directory)
737 
        path: Option<PathBuf>,
738 
    },
739 
    /// Sign a host's challenge (hex, at least 16 bytes) to prove you hold your key; prints the signature as hex
740 
    SignChallenge {
741 
        /// The host's challenge, as hex
742 
        challenge: String,
743 
        /// Machine-readable output: one JSON document on stdout
744 
        #[arg(long)]
745 
        json: bool,
746 
    },
747 
    /// Move to a fresh key pair; the policy follows if it names your key
748 
    Rotate,
749 
    /// Re-issue your identity with a new expiry (in days from now; 0 = never)
750 
    Renew {
751 
        /// Days from now until it expires; 0 for never
752 
        #[arg(long)]
753 
        expires: u64,
754 
    },
755 
    /// Revoke a key: yours by default, or any key if you hold a policy root
756 
    Revoke {
757 
        /// KeyId prefix (default: your own key)
758 
        key: Option<String>,
759 
        /// Why, recorded in the revocation
760 
        #[arg(long, default_value = "")]
761 
        reason: String,
762 
    },
763 
    /// Keys allowed to sign or seal on your behalf
764 
    Delegate {
765 
        #[command(subcommand)]
766 
        cmd: DelegateCmd,
767 
    },
768 
}
769
770 
#[derive(Subcommand)]
771 
enum DelegateCmd {
772 
    /// Add a delegate from an exported identity file
773 
    Add {
774 
        /// The delegate's exported identity file
775 
        identity_file: PathBuf,
776 
    },
777 
    /// Remove a delegate by KeyId prefix
778 
    Remove {
779 
        /// KeyId prefix of the delegate
780 
        key: String,
781 
    },
782 
    /// List delegates
783 
    List,
784 
}
785
786 
#[derive(Subcommand)]
787 
enum GitCmd {
788 
    /// Export the current bookmark to a Git repository (created bare if absent)
789 
    Export {
790 
        /// Git repository to write to (created bare if absent)
791 
        git_dir: PathBuf,
792 
        /// Git branch to write (default: the bookmark name)
793 
        #[arg(long)]
794 
        branch: Option<String>,
795 
    },
796 
    /// Fetch a branch from a Git remote (path or URL) into the current bookmark
797 
    Fetch {
798 
        /// Git remote: a path or URL
799 
        url: String,
800 
        /// Branch to fetch
801 
        #[arg(long, default_value = "main")]
802 
        branch: String,
803 
    },
804 
    /// Push the current bookmark to a branch of a Git remote (fetch first)
805 
    Push {
806 
        /// Git remote: a path or URL
807 
        url: String,
808 
        /// Branch to push to
809 
        #[arg(long, default_value = "main")]
810 
        branch: String,
811 
    },
812 
    /// Check this repository's import of a Git branch: every commit's tree must be reproduced exactly
813 
    Verify {
814 
        /// The Git repository the import came from
815 
        git_dir: PathBuf,
816 
        /// Branch that was imported
817 
        #[arg(long, default_value = "main")]
818 
        branch: String,
819 
    },
820 
    /// Import a Git branch into a new Oxygen repository at DEST
821 
    Import {
822 
        /// Git repository to read
823 
        git_dir: PathBuf,
824 
        /// Directory for the new Oxygen repository
825 
        dest: PathBuf,
826 
        /// Branch to import
827 
        #[arg(long, default_value = "main")]
828 
        branch: String,
829 
    },
830 
}
831
832 
#[derive(Subcommand)]
833 
enum PolicyCmd {
834 
    /// Create the initial policy with your identity as the only root
835 
    Init,
836 
    /// Show the current policy
837 
    Show {
838 
        /// Machine-readable output: one JSON document on stdout
839 
        #[arg(long)]
840 
        json: bool,
841 
    },
842 
    /// Allow an identity (from `oxy identity export`) to update bookmarks
843 
    Grant {
844 
        /// The identity to grant, exported with `oxy identity export`
845 
        identity_file: PathBuf,
846 
        /// Reference pattern the grant applies to (default: every bookmark)
847 
        #[arg(long)]
848 
        pattern: Option<String>,
849 
        /// Where to write the proposal when more root signatures are needed
850 
        #[arg(long)]
851 
        out: Option<PathBuf>,
852 
    },
853 
    /// Revoke a key (KeyId prefix of an identity in the policy)
854 
    Revoke {
855 
        /// KeyId prefix of the identity
856 
        key: String,
857 
        /// Where to write the proposal when more root signatures are needed
858 
        #[arg(long)]
859 
        out: Option<PathBuf>,
860 
    },
861 
    /// Manage root keys and the signature threshold for policy updates
862 
    Root {
863 
        #[command(subcommand)]
864 
        cmd: RootCmd,
865 
    },
866 
    /// Add your root signature to a proposal file; applies it once the threshold is met
867 
    Sign {
868 
        /// The proposal file to sign
869 
        proposal: PathBuf,
870 
        /// Where to write the proposal if it still needs signatures (default: in place)
871 
        #[arg(long)]
872 
        out: Option<PathBuf>,
873 
    },
874 
}
875
876 
#[derive(Subcommand)]
877 
enum RootCmd {
878 
    /// Make an exported identity a root key
879 
    Add {
880 
        /// The identity to make a root, exported with `oxy identity export`
881 
        identity_file: PathBuf,
882 
        /// Where to write the proposal when more root signatures are needed
883 
        #[arg(long)]
884 
        out: Option<PathBuf>,
885 
    },
886 
    /// Remove a root key by KeyId prefix
887 
    Remove {
888 
        /// KeyId prefix of the root key
889 
        key: String,
890 
        /// Where to write the proposal when more root signatures are needed
891 
        #[arg(long)]
892 
        out: Option<PathBuf>,
893 
    },
894 
    /// Require this many root signatures on policy updates
895 
    Threshold {
896 
        /// Number of root signatures
897 
        n: u32,
898 
        /// Where to write the proposal when more root signatures are needed
899 
        #[arg(long)]
900 
        out: Option<PathBuf>,
901 
    },
902 
}
903
904 
/// Open the repository containing the current directory.
905 
fn open() -> Result<Repo> {
906 
    Repo::open(&std::env::current_dir()?).context("opening repository")
907 
}
908
909 
/// `oxy man`: every page into `dir`, or the top-level page on stdout.
910 
fn man(dir: Option<PathBuf>) -> Result<i32> {
911 
    use clap::CommandFactory;
912 
    let cmd = Cli::command();
913 
    match dir {
914 
        Some(dir) => {
915 
            std::fs::create_dir_all(&dir)?;
916 
            clap_mangen::generate_to(cmd, &dir)?;
917 
            let pages = std::fs::read_dir(&dir)?
918 
                .filter(|e| {
919 
                    e.as_ref()
920 
                        .is_ok_and(|e| e.path().extension().is_some_and(|x| x == "1"))
921 
                })
922 
                .count();
923 
            println!(
924 
                "{}",
925 
                ui::done(format!("Wrote {pages} man pages to {}", dir.display()))
926 
            );
927 
        }
928 
        None => clap_mangen::Man::new(cmd).render(&mut std::io::stdout())?,
929 
    }
930 
    Ok(0)
931 
}
932
933 
/// Parse arguments and run; returns the process exit code.
934 
pub fn run() -> Result<i32> {
935 
    let cli = Cli::parse();
936 
    ui::init(cli.plain);
937 
    match cli.cmd {
938 
        Cmd::Completions { shell } => {
939 
            use clap::CommandFactory;
940 
            clap_complete::generate(shell, &mut Cli::command(), "oxy", &mut std::io::stdout());
941 
            Ok(0)
942 
        }
943 
        Cmd::Man { dir } => man(dir),
944 
        Cmd::Init { path, bare } => workspace::init(path, bare),
945 
        Cmd::Status { json } => workspace::status(json),
946 
        Cmd::Prompt {
947 
            format,
948 
            glyphs,
949 
            color,
950 
        } => workspace::prompt(&format, glyphs, color.as_deref()),
951 
        Cmd::Commit {
952 
            message,
953 
            file,
954 
            depends_on,
955 
            paths,
956 
            interactive,
957 
            hunks,
958 
        } => {
959 
            let message = match (message, file) {
960 
                (Some(m), _) => m,
961 
                (None, Some(f)) if f.as_os_str() == "-" => {
962 
                    let mut s = String::new();
963 
                    std::io::Read::read_to_string(&mut std::io::stdin(), &mut s)?;
964 
                    s
965 
                }
966 
                (None, Some(f)) => std::fs::read_to_string(&f).map_err(|e| {
967 
                    anyhow::anyhow!("reading the message from {}: {e}", f.display())
968 
                })?,
969 
                (None, None) => anyhow::bail!("a commit message is required (-m or -F)"),
970 
            };
971 
            workspace::commit(&message, &depends_on, &paths, interactive, &hunks)
972 
        }
973 
        Cmd::Cat { path, change } => workspace::cat(&path, change.as_deref()),
974 
        Cmd::Root { json } => workspace::root(json),
975 
        Cmd::Version { json } => workspace::version(json),
976 
        Cmd::Discard { paths, hunks } => workspace::discard(&paths, &hunks),
977 
        Cmd::Hunks { json } => workspace::hunks(json),
978 
        Cmd::Squash { change, into } => workspace::squash(&change, &into),
979 
        Cmd::Rebase { change, onto } => workspace::rebase(&change, &onto),
980 
        Cmd::Blame { path, json } => workspace::blame(&path, json),
981 
        Cmd::Bisect { cmd } => match cmd {
982 
            BisectCmd::Start => workspace::bisect_start(),
983 
            BisectCmd::Good { changes } => workspace::bisect_mark(Some(true), &changes),
984 
            BisectCmd::Bad { changes } => workspace::bisect_mark(Some(false), &changes),
985 
            BisectCmd::Skip => workspace::bisect_mark(None, &[]),
986 
            BisectCmd::Run { command } => workspace::bisect_run(&command),
987 
            BisectCmd::Status { json } => workspace::bisect_status(json),
988 
            BisectCmd::Reset => workspace::bisect_reset(),
989 
        },
990 
        Cmd::Log {
991 
            limit,
992 
            verbose,
993 
            path,
994 
            lines,
995 
            json,
996 
        } => workspace::log(limit, verbose, path.as_deref(), lines.as_deref(), json),
997 
        Cmd::Diff { change, json } => workspace::diff(change.as_deref(), json),
998 
        Cmd::Describe {
999 
            message,
1000 
            change,
1001 
            json,
1002 
        } => match message {
1003 
            Some(m) => workspace::describe(&m, change.as_deref()),
1004 
            None if change.is_some() => {
1005 
                anyhow::bail!(
1006 
                    "naming works on the working copy; to change a head's message pass -m"
1007 
                )
1008 
            }
1009 
            None => workspace::describe_name(json),
1010 
        },
1011 
        Cmd::Amend { message, into } => workspace::amend(message.as_deref(), into.as_deref()),
1012 
        Cmd::Split { change, paths } => workspace::split(&change, &paths),
1013 
        Cmd::Abandon { change } => workspace::abandon(&change),
1014 
        Cmd::Show { change, json } => workspace::show(&change, json),
1015 
        Cmd::Checkout {
1016 
            changes,
1017 
            discard,
1018 
            carry,
1019 
        } => workspace::checkout(&changes, discard, carry),
1020 
        Cmd::Resolve { json } => workspace::resolve(json),
1021 
        Cmd::Undo => workspace::undo(),
1022 
        Cmd::Gc { now } => workspace::gc(now),
1023 
        Cmd::Fsck { json } => workspace::fsck(json),
1024 
        Cmd::Doctor { offline, json } => workspace::doctor(offline, json),
1025 
        Cmd::Checkpoint => workspace::checkpoint(),
1026 
        Cmd::Op {
1027 
            cmd: OpCmd::Log { json },
1028 
        } => workspace::op_log(json),
1029 
        Cmd::Clone {
1030 
            url,
1031 
            dest,
1032 
            max_blob,
1033 
            sparse,
1034 
            depth,
1035 
        } => sync::clone(&url, dest, max_blob.as_deref(), &sparse, depth),
1036 
        Cmd::Deepen { depth, remote } => sync::deepen(&remote, depth),
1037 
        Cmd::Sparse { paths } => workspace::sparse(&paths),
1038 
        Cmd::Lock { path } => workspace::lock(&path),
1039 
        Cmd::Unlock { path } => workspace::unlock(&path),
1040 
        Cmd::Workspace { cmd } => match cmd {
1041 
            WorkspaceCmd::Add { path, changes } => workspace::workspace_add(&path, &changes),
1042 
            WorkspaceCmd::List { json } => workspace::workspace_list(json),
1043 
            WorkspaceCmd::Forget { workspace } => workspace::workspace_forget(&workspace),
1044 
        },
1045 
        Cmd::Bookmark { cmd } => match cmd {
1046 
            BookmarkCmd::Create {
1047 
                name,
1048 
                changes,
1049 
                upto,
1050 
                only,
1051 
            } => workspace::bookmark_create(&name, &changes, upto, only),
1052 
            BookmarkCmd::Set {
1053 
                name,
1054 
                changes,
1055 
                upto,
1056 
                only,
1057 
            } => workspace::bookmark_set(&name, &changes, upto, only),
1058 
            BookmarkCmd::Delete { name } => workspace::bookmark_delete(&name),
1059 
            BookmarkCmd::List { json } => workspace::bookmark_list(json),
1060 
            BookmarkCmd::Switch {
1061 
                name,
1062 
                discard,
1063 
                carry,
1064 
            } => workspace::bookmark_switch(&name, discard, carry),
1065 
        },
1066 
        Cmd::Merge { bookmark } => workspace::merge(&bookmark),
1067 
        Cmd::Submodule { cmd } => match cmd {
1068 
            SubmoduleCmd::Add {
1069 
                url,
1070 
                path,
1071 
                bookmark,
1072 
            } => sync::submodule_add(&url, &path, bookmark.as_deref()),
1073 
            SubmoduleCmd::Update { init, paths } => sync::submodule_update(init, &paths),
1074 
            SubmoduleCmd::Status { json } => sync::submodule_status(json),
1075 
            SubmoduleCmd::Remove { path } => sync::submodule_remove(&path),
1076 
        },
1077 
        Cmd::Receipt { cmd } => match cmd {
1078 
            ReceiptCmd::List { rev, json } => receipt::list(rev.as_deref(), json),
1079 
            ReceiptCmd::Show {
1080 
                receipt: r,
1081 
                rev,
1082 
                json,
1083 
            } => receipt::show(&r, rev.as_deref(), json),
1084 
            ReceiptCmd::Export {
1085 
                receipt: r,
1086 
                file,
1087 
                rev,
1088 
            } => receipt::export(&r, &file, rev.as_deref()),
1089 
            ReceiptCmd::Verify { file, json } => receipt::verify(&file, json),
1090 
            ReceiptCmd::Import { file } => receipt::import(&file),
1091 
        },
1092 
        Cmd::Tag { cmd } => match cmd {
1093 
            TagCmd::Create {
1094 
                name,
1095 
                changes,
1096 
                message,
1097 
            } => workspace::tag_create(&name, &changes, &message),
1098 
            TagCmd::List { json } => workspace::tag_list(json),
1099 
        },
1100 
        Cmd::Remote { cmd } => match cmd {
1101 
            RemoteCmd::Add { name, url } => sync::remote_add(&name, &url),
1102 
            RemoteCmd::Remove { name } => sync::remote_remove(&name),
1103 
            RemoteCmd::List { json } => sync::remote_list(json),
1104 
        },
1105 
        Cmd::Fetch { remote, json } => sync::fetch(remote.as_deref(), json),
1106 
        Cmd::Pull { remote, json } => sync::pull(remote.as_deref(), json),
1107 
        Cmd::Push {
1108 
            remote,
1109 
            force,
1110 
            bookmark,
1111 
            delete,
1112 
            json,
1113 
        } => match delete {
1114 
            Some(name) => sync::push_delete(remote.as_deref(), &name, json),
1115 
            None => sync::push(remote.as_deref(), force, bookmark.as_deref(), json),
1116 
        },
1117 
        Cmd::Serve {
1118 
            root,
1119 
            bind,
1120 
            tokens,
1121 
            tls_cert,
1122 
            tls_key,
1123 
        } => sync::serve(root, &bind, tokens, tls_cert.zip(tls_key)),
1124 
        Cmd::Identity { cmd } => match cmd {
1125 
            IdentityCmd::Create {
1126 
                name,
1127 
                email,
1128 
                local,
1129 
                expires,
1130 
            } => identity::create(name, email, local, expires),
1131 
            IdentityCmd::Show => identity::show(),
1132 
            IdentityCmd::Export { path } => identity::export(path),
1133 
            IdentityCmd::SignChallenge { challenge, json } => {
1134 
                identity::sign_challenge(&challenge, json)
1135 
            }
1136 
            IdentityCmd::Rotate => identity::rotate(),
1137 
            IdentityCmd::Renew { expires } => identity::renew(expires),
1138 
            IdentityCmd::Revoke { key, reason } => identity::revoke(key.as_deref(), &reason),
1139 
            IdentityCmd::Delegate { cmd } => match cmd {
1140 
                DelegateCmd::Add { identity_file } => identity::delegate_add(&identity_file),
1141 
                DelegateCmd::Remove { key } => identity::delegate_remove(&key),
1142 
                DelegateCmd::List => identity::delegate_list(),
1143 
            },
1144 
        },
1145 
        Cmd::Git {
1146 
            cmd: GitCmd::Export { git_dir, branch },
1147 
        } => sync::git_export(&git_dir, branch.as_deref()),
1148 
        Cmd::Git {
1149 
            cmd: GitCmd::Fetch { url, branch },
1150 
        } => sync::git_fetch(&url, &branch),
1151 
        Cmd::Git {
1152 
            cmd: GitCmd::Push { url, branch },
1153 
        } => sync::git_push(&url, &branch),
1154 
        Cmd::Git {
1155 
            cmd:
1156 
                GitCmd::Import {
1157 
                    git_dir,
1158 
                    dest,
1159 
                    branch,
1160 
                },
1161 
        } => sync::git_import(&git_dir, &dest, &branch),
1162 
        Cmd::Git {
1163 
            cmd: GitCmd::Verify { git_dir, branch },
1164 
        } => sync::git_verify(&git_dir, &branch),
1165 
        Cmd::Policy { cmd } => match cmd {
1166 
            PolicyCmd::Init => identity::policy_init(),
1167 
            PolicyCmd::Show { json } => identity::policy_show(json),
1168 
            PolicyCmd::Grant {
1169 
                identity_file,
1170 
                pattern,
1171 
                out,
1172 
            } => identity::policy_grant(&identity_file, pattern.as_deref(), out),
1173 
            PolicyCmd::Revoke { key, out } => identity::policy_revoke(&key, out),
1174 
            PolicyCmd::Root { cmd } => match cmd {
1175 
                RootCmd::Add { identity_file, out } => {
1176 
                    identity::policy_root_add(&identity_file, out)
1177 
                }
1178 
                RootCmd::Remove { key, out } => identity::policy_root_remove(&key, out),
1179 
                RootCmd::Threshold { n, out } => identity::policy_threshold(n, out),
1180 
            },
1181 
            PolicyCmd::Sign { proposal, out } => identity::policy_sign(&proposal, out),
1182 
        },
1183 
        Cmd::Seal {
1184 
            changes,
1185 
            proposal: Some(url),
1186 
            json,
1187 
        } if changes.is_empty() => proposal::seal(&url, json),
1188 
        Cmd::Seal { changes, json, .. } => identity::seal(&changes, json),
1189 
        Cmd::Proposal { cmd } => match cmd {
1190 
            ProposalCmd::Show { url, json } => proposal::show(&url, json),
1191 
            ProposalCmd::Land { url, force } => proposal::land(&url, force),
1192 
        },
1193 
        Cmd::Verify { change, json } => identity::verify(change.as_deref(), json),
1194 
        Cmd::Config { key, value, user } => identity::config(&key, &value, user),
1195 
    }
1196 
}
1197
1198 
#[cfg(test)]
1199 
mod help_tests {
1200 
    use super::Cli;
1201 
    use clap::CommandFactory;
1202
1203 
    /// Every command and every argument explains itself, so `--help`,
1204 
    /// completions and the man pages are complete.
1205 
    #[test]
1206 
    fn every_command_and_argument_has_help() {
1207 
        fn walk(cmd: &clap::Command, path: &str, missing: &mut Vec<String>) {
1208 
            let here = format!("{path} {}", cmd.get_name()).trim().to_string();
1209 
            if cmd.get_about().is_none() && path != "" {
1210 
                missing.push(format!("{here} (command)"));
1211 
            }
1212 
            for a in cmd.get_arguments() {
1213 
                let id = a.get_id().as_str();
1214 
                if id == "help" || id == "version" || a.is_global_set() && path != "" {
1215 
                    continue;
1216 
                }
1217 
                if a.get_help().is_none() && a.get_long_help().is_none() {
1218 
                    missing.push(format!("{here} {id}"));
1219 
                }
1220 
            }
1221 
            for sub in cmd.get_subcommands() {
1222 
                walk(sub, &here, missing);
1223 
            }
1224 
        }
1225 
        let mut missing = Vec::new();
1226 
        walk(&Cli::command(), "", &mut missing);
1227 
        assert!(
1228 
            missing.is_empty(),
1229 
            "{} without help:\n{}",
1230 
            missing.len(),
1231 
            missing.join("\n")
1232 
        );
1233 
    }
1234 
}