Skip to content

Commit

Permalink
Update help text for some commands
Browse files Browse the repository at this point in the history
  • Loading branch information
Jesse Swidler committed Nov 2, 2018
1 parent fe5a7d9 commit 307eef3
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 9 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,14 @@ Available Commands:
set-key Set the key for the current vault
reveal-key Reveal the lockgit key for the current repo
delete-key Delete the key for the current vault
add Add files to the vault
rm Remove files and globs from the vault
add Add files and glob patterns to the vault
rm Remove files and globs patterns from the vault
status Check if tracked files match the ones in the vault
commit Commit changes of tracked files to the vault
open Decrypt and restore secrets in the vault
close Delete plaintext secrets
ls List the files in the lockgit vault
globs List all saved glob patterns
globs List the saved glob patterns in the vault
help Help about any command
```

Expand Down
2 changes: 1 addition & 1 deletion pkg/cmd/add.go
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ import (
// addCmd represents the add command
var addCmd = &cobra.Command{
Use: "add <file|glob> ...",
Short: "Add files to the vault",
Short: "Add files and glob patterns to the vault",
Long: `Add files to the vault, either individually or with a glob pattern.
For each input, if it matches a file exactly, only that single will be added to the vault. If the input matches a
Expand Down
4 changes: 2 additions & 2 deletions pkg/cmd/globs.go
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ import (
// globsCmd represents the globs command
var globsCmd = &cobra.Command{
Use: "globs",
Short: "List all saved glob patterns",
Long: "List all saved glob patterns.\n\n" + globHelp,
Short: "List the saved glob patterns in the vault",
Long: "List the saved glob patterns in the vault.\n\n" + globHelp,

Aliases: []string{"glob"},

Expand Down
8 changes: 5 additions & 3 deletions pkg/cmd/rm.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,12 @@ import (
// rmCmd represents the rm command
var rmCmd = &cobra.Command{
Use: "rm <file|glob> ...",
Short: "Remove files and globs from the vault",
Long: `Remove files and globs from the vault
Short: "Remove files and globs patterns from the vault",
Long: `Remove files and globs patterns from the vault
For each input, if it matches a previously saved glob pattern exactly, that pattern and all files which match it will be removed from the vault. Otherwise, if the input matches a file in the vault exactly, that file will be removed from the vault.
For each input, if it matches a previously saved glob pattern exactly, that pattern and all files which match it will be
removed from the vault. Otherwise, if the input matches a file in the vault exactly, that file will be removed from the
vault.
` + globHelp,

Expand Down

0 comments on commit 307eef3

Please sign in to comment.