CipherStash
CipherStash Documentation

Listing Available Collections with Stash CLI

You can list the collections available in your workspace using the stash list-collections command. In order to successfully search, you must be logged in (stash-login.md).

Synopsis

stash list-collections \
    [--json]

Options

  • --json (optional) if specified, then output will be in JSON format, rather than a human-readable table.

Examples

List all collections in the workspace:

$ stash list-collections
  Name
  ------
  users
  movies
  preferences

List all collections in the workspace, providing the output as a JSON list:

$ stash list-collections --json
[
  "users",
  "movies",
  "preferences"
]

Exit Status

The exit status will be 0 if the list of collections was successfully retrieved and displayed. An exit status of 1 indicates a failure to retrieve the collection list, most likely because the credentials were invalid or the server was unavailable.

Whenever a non-zero exit status is returned, a helpful error message is printed to standard error.