src/cli/mod.rs at 252e8cb23fbc · andymccall/oxygen

# 252e8cb23fbc oxygen / src / cli / mod.rs

8.7 KiB · Rust · last changed Checkpoints: serialized states per bookmark, automatic every core.checkpoint-interval changes, oxy checkpoint, checkpoint-accelerated load_state; states keep change metadata only 1 month ago source blame history raw

//! Command-line definitions and dispatch.

mod format;
mod identity;
mod sync;
mod workspace;

use anyhow::{Context, Result};
use clap::{Parser, Subcommand};
use oxy_core::repo::Repo;
use std::path::PathBuf;

#[derive(Parser)]
#[command(name = "oxy", version, about = "Oxygen: breathing fresh air into version control")]
struct Cli {
    #[command(subcommand)]
    cmd: Cmd,
}

#[derive(Subcommand)]
enum Cmd {
    /// Create a repository in PATH (default: current directory)
    Init { path: Option<PathBuf> },
    /// Clone a repository from a local path or an http(s) URL
    Clone { url: String, dest: Option<PathBuf> },
    /// Show the working copy: changed paths and conflicts
    Status,
    /// Record the working copy as a change on the current bookmark
    Commit {
        #[arg(short, long)]
        message: String,
        /// Extra explicit dependencies (ChangeId prefix, #hash prefix)
        #[arg(long = "depends-on")]
        depends_on: Vec<String>,
    },
    /// List changes reachable from the bookmark and the working copy
    Log,
    /// Show what the working copy changes against its base
    Diff,
    /// Change the message of a head (default: the head the working copy sits on)
    Describe {
        #[arg(short, long)]
        message: String,
        change: Option<String>,
    },
    /// Fold the working copy into the head it sits on
    Amend {
        #[arg(short, long)]
        message: Option<String>,
    },
    /// Drop a head from the bookmark; its content stays on disk as uncommitted work
    Abandon { change: String },
    /// Show one change (ChangeId prefix, #hash prefix, or @)
    Show { change: String },
    /// Move the working copy to the state formed by CHANGE... (default: the bookmark heads)
    Checkout {
        changes: Vec<String>,
        /// Throw away uncommitted working-copy changes
        #[arg(long)]
        discard: bool,
    },
    /// Report which conflicts of the working copy's base are resolved by the current files
    Resolve,
    /// Undo the last operation
    Undo,
    /// Write a checkpoint of the current bookmark's state now
    Checkpoint,
    /// Pack loose objects and prune unreachable ones older than the grace period
    Gc {
        /// Ignore the grace period (core.gc-grace) and prune immediately
        #[arg(long)]
        now: bool,
    },
    /// List operations
    #[command(name = "op")]
    Op {
        #[command(subcommand)]
        cmd: OpCmd,
    },
    /// Manage remotes
    Remote {
        #[command(subcommand)]
        cmd: RemoteCmd,
    },
    /// Fetch every bookmark of a remote into its tracking references
    Fetch { remote: Option<String> },
    /// Fetch, then union the remote bookmark into the local one (no merge change)
    Pull { remote: Option<String> },
    /// Push the current bookmark to a remote
    Push {
        remote: Option<String>,
        /// Allow dropping heads the remote has
        #[arg(long)]
        force: bool,
    },
    /// Serve repositories under ROOT over HTTPS (with --tls-cert/--tls-key) or plain HTTP
    Serve {
        /// Directory with one repository per subdirectory
        #[arg(long, default_value = ".")]
        root: PathBuf,
        #[arg(long, default_value = "127.0.0.1:8890")]
        bind: String,
        /// Bearer token allowed to push (repeatable); none means open
        #[arg(long = "token")]
        tokens: Vec<String>,
        /// PEM certificate chain; enables HTTPS together with --tls-key
        #[arg(long, requires = "tls_key")]
        tls_cert: Option<PathBuf>,
        /// PEM private key
        #[arg(long, requires = "tls_cert")]
        tls_key: Option<PathBuf>,
    },
    /// Manage the signing identity
    Identity {
        #[command(subcommand)]
        cmd: IdentityCmd,
    },
    /// Verify the signatures on a change (default: every change in the log)
    Verify { change: Option<String> },
    /// Git interoperability
    Git {
        #[command(subcommand)]
        cmd: GitCmd,
    },
    /// Manage the trust policy (who may update which bookmarks)
    Policy {
        #[command(subcommand)]
        cmd: PolicyCmd,
    },
    /// Set a configuration key (author.*, core.sign, core.op-retention, core.gc-grace, core.checkpoint-interval, workspace.bookmark, remote.<name>.url|token|ca)
    Config {
        key: String,
        value: String,
        /// Write to the user file (~/.config/oxy/config.toml) instead of this repository
        #[arg(long)]
        user: bool,
    },
}

