OXYGENHUB
# 132b884b9a8d oxygen / src / cli / mod.rs
10.7 KiB · Rust · last changed Lazy blobs: clone --max-blob / filter.max-blob, absent-blob registry fetched on first read, objects endpoint (spec 0.6e) 1 month ago source blame history raw
fce44ae9 Andy McCall ↶ 1
//! Command-line definitions and dispatch.
2
3
mod format;
4
mod identity;
5
mod sync;
135212de Andy McCall ↶ 6
pub mod ui;
fce44ae9 Andy McCall ↶ 7
mod workspace;
8
9
use anyhow::{Context, Result};
10
use clap::{Parser, Subcommand};
11
use oxy_core::repo::Repo;
12
use std::path::PathBuf;
13
14
#[derive(Parser)]
15
#[command(name = "oxy", version, about = "Oxygen: breathing fresh air into version control")]
16
struct Cli {
135212de Andy McCall ↶ 17
    /// Plain output: no colour, no spinner (also implied by NO_COLOR or a non-terminal)
18
    #[arg(long, global = true)]
19
    plain: bool,
fce44ae9 Andy McCall ↶ 20
    #[command(subcommand)]
21
    cmd: Cmd,
22
}
23
24
#[derive(Subcommand)]
25
enum Cmd {
26
    /// Create a repository in PATH (default: current directory)
27
    Init { path: Option<PathBuf> },
28
    /// Clone a repository from a local path or an http(s) URL
b3c5a59a Andy McCall ↶ 29
    Clone {
30
        url: String,
31
        dest: Option<PathBuf>,
32
        /// Leave blobs larger than this (e.g. 1M) to be fetched on first read
33
        #[arg(long)]
34
        max_blob: Option<String>,
7421309f Andy McCall ↶ 35
        /// Materialize only these paths (repeatable); implies lazy blobs
36
        #[arg(long = "sparse")]
37
        sparse: Vec<String>,
2863456a Andy McCall ↶ 38
        /// Shallow clone: fetch only this many levels of history below the heads
39
        #[arg(long)]
40
        depth: Option<u32>,
b3c5a59a Andy McCall ↶ 41
    },
2863456a Andy McCall ↶ 42
    /// Fetch more history below a shallow clone's boundary
43
    Deepen {
44
        #[arg(default_value_t = 10)]
45
        depth: u32,
46
        #[arg(long, default_value = "origin")]
47
        remote: String,
48
    },
7421309f Andy McCall ↶ 49
    /// Show or set the sparse filter (paths to materialize); re-checks out the bookmark
50
    Sparse { paths: Vec<String> },
fce44ae9 Andy McCall ↶ 51
    /// Show the working copy: changed paths and conflicts
52
    Status,
135212de Andy McCall ↶ 53
    /// One-line summary for shell prompts; fast and records nothing
54
    Prompt {
55
        /// Placeholders: %b bookmark, %c change id, %h heads, %d dirty (*), %x conflict (!), %A/%D ahead/behind (+n/-n), %a/%B raw counts
56
        #[arg(long, default_value = oxy_core::repo::DEFAULT_PROMPT_FORMAT)]
57
        format: String,
58
    },
fce44ae9 Andy McCall ↶ 59
    /// Record the working copy as a change on the current bookmark
60
    Commit {
61
        #[arg(short, long)]
62
        message: String,
63
        /// Extra explicit dependencies (ChangeId prefix, #hash prefix)
64
        #[arg(long = "depends-on")]
65
        depends_on: Vec<String>,
66
    },
67
    /// List changes reachable from the bookmark and the working copy
68
    Log,
69
    /// Show what the working copy changes against its base
70
    Diff,
614541c3 Andy McCall ↶ 71
    /// Change the message of a head (default: the head the working copy sits on)
72
    Describe {
73
        #[arg(short, long)]
74
        message: String,
75
        change: Option<String>,
76
    },
77
    /// Fold the working copy into the head it sits on
78
    Amend {
79
        #[arg(short, long)]
80
        message: Option<String>,
81
    },
82
    /// Drop a head from the bookmark; its content stays on disk as uncommitted work
83
    Abandon { change: String },
fce44ae9 Andy McCall ↶ 84
    /// Show one change (ChangeId prefix, #hash prefix, or @)
85
    Show { change: String },
86
    /// Move the working copy to the state formed by CHANGE... (default: the bookmark heads)
87
    Checkout {
88
        changes: Vec<String>,
89
        /// Throw away uncommitted working-copy changes
90
        #[arg(long)]
91
        discard: bool,
92
    },
93
    /// Report which conflicts of the working copy's base are resolved by the current files
94
    Resolve,
95
    /// Undo the last operation
96
    Undo,
252e8cb2 Andy McCall ↶ 97
    /// Write a checkpoint of the current bookmark's state now
98
    Checkpoint,
ba160f60 Andy McCall ↶ 99
    /// Pack loose objects and prune unreachable ones older than the grace period
100
    Gc {
101
        /// Ignore the grace period (core.gc-grace) and prune immediately
102
        #[arg(long)]
103
        now: bool,
104
    },
fce44ae9 Andy McCall ↶ 105
    /// List operations
106
    #[command(name = "op")]
107
    Op {
108
        #[command(subcommand)]
109
        cmd: OpCmd,
110
    },
132b884b Andy McCall ↶ 111
    /// Tags: immutable named states
112
    Tag {
113
        #[command(subcommand)]
114
        cmd: TagCmd,
115
    },
fce44ae9 Andy McCall ↶ 116
    /// Manage remotes
117
    Remote {
118
        #[command(subcommand)]
119
        cmd: RemoteCmd,
120
    },
121
    /// Fetch every bookmark of a remote into its tracking references
122
    Fetch { remote: Option<String> },
123
    /// Fetch, then union the remote bookmark into the local one (no merge change)
124
    Pull { remote: Option<String> },
125
    /// Push the current bookmark to a remote
126
    Push {
127
        remote: Option<String>,
128
        /// Allow dropping heads the remote has
129
        #[arg(long)]
130
        force: bool,
131
    },
2b5ee371 Andy McCall ↶ 132
    /// Serve repositories under ROOT over HTTPS (with --tls-cert/--tls-key) or plain HTTP
fce44ae9 Andy McCall ↶ 133
    Serve {
134
        /// Directory with one repository per subdirectory
135
        #[arg(long, default_value = ".")]
136
        root: PathBuf,
137
        #[arg(long, default_value = "127.0.0.1:8890")]
138
        bind: String,
139
        /// Bearer token allowed to push (repeatable); none means open
140
        #[arg(long = "token")]
141
        tokens: Vec<String>,
2b5ee371 Andy McCall ↶ 142
        /// PEM certificate chain; enables HTTPS together with --tls-key
143
        #[arg(long, requires = "tls_key")]
144
        tls_cert: Option<PathBuf>,
145
        /// PEM private key
146
        #[arg(long, requires = "tls_cert")]
147
        tls_key: Option<PathBuf>,
fce44ae9 Andy McCall ↶ 148
    },
149
    /// Manage the signing identity
150
    Identity {
151
        #[command(subcommand)]
152
        cmd: IdentityCmd,
153
    },
154
    /// Verify the signatures on a change (default: every change in the log)
155
    Verify { change: Option<String> },
79ab8528 Andy McCall ↶ 156
    /// Git interoperability
157
    Git {
158
        #[command(subcommand)]
159
        cmd: GitCmd,
160
    },
83e0677b Andy McCall ↶ 161
    /// Manage the trust policy (who may update which bookmarks)
162
    Policy {
163
        #[command(subcommand)]
164
        cmd: PolicyCmd,
165
    },
7421309f Andy McCall ↶ 166
    /// 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)
fce44ae9 Andy McCall ↶ 167
    Config {
168
        key: String,
169
        value: String,
170
        /// Write to the user file (~/.config/oxy/config.toml) instead of this repository
171
        #[arg(long)]
172
        user: bool,
173
    },
174
}
175
176
#[derive(Subcommand)]
177
enum OpCmd {
178
    Log,
179
}
180
181
#[derive(Subcommand)]
132b884b Andy McCall ↶ 182
enum TagCmd {
183
    /// Tag the state of CHANGE... (default: the bookmark heads)
184
    Create {
185
        name: String,
186
        changes: Vec<String>,
187
        #[arg(short, long, default_value = "")]
188
        message: String,
189
    },
190
    List,
191
}
192
193
#[derive(Subcommand)]
fce44ae9 Andy McCall ↶ 194
enum RemoteCmd {
195
    Add { name: String, url: String },
196
    Remove { name: String },
197
    List,
198
}
199
200
#[derive(Subcommand)]
201
enum IdentityCmd {
202
    /// Generate a composite Ed25519 + ML-DSA-65 key pair and make it your author identity
203
    Create {
204
        #[arg(long)]
205
        name: Option<String>,
206
        #[arg(long)]
207
        email: Option<String>,
208
        /// Record the author in this repository only, not in the user config
209
        #[arg(long)]
210
        local: bool,
211
    },
212
    /// Show the configured identity
213
    Show,
83e0677b Andy McCall ↶ 214
    /// Write your identity object to a file, to hand to a policy holder
215
    Export { path: Option<PathBuf> },
fce44ae9 Andy McCall ↶ 216
}
217
83e0677b Andy McCall ↶ 218
#[derive(Subcommand)]
79ab8528 Andy McCall ↶ 219
enum GitCmd {
220
    /// Export the current bookmark to a Git repository (created bare if absent)
221
    Export { git_dir: PathBuf },
c3069537 Andy McCall ↶ 222
    /// Import a Git branch into a new Oxygen repository at DEST
223
    Import {
224
        git_dir: PathBuf,
225
        dest: PathBuf,
226
        #[arg(long, default_value = "main")]
227
        branch: String,
228
    },
79ab8528 Andy McCall ↶ 229
}
230
231
#[derive(Subcommand)]
83e0677b Andy McCall ↶ 232
enum PolicyCmd {
233
    /// Create the initial policy with your identity as the only root
234
    Init,
235
    /// Show the current policy
236
    Show,
237
    /// Allow an identity (from `oxy identity export`) to update bookmarks
238
    Grant {
239
        identity_file: PathBuf,
240
        /// Reference pattern the grant applies to (default: every bookmark)
241
        #[arg(long)]
242
        pattern: Option<String>,
243
    },
244
    /// Revoke a key (KeyId prefix of an identity in the policy)
245
    Revoke { key: String },
246
}
247
fce44ae9 Andy McCall ↶ 248
/// Open the repository containing the current directory.
249
fn open() -> Result<Repo> {
250
    Repo::open(&std::env::current_dir()?).context("opening repository")
251
}
252
253
/// Parse arguments and run; returns the process exit code.
254
pub fn run() -> Result<i32> {
255
    let cli = Cli::parse();
135212de Andy McCall ↶ 256
    ui::init(cli.plain);
fce44ae9 Andy McCall ↶ 257
    match cli.cmd {
258
        Cmd::Init { path } => workspace::init(path),
259
        Cmd::Status => workspace::status(),
135212de Andy McCall ↶ 260
        Cmd::Prompt { format } => workspace::prompt(&format),
fce44ae9 Andy McCall ↶ 261
        Cmd::Commit { message, depends_on } => workspace::commit(&message, &depends_on),
262
        Cmd::Log => workspace::log(),
263
        Cmd::Diff => workspace::diff(),
614541c3 Andy McCall ↶ 264
        Cmd::Describe { message, change } => workspace::describe(&message, change.as_deref()),
265
        Cmd::Amend { message } => workspace::amend(message.as_deref()),
266
        Cmd::Abandon { change } => workspace::abandon(&change),
fce44ae9 Andy McCall ↶ 267
        Cmd::Show { change } => workspace::show(&change),
268
        Cmd::Checkout { changes, discard } => workspace::checkout(&changes, discard),
269
        Cmd::Resolve => workspace::resolve(),
270
        Cmd::Undo => workspace::undo(),
ba160f60 Andy McCall ↶ 271
        Cmd::Gc { now } => workspace::gc(now),
252e8cb2 Andy McCall ↶ 272
        Cmd::Checkpoint => workspace::checkpoint(),
fce44ae9 Andy McCall ↶ 273
        Cmd::Op { cmd: OpCmd::Log } => workspace::op_log(),
2863456a Andy McCall ↶ 274
        Cmd::Clone { url, dest, max_blob, sparse, depth } => sync::clone(&url, dest, max_blob.as_deref(), &sparse, depth),
275
        Cmd::Deepen { depth, remote } => sync::deepen(&remote, depth),
7421309f Andy McCall ↶ 276
        Cmd::Sparse { paths } => workspace::sparse(&paths),
132b884b Andy McCall ↶ 277
        Cmd::Tag { cmd } => match cmd {
278
            TagCmd::Create { name, changes, message } => workspace::tag_create(&name, &changes, &message),
279
            TagCmd::List => workspace::tag_list(),
280
        },
fce44ae9 Andy McCall ↶ 281
        Cmd::Remote { cmd } => match cmd {
282
            RemoteCmd::Add { name, url } => sync::remote_add(&name, &url),
283
            RemoteCmd::Remove { name } => sync::remote_remove(&name),
284
            RemoteCmd::List => sync::remote_list(),
285
        },
286
        Cmd::Fetch { remote } => sync::fetch(remote.as_deref()),
287
        Cmd::Pull { remote } => sync::pull(remote.as_deref()),
288
        Cmd::Push { remote, force } => sync::push(remote.as_deref(), force),
2b5ee371 Andy McCall ↶ 289
        Cmd::Serve { root, bind, tokens, tls_cert, tls_key } => sync::serve(root, &bind, tokens, tls_cert.zip(tls_key)),
fce44ae9 Andy McCall ↶ 290
        Cmd::Identity { cmd } => match cmd {
291
            IdentityCmd::Create { name, email, local } => identity::create(name, email, local),
292
            IdentityCmd::Show => identity::show(),
83e0677b Andy McCall ↶ 293
            IdentityCmd::Export { path } => identity::export(path),
294
        },
79ab8528 Andy McCall ↶ 295
        Cmd::Git { cmd: GitCmd::Export { git_dir } } => sync::git_export(&git_dir),
c3069537 Andy McCall ↶ 296
        Cmd::Git { cmd: GitCmd::Import { git_dir, dest, branch } } => sync::git_import(&git_dir, &dest, &branch),
83e0677b Andy McCall ↶ 297
        Cmd::Policy { cmd } => match cmd {
298
            PolicyCmd::Init => identity::policy_init(),
299
            PolicyCmd::Show => identity::policy_show(),
300
            PolicyCmd::Grant { identity_file, pattern } => identity::policy_grant(&identity_file, pattern.as_deref()),
301
            PolicyCmd::Revoke { key } => identity::policy_revoke(&key),
fce44ae9 Andy McCall ↶ 302
        },
303
        Cmd::Verify { change } => identity::verify(change.as_deref()),
304
        Cmd::Config { key, value, user } => identity::config(&key, &value, user),
305
    }
306
}