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