docs: add missing cli help text (#1945)

atuinsh · Apr 15, 2024 · 50a73f0 · 50a73f0
1 parent c41998e
commit 50a73f0
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 5 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/atuin/src/command/client.rs b/atuin/src/command/client.rs
@@ -45,25 +45,31 @@ pub enum Cmd {
  #[command(flatten)]
  Sync(sync::Cmd),
 
+ /// Manage your sync account
  #[cfg(feature = "sync")]
  Account(account::Cmd),
 
+ /// Get or set small key-value pairs
  #[command(subcommand)]
  Kv(kv::Cmd),
 
+ /// Manage the atuin data store
  #[command(subcommand)]
  Store(store::Cmd),
 
+ /// Manage your dotfiles with Atuin
  #[command(subcommand)]
  Dotfiles(dotfiles::Cmd),
 
+ /// Print Atuin's shell init script
  #[command()]
  Init(init::Cmd),
 
  /// Information about dotfiles locations and ENV vars
  #[command()]
  Info,
 
+ /// Run the doctor to check for common issues
  #[command()]
  Doctor,
 

diff --git a/atuin/src/command/client/account.rs b/atuin/src/command/client/account.rs
@@ -27,9 +27,10 @@ pub enum Commands {
  /// Log out
  Logout,
 
- // Delete your account, and all synced data
+ /// Delete your account, and all synced data
  Delete,
 
+ /// Change your password
  ChangePassword(change_password::Cmd),
 }
 

diff --git a/atuin/src/command/client/dotfiles.rs b/atuin/src/command/client/dotfiles.rs
@@ -8,6 +8,7 @@ mod alias;
 #[derive(Subcommand, Debug)]
 #[command(infer_subcommands = true)]
 pub enum Cmd {
+ /// Manage shell aliases with Atuin
  #[command(subcommand)]
  Alias(alias::Cmd),
 }