Logo

secret

secret

Create, edit and delete secrets

Usage: sos secret <COMMAND>

Commands:
  add        Add a secret
  list       List secrets
  get        Print a secret
  copy       Copy to the clipboard
  info       Print secret meta data
  tags       Manage tags for a secret
  update     Update a secret
  favorite   Toggle favorite flag
  rename     Rename a secret
  move       Move a secret
  comment    Edit the comment for a secret
  download   Decrypt and download a file secret
  archive    Move to the archive
  unarchive  Restore from the archive
  attach     Manage secret attachments
  remove     Delete a secret
  help       Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

add

Add a secret

Usage: sos secret add <COMMAND>

Commands:
  note   Add a note
  list   Add a list of credentials
  login  Add a service login password
  file   Add a file
  help   Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

More help

list

List secrets

Usage: sos secret list [OPTIONS]

Options:
  -a, --account <ACCOUNT>  Account name or address
  -f, --folder <FOLDER>    Folder name or id
  -v, --verbose            Print more information
      --all                Show all secrets
      --favorites          Show favorites only
  -h, --help               Print help

get

Print a secret

Usage: sos secret get [OPTIONS] <SECRET>

Arguments:
  <SECRET>  Secret name or identifier

Options:
  -a, --account <ACCOUNT>  Account name or address
  -f, --folder <FOLDER>    Folder name or id
  -h, --help               Print help

copy

Copy to the clipboard

Usage: sos secret copy [OPTIONS] <SECRET>

Arguments:
  <SECRET>  Secret name or identifier

Options:
  -a, --account <ACCOUNT>  Account name or address
  -f, --folder <FOLDER>    Folder name or id
  -h, --help               Print help

info

Print secret meta data

Usage: sos secret info [OPTIONS] <SECRET>

Arguments:
  <SECRET>  Secret name or identifier

Options:
  -a, --account <ACCOUNT>  Account name or address
  -f, --folder <FOLDER>    Folder name or id
  -d, --debug              Print debug representation
  -j, --json               Print as JSON
  -h, --help               Print help

tags

Manage tags for a secret

Usage: sos secret tags <COMMAND>

Commands:
  add     Add tags
  list    List tags
  remove  Remove tags
  clear   Remove all tags
  help    Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

More help

update

Update a secret

Usage: sos secret update [OPTIONS] <SECRET>

Arguments:
  <SECRET>  Secret name or identifier

Options:
  -a, --account <ACCOUNT>  Account name or address
  -f, --folder <FOLDER>    Folder name or id
  -h, --help               Print help

favorite

Toggle favorite flag

Usage: sos secret favorite [OPTIONS] <SECRET>

Arguments:
  <SECRET>  Secret name or identifier

Options:
  -a, --account <ACCOUNT>  Account name or address
  -f, --folder <FOLDER>    Folder name or id
  -h, --help               Print help

rename

Rename a secret

Usage: sos secret rename [OPTIONS] --name <NAME> <SECRET>

Arguments:
  <SECRET>  Secret name or identifier

Options:
  -a, --account <ACCOUNT>  Account name or address
  -f, --folder <FOLDER>    Folder name or id
  -n, --name <NAME>        New name for the secret
  -h, --help               Print help

move

Move a secret

Usage: sos secret move [OPTIONS] --target <TARGET> <SECRET>

Arguments:
  <SECRET>  Secret name or identifier

Options:
  -a, --account <ACCOUNT>  Account name or address
  -f, --folder <FOLDER>    Folder name or id
  -t, --target <TARGET>    Target folder name or id
  -h, --help               Print help

comment

Edit the comment for a secret

Usage: sos secret comment [OPTIONS] <SECRET>

Arguments:
  <SECRET>  Secret name or identifier

Options:
  -a, --account <ACCOUNT>  Account name or address
  -f, --folder <FOLDER>    Folder name or id
  -t, --text <TEXT>        Text for the comment
  -h, --help               Print help

download

Decrypt and download a file secret

Usage: sos secret download [OPTIONS] <SECRET> <FILE>

Arguments:
  <SECRET>  Secret name or identifier
  <FILE>    Path for the decrypted file

Options:
  -a, --account <ACCOUNT>  Account name or address
  -f, --folder <FOLDER>    Folder name or id
      --force              Overwrite an existing file
  -h, --help               Print help

archive

Move to the archive

Usage: sos secret archive [OPTIONS] <SECRET>

Arguments:
  <SECRET>  Secret name or identifier

Options:
  -a, --account <ACCOUNT>  Account name or address
  -f, --folder <FOLDER>    Folder name or id
  -h, --help               Print help

unarchive

Restore from the archive

Usage: sos secret unarchive [OPTIONS] <SECRET>

Arguments:
  <SECRET>  Secret name or identifier

Options:
  -a, --account <ACCOUNT>  Account name or address
  -h, --help               Print help

attach

Manage secret attachments

Usage: sos secret attach <COMMAND>

Commands:
  add       Add an attachment
  list      List attachments
  get       Print an attachment
  download  Decrypt and download a file attachment
  remove    Remove an attachment
  help      Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

More help

remove

Delete a secret

Usage: sos secret remove [OPTIONS] <SECRET>

Arguments:
  <SECRET>  Secret name or identifier

Options:
  -a, --account <ACCOUNT>  Account name or address
  -f, --folder <FOLDER>    Folder name or id
  -h, --help               Print help