docs: add missing cli help text (#1945)

This commit is contained in:
Ellie Huxtable 2024-04-15 08:33:26 +01:00 committed by GitHub
parent c41998e98a
commit 50a73f0552
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 13 additions and 5 deletions

8
Cargo.lock generated
View File

@ -144,9 +144,9 @@ dependencies = [
[[package]] [[package]]
name = "async-trait" name = "async-trait"
version = "0.1.79" version = "0.1.80"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a507401cad91ec6a857ed5513a2073c82a9b9048762b885bb98655b306964681" checksum = "c6fa2087f2753a7da8cc1c0dbfcf89579dd57458e36769de5ac750b4671737ca"
dependencies = [ dependencies = [
"proc-macro2", "proc-macro2",
"quote", "quote",
@ -3638,9 +3638,9 @@ checksum = "a7065abeca94b6a8a577f9bd45aa0867a2238b74e8eb67cf10d492bc39351394"
[[package]] [[package]]
name = "sysinfo" name = "sysinfo"
version = "0.30.9" version = "0.30.10"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "e9a84fe4cfc513b41cb2596b624e561ec9e7e1c4b46328e496ed56a53514ef2a" checksum = "26d7c217777061d5a2d652aea771fb9ba98b6dade657204b08c4b9604d11555b"
dependencies = [ dependencies = [
"cfg-if", "cfg-if",
"core-foundation-sys", "core-foundation-sys",

View File

@ -45,18 +45,23 @@ pub enum Cmd {
#[command(flatten)] #[command(flatten)]
Sync(sync::Cmd), Sync(sync::Cmd),
/// Manage your sync account
#[cfg(feature = "sync")] #[cfg(feature = "sync")]
Account(account::Cmd), Account(account::Cmd),
/// Get or set small key-value pairs
#[command(subcommand)] #[command(subcommand)]
Kv(kv::Cmd), Kv(kv::Cmd),
/// Manage the atuin data store
#[command(subcommand)] #[command(subcommand)]
Store(store::Cmd), Store(store::Cmd),
/// Manage your dotfiles with Atuin
#[command(subcommand)] #[command(subcommand)]
Dotfiles(dotfiles::Cmd), Dotfiles(dotfiles::Cmd),
/// Print Atuin's shell init script
#[command()] #[command()]
Init(init::Cmd), Init(init::Cmd),
@ -64,6 +69,7 @@ pub enum Cmd {
#[command()] #[command()]
Info, Info,
/// Run the doctor to check for common issues
#[command()] #[command()]
Doctor, Doctor,

View File

@ -27,9 +27,10 @@ pub enum Commands {
/// Log out /// Log out
Logout, Logout,
// Delete your account, and all synced data /// Delete your account, and all synced data
Delete, Delete,
/// Change your password
ChangePassword(change_password::Cmd), ChangePassword(change_password::Cmd),
} }

View File

@ -8,6 +8,7 @@ mod alias;
#[derive(Subcommand, Debug)] #[derive(Subcommand, Debug)]
#[command(infer_subcommands = true)] #[command(infer_subcommands = true)]
pub enum Cmd { pub enum Cmd {
/// Manage shell aliases with Atuin
#[command(subcommand)] #[command(subcommand)]
Alias(alias::Cmd), Alias(alias::Cmd),
} }