SOS

sos

Distributed, encrypted database for private secrets.

Usage: sos [OPTIONS] <COMMAND>

Commands:
  account      Manage local accounts
  device       Trusted device management
  folder       Inspect and modify folders
  secret       Create, edit and delete secrets
  server       Add and remove servers
  sync         Sync with remote servers
  shell        Interactive login shell
  preferences  View and edit account preferences
  environment  Print environment and paths
  tools        Utility tools
  help         Print this message or the help of the given subcommand(s)

Options:
      --storage <STORAGE>  Local storage directory [env: SOS_DATA_DIR]
  -h, --help               Print help
  -V, --version            Print version

account

Manage local accounts

Usage: sos account <COMMAND>

Commands:
  new         Create an account
  list        List accounts
  info        Print account information
  rename      Rename an account
  migrate     Export and import unencrypted secrets
  contacts    Export and import contacts (vCard)
  statistics  Print search index statistics
  delete      Delete an account
  help        Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

More help

device

Trusted device management

Usage: sos device <COMMAND>

Commands:
  list    List devices
  revoke  Revoke trust in a device
  help    Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

More help

folder

Inspect and modify folders

Usage: sos folder <COMMAND>

Commands:
  new      Create a folder
  remove   Remove a folder
  list     List folders
  info     Print folder information
  keys     Print secret keys for a folder
  commits  Print commits for a folder
  rename   Rename a folder
  history  Manage the history for a folder
  help     Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

More help

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

More help

server

Add and remove servers

Usage: sos server <COMMAND>

Commands:
  add     Add a server
  list    List servers
  remove  Remove a server
  help    Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

More help

sync

Sync with remote servers

Usage: sos sync <COMMAND>

Commands:
  all     Sync with remote servers
  status  Compare local and remote status
  help    Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

More help

shell

Interactive login shell

Usage: sos shell [OPTIONS] [ACCOUNT]

Arguments:
  [ACCOUNT]  Account name or address

Options:
  -f, --folder <FOLDER>  Folder name or identifier
  -h, --help             Print help

More help

preferences

View and edit account preferences

Usage: sos preferences <COMMAND>

Commands:
  list         List preferences
  get          Print a preference
  remove       Remove a preference
  boolean      Set a boolean preference
  number       Set a number preference
  string       Set a string preference
  string-list  Set a string list preference
  clear        Remove all preferences
  help         Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

More help

environment

Print environment and paths

Usage: sos environment <COMMAND>

Commands:
  vars                Print environment variables
  paths               Print account paths
  print-path-filters  Print available path filters
  help                Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

More help

tools

Utility tools

Usage: sos tools <COMMAND>

Commands:
  audit            Print and monitor audit logs
  authenticator    Export and import TOTP secrets
  backup           Export, import and inspect backup archives
  check            Check file status and integrity
  debug            Debug utilities
  convert-cipher   Convert the cipher for an account
  events           Inspect event records
  repair-vault     Repair a vault from a corresponding events file
  security-report  Generate a security report
  db               Backend database management tools
  help             Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

More help