From 50a73f055288d72eeeb128233e2a04bc88a5d5e8 Mon Sep 17 00:00:00 2001
From: Ellie Huxtable <ellie@elliehuxtable.com>
Date: Mon, 15 Apr 2024 08:33:26 +0100
Subject: docs: add missing cli help text (#1945)

---
 Cargo.lock                           | 8 ++++----
 atuin/src/command/client.rs          | 6 ++++++
 atuin/src/command/client/account.rs  | 3 ++-
 atuin/src/command/client/dotfiles.rs | 1 +
 4 files changed, 13 insertions(+), 5 deletions(-)

diff --git a/Cargo.lock b/Cargo.lock
index 9c6e81b0..24d7ff20 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -144,9 +144,9 @@ dependencies = [
 
 [[package]]
 name = "async-trait"
-version = "0.1.79"
+version = "0.1.80"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a507401cad91ec6a857ed5513a2073c82a9b9048762b885bb98655b306964681"
+checksum = "c6fa2087f2753a7da8cc1c0dbfcf89579dd57458e36769de5ac750b4671737ca"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -3638,9 +3638,9 @@ checksum = "a7065abeca94b6a8a577f9bd45aa0867a2238b74e8eb67cf10d492bc39351394"
 
 [[package]]
 name = "sysinfo"
-version = "0.30.9"
+version = "0.30.10"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "e9a84fe4cfc513b41cb2596b624e561ec9e7e1c4b46328e496ed56a53514ef2a"
+checksum = "26d7c217777061d5a2d652aea771fb9ba98b6dade657204b08c4b9604d11555b"
 dependencies = [
  "cfg-if",
  "core-foundation-sys",
diff --git a/atuin/src/command/client.rs b/atuin/src/command/client.rs
index ccd554bf..23040695 100644
--- a/atuin/src/command/client.rs
+++ b/atuin/src/command/client.rs
@@ -45,18 +45,23 @@ 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),
 
@@ -64,6 +69,7 @@ pub enum Cmd {
     #[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
index ee8e02a5..e31e6208 100644
--- 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
index a3967719..291c794d 100644
--- 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),
 }
-- 
cgit v1.2.3