From 85aa88abab676d32ff6b3996e1ecc37f97b75347 Mon Sep 17 00:00:00 2001 From: Ellie Huxtable Date: Fri, 7 Jun 2024 17:18:55 +0100 Subject: [PATCH] docs: add docs for store subcommand (#2097) Closes #2095 --- crates/atuin/src/command/client/store.rs | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/crates/atuin/src/command/client/store.rs b/crates/atuin/src/command/client/store.rs index 8e53954d..198cbd69 100644 --- a/crates/atuin/src/command/client/store.rs +++ b/crates/atuin/src/command/client/store.rs @@ -22,15 +22,26 @@ mod verify; #[derive(Subcommand, Debug)] #[command(infer_subcommands = true)] pub enum Cmd { + /// Print the current status of the record store Status, + + /// Rebuild a store (eg atuin store rebuild history) Rebuild(rebuild::Rebuild), + + /// Re-encrypt the store with a new key (potential for data loss!) Rekey(rekey::Rekey), + + /// Delete all records in the store that cannot be decrypted with the current key Purge(purge::Purge), + + /// Verify that all records in the store can be decrypted with the current key Verify(verify::Verify), + /// Push all records to the remote sync server (one way sync) #[cfg(feature = "sync")] Push(push::Push), + /// Pull records from the remote sync server (one way sync) #[cfg(feature = "sync")] Pull(pull::Pull), }