search

serokell / coffer

Multi-backend password store with multiple frontends
4 stars 2 forks source link

Come up with a description for the --help command #35

Closed dcastro closed 2 years ago

dcastro commented 2 years ago

Clarification and motivation

Come up with a short description (and, optionally, an extended description) for the --help command.

Right now, it looks like this:

$ coffer --help

TODO: coffer description goes here

Usage: coffer COMMAND
  TODO: coffer description goes here

Available options:
  -h,--help                Show this help text

Available commands:
  view                     View entries under the specified path, optionally
                           returning only the specified field for each entry
  create                   Create a new entry at the specified path
  set-field                Set a field on the entry at the specified path
  delete-field             Delete a field from the entry at the specified path
  find                     Find and list entries, optionally filtering
  rename                   Rename an entry or directory
  copy                     Copy an entry or directory
  delete                   Delete an entry or directory
  tag                      Add or remove tags from an entry

Acceptance criteria

The --help command prints a short description of coffer and, optionally, an extended description.

dcastro commented 2 years ago

This issue is superseded by #74, closing this.