#[derive(Subcommand)]
enum OpCmd {
    Log,
}

#[derive(Subcommand)]
enum RemoteCmd {
    Add { name: String, url: String },
    Remove { name: String },
    List,
}

#[derive(Subcommand)]
enum IdentityCmd {
    /// Generate a composite Ed25519 + ML-DSA-65 key pair and make it your author identity
    Create {
        #[arg(long)]
        name: Option<String>,
        #[arg(long)]
        email: Option<String>,
        /// Record the author in this repository only, not in the user config
        #[arg(long)]
        local: bool,
    },
    /// Show the configured identity
    Show,
    /// Write your identity object to a file, to hand to a policy holder
    Export { path: Option<PathBuf> },
}

#[derive(Subcommand)]
enum GitCmd {
    /// Export the current bookmark to a Git repository (created bare if absent)
    Export { git_dir: PathBuf },
    /// Import a Git branch into a new Oxygen repository at DEST
    Import {
        git_dir: PathBuf,
        dest: PathBuf,
        #[arg(long, default_value = "main")]
        branch: String,
    },
}

#[derive(Subcommand)]
enum PolicyCmd {
    /// Create the initial policy with your identity as the only root
    Init,
    /// Show the current policy
    Show,
    /// Allow an identity (from `oxy identity export`) to update bookmarks
    Grant {
        identity_file: PathBuf,
        /// Reference pattern the grant applies to (default: every bookmark)
        #[arg(long)]
        pattern: Option<String>,
    },
    /// Revoke a key (KeyId prefix of an identity in the policy)
    Revoke { key: String },
}

/// Open the repository containing the current directory.
fn open() -> Result<Repo> {
    Repo::open(&std::env::current_dir()?).context("opening repository")
}

/// Parse arguments and run; returns the process exit code.
pub fn run() -> Result<i32> {
    let cli = Cli::parse();
    match cli.cmd {
        Cmd::Init { path } => workspace::init(path),
        Cmd::Status => workspace::status(),
        Cmd::Commit { message, depends_on } => workspace::commit(&message, &depends_on),
        Cmd::Log => workspace::log(),
        Cmd::Diff => workspace::diff(),
        Cmd::Describe { message, change } => workspace::describe(&message, change.as_deref()),
        Cmd::Amend { message } => workspace::amend(message.as_deref()),
        Cmd::Abandon { change } => workspace::abandon(&change),
        Cmd::Show { change } => workspace::show(&change),
        Cmd::Checkout { changes, discard } => workspace::checkout(&changes, discard),
        Cmd::Resolve => workspace::resolve(),
        Cmd::Undo => workspace::undo(),
        Cmd::Gc { now } => workspace::gc(now),
        Cmd::Checkpoint => workspace::checkpoint(),
        Cmd::Op { cmd: OpCmd::Log } => workspace::op_log(),
        Cmd::Clone { url, dest } => sync::clone(&url, dest),
        Cmd::Remote { cmd } => match cmd {
            RemoteCmd::Add { name, url } => sync::remote_add(&name, &url),
            RemoteCmd::Remove { name } => sync::remote_remove(&name),
            RemoteCmd::List => sync::remote_list(),
        },
        Cmd::Fetch { remote } => sync::fetch(remote.as_deref()),
        Cmd::Pull { remote } => sync::pull(remote.as_deref()),
        Cmd::Push { remote, force } => sync::push(remote.as_deref(), force),
        Cmd::Serve { root, bind, tokens, tls_cert, tls_key } => sync::serve(root, &bind, tokens, tls_cert.zip(tls_key)),
        Cmd::Identity { cmd } => match cmd {
            IdentityCmd::Create { name, email, local } => identity::create(name, email, local),
            IdentityCmd::Show => identity::show(),
            IdentityCmd::Export { path } => identity::export(path),
        },
        Cmd::Git { cmd: GitCmd::Export { git_dir } } => sync::git_export(&git_dir),
        Cmd::Git { cmd: GitCmd::Import { git_dir, dest, branch } } => sync::git_import(&git_dir, &dest, &branch),
        Cmd::Policy { cmd } => match cmd {
            PolicyCmd::Init => identity::policy_init(),
            PolicyCmd::Show => identity::policy_show(),
            PolicyCmd::Grant { identity_file, pattern } => identity::policy_grant(&identity_file, pattern.as_deref()),
            PolicyCmd::Revoke { key } => identity::policy_revoke(&key),
        },
        Cmd::Verify { change } => identity::verify(change.as_deref()),
        Cmd::Config { key, value, user } => identity::config(&key, &value, user),
    }
}

`/`	Search
`g` `c`	Code
`g` `h`	History
`g` `b`	Bookmarks
`g` `t`	Trust
`y`	Permalink to this state (files and trees)
`?`	This sheet

fce44ae9 Andy McCall 1 month ago ↶	1	//! Command-line definitions and dispatch.
	2
	3	mod format;
	4	mod identity;
	5	mod sync;
	6	mod workspace;
	7
	8	use anyhow::{Context, Result};
	9	use clap::{Parser, Subcommand};
	10	use oxy_core::repo::Repo;
	11	use std::path::PathBuf;
	12
	13	#[derive(Parser)]
	14	#[command(name = "oxy", version, about = "Oxygen: breathing fresh air into version control")]
	15	struct Cli {
	16	#[command(subcommand)]
	17	cmd: Cmd,
	18	}
	19
	20	#[derive(Subcommand)]
	21	enum Cmd {
	22	/// Create a repository in PATH (default: current directory)
	23	Init { path: Option<PathBuf> },
	24	/// Clone a repository from a local path or an http(s) URL
	25	Clone { url: String, dest: Option<PathBuf> },
	26	/// Show the working copy: changed paths and conflicts
	27	Status,
	28	/// Record the working copy as a change on the current bookmark
	29	Commit {
	30	#[arg(short, long)]
	31	message: String,
	32	/// Extra explicit dependencies (ChangeId prefix, #hash prefix)
	33	#[arg(long = "depends-on")]
	34	depends_on: Vec<String>,
	35	},
	36	/// List changes reachable from the bookmark and the working copy
	37	Log,
	38	/// Show what the working copy changes against its base
	39	Diff,
614541c3 Andy McCall 1 month ago ↶	40	/// Change the message of a head (default: the head the working copy sits on)
	41	Describe {
	42	#[arg(short, long)]
	43	message: String,
	44	change: Option<String>,
	45	},
	46	/// Fold the working copy into the head it sits on
	47	Amend {
	48	#[arg(short, long)]
	49	message: Option<String>,
	50	},
	51	/// Drop a head from the bookmark; its content stays on disk as uncommitted work
	52	Abandon { change: String },
fce44ae9 Andy McCall 1 month ago ↶	53	/// Show one change (ChangeId prefix, #hash prefix, or @)
	54	Show { change: String },
	55	/// Move the working copy to the state formed by CHANGE... (default: the bookmark heads)
	56	Checkout {
	57	changes: Vec<String>,
	58	/// Throw away uncommitted working-copy changes
	59	#[arg(long)]
	60	discard: bool,
	61	},
	62	/// Report which conflicts of the working copy's base are resolved by the current files
	63	Resolve,
	64	/// Undo the last operation
	65	Undo,
252e8cb2 Andy McCall 1 month ago ↶	66	/// Write a checkpoint of the current bookmark's state now
252e8cb2 Andy McCall 1 month ago ↶	67	Checkpoint,
ba160f60 Andy McCall 1 month ago ↶	68	/// Pack loose objects and prune unreachable ones older than the grace period
	69	Gc {
	70	/// Ignore the grace period (core.gc-grace) and prune immediately
	71	#[arg(long)]
	72	now: bool,
	73	},
fce44ae9 Andy McCall 1 month ago ↶	74	/// List operations
	75	#[command(name = "op")]
	76	Op {
	77	#[command(subcommand)]
	78	cmd: OpCmd,
	79	},
	80	/// Manage remotes
	81	Remote {
	82	#[command(subcommand)]
	83	cmd: RemoteCmd,
	84	},
	85	/// Fetch every bookmark of a remote into its tracking references
	86	Fetch { remote: Option<String> },
	87	/// Fetch, then union the remote bookmark into the local one (no merge change)
	88	Pull { remote: Option<String> },
	89	/// Push the current bookmark to a remote
	90	Push {
	91	remote: Option<String>,
	92	/// Allow dropping heads the remote has
	93	#[arg(long)]
	94	force: bool,
	95	},
2b5ee371 Andy McCall 1 month ago ↶	96	/// Serve repositories under ROOT over HTTPS (with --tls-cert/--tls-key) or plain HTTP
fce44ae9 Andy McCall 1 month ago ↶	97	Serve {
	98	/// Directory with one repository per subdirectory
	99	#[arg(long, default_value = ".")]
	100	root: PathBuf,
	101	#[arg(long, default_value = "127.0.0.1:8890")]
	102	bind: String,
	103	/// Bearer token allowed to push (repeatable); none means open
	104	#[arg(long = "token")]
	105	tokens: Vec<String>,
2b5ee371 Andy McCall 1 month ago ↶	106	/// PEM certificate chain; enables HTTPS together with --tls-key
	107	#[arg(long, requires = "tls_key")]
	108	tls_cert: Option<PathBuf>,
	109	/// PEM private key
	110	#[arg(long, requires = "tls_cert")]
	111	tls_key: Option<PathBuf>,
fce44ae9 Andy McCall 1 month ago ↶	112	},
	113	/// Manage the signing identity
	114	Identity {
	115	#[command(subcommand)]
	116	cmd: IdentityCmd,
	117	},
	118	/// Verify the signatures on a change (default: every change in the log)
	119	Verify { change: Option<String> },
79ab8528 Andy McCall 1 month ago ↶	120	/// Git interoperability
	121	Git {
	122	#[command(subcommand)]
	123	cmd: GitCmd,
	124	},
83e0677b Andy McCall 1 month ago ↶	125	/// Manage the trust policy (who may update which bookmarks)
	126	Policy {
	127	#[command(subcommand)]
	128	cmd: PolicyCmd,
	129	},
252e8cb2 Andy McCall 1 month ago ↶	130	/// Set a configuration key (author.*, core.sign, core.op-retention, core.gc-grace, core.checkpoint-interval, workspace.bookmark, remote.<name>.url\|token\|ca)
fce44ae9 Andy McCall 1 month ago ↶	131	Config {
	132	key: String,
	133	value: String,
	134	/// Write to the user file (~/.config/oxy/config.toml) instead of this repository
	135	#[arg(long)]
	136	user: bool,
	137	},
	138	}
	139
	140	#[derive(Subcommand)]
	141	enum OpCmd {
	142	Log,
	143	}
	144
	145	#[derive(Subcommand)]
	146	enum RemoteCmd {
	147	Add { name: String, url: String },
	148	Remove { name: String },
	149	List,
	150	}
	151
	152	#[derive(Subcommand)]
	153	enum IdentityCmd {
	154	/// Generate a composite Ed25519 + ML-DSA-65 key pair and make it your author identity
	155	Create {
	156	#[arg(long)]
	157	name: Option<String>,
	158	#[arg(long)]
	159	email: Option<String>,
	160	/// Record the author in this repository only, not in the user config
	161	#[arg(long)]
	162	local: bool,
	163	},
	164	/// Show the configured identity
	165	Show,
83e0677b Andy McCall 1 month ago ↶	166	/// Write your identity object to a file, to hand to a policy holder
83e0677b Andy McCall 1 month ago ↶	167	Export { path: Option<PathBuf> },
fce44ae9 Andy McCall 1 month ago ↶	168	}
fce44ae9 Andy McCall 1 month ago ↶	169
83e0677b Andy McCall 1 month ago ↶	170	#[derive(Subcommand)]
79ab8528 Andy McCall 1 month ago ↶	171	enum GitCmd {
	172	/// Export the current bookmark to a Git repository (created bare if absent)
	173	Export { git_dir: PathBuf },
c3069537 Andy McCall 1 month ago ↶	174	/// Import a Git branch into a new Oxygen repository at DEST
	175	Import {
	176	git_dir: PathBuf,
	177	dest: PathBuf,
	178	#[arg(long, default_value = "main")]
	179	branch: String,
	180	},
79ab8528 Andy McCall 1 month ago ↶	181	}
	182
	183	#[derive(Subcommand)]
83e0677b Andy McCall 1 month ago ↶	184	enum PolicyCmd {
	185	/// Create the initial policy with your identity as the only root
	186	Init,
	187	/// Show the current policy
	188	Show,
	189	/// Allow an identity (from `oxy identity export`) to update bookmarks
	190	Grant {
	191	identity_file: PathBuf,
	192	/// Reference pattern the grant applies to (default: every bookmark)
	193	#[arg(long)]
	194	pattern: Option<String>,
	195	},
	196	/// Revoke a key (KeyId prefix of an identity in the policy)
	197	Revoke { key: String },
	198	}
	199
fce44ae9 Andy McCall 1 month ago ↶	200	/// Open the repository containing the current directory.
	201	fn open() -> Result<Repo> {
	202	Repo::open(&std::env::current_dir()?).context("opening repository")
	203	}
	204
	205	/// Parse arguments and run; returns the process exit code.
	206	pub fn run() -> Result<i32> {
	207	let cli = Cli::parse();
	208	match cli.cmd {
	209	Cmd::Init { path } => workspace::init(path),
	210	Cmd::Status => workspace::status(),
	211	Cmd::Commit { message, depends_on } => workspace::commit(&message, &depends_on),
	212	Cmd::Log => workspace::log(),
	213	Cmd::Diff => workspace::diff(),
614541c3 Andy McCall 1 month ago ↶	214	Cmd::Describe { message, change } => workspace::describe(&message, change.as_deref()),
	215	Cmd::Amend { message } => workspace::amend(message.as_deref()),
	216	Cmd::Abandon { change } => workspace::abandon(&change),
fce44ae9 Andy McCall 1 month ago ↶	217	Cmd::Show { change } => workspace::show(&change),
	218	Cmd::Checkout { changes, discard } => workspace::checkout(&changes, discard),
	219	Cmd::Resolve => workspace::resolve(),
	220	Cmd::Undo => workspace::undo(),
ba160f60 Andy McCall 1 month ago ↶	221	Cmd::Gc { now } => workspace::gc(now),
252e8cb2 Andy McCall 1 month ago ↶	222	Cmd::Checkpoint => workspace::checkpoint(),
fce44ae9 Andy McCall 1 month ago ↶	223	Cmd::Op { cmd: OpCmd::Log } => workspace::op_log(),
	224	Cmd::Clone { url, dest } => sync::clone(&url, dest),
	225	Cmd::Remote { cmd } => match cmd {
	226	RemoteCmd::Add { name, url } => sync::remote_add(&name, &url),
	227	RemoteCmd::Remove { name } => sync::remote_remove(&name),
	228	RemoteCmd::List => sync::remote_list(),
	229	},
	230	Cmd::Fetch { remote } => sync::fetch(remote.as_deref()),
	231	Cmd::Pull { remote } => sync::pull(remote.as_deref()),
	232	Cmd::Push { remote, force } => sync::push(remote.as_deref(), force),
2b5ee371 Andy McCall 1 month ago ↶	233	Cmd::Serve { root, bind, tokens, tls_cert, tls_key } => sync::serve(root, &bind, tokens, tls_cert.zip(tls_key)),
fce44ae9 Andy McCall 1 month ago ↶	234	Cmd::Identity { cmd } => match cmd {
	235	IdentityCmd::Create { name, email, local } => identity::create(name, email, local),
	236	IdentityCmd::Show => identity::show(),
83e0677b Andy McCall 1 month ago ↶	237	IdentityCmd::Export { path } => identity::export(path),
83e0677b Andy McCall 1 month ago ↶	238	},
79ab8528 Andy McCall 1 month ago ↶	239	Cmd::Git { cmd: GitCmd::Export { git_dir } } => sync::git_export(&git_dir),
c3069537 Andy McCall 1 month ago ↶	240	Cmd::Git { cmd: GitCmd::Import { git_dir, dest, branch } } => sync::git_import(&git_dir, &dest, &branch),
83e0677b Andy McCall 1 month ago ↶	241	Cmd::Policy { cmd } => match cmd {
	242	PolicyCmd::Init => identity::policy_init(),
	243	PolicyCmd::Show => identity::policy_show(),
	244	PolicyCmd::Grant { identity_file, pattern } => identity::policy_grant(&identity_file, pattern.as_deref()),
	245	PolicyCmd::Revoke { key } => identity::policy_revoke(&key),
fce44ae9 Andy McCall 1 month ago ↶	246	},
	247	Cmd::Verify { change } => identity::verify(change.as_deref()),
	248	Cmd::Config { key, value, user } => identity::config(&key, &value, user),
	249	}
	250	}

Keyboard