Logo

tools

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

audit

Print and monitor audit logs

Usage: sos tools audit <COMMAND>

Commands:
  logs  Print the events in an audit log file
  help  Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

More help

authenticator

Export and import TOTP secrets

Usage: sos tools authenticator <COMMAND>

Commands:
  export  Export the TOTP secrets in an authenticator folder
  import  Import the TOTP secrets from a zip archive
  help    Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

More help

backup

Export, import and inspect backup archives

Usage: sos tools backup <COMMAND>

Commands:
  export         Export to a backup archive
  import         Import from a backup archive
  manifest       Print the manifest in a backup archive
  list-accounts  List accounts in a backup archive
  version        Print the version of a backup archive
  help           Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

More help

check

Check file status and integrity

Usage: sos tools check <COMMAND>

Commands:
  login          Print an account login vault
  device         Print an account device vault
  vault          Print a folder vault
  verify-vault   Verify vault row checksums
  verify-events  Verify event log checksums
  help           Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

More help

debug

Debug utilities

Usage: sos tools debug <COMMAND>

Commands:
  tree  Print the debug tree for an account
  help  Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

More help

convert-cipher

Convert the cipher for an account

Usage: sos tools convert-cipher [OPTIONS] <CIPHER>

Arguments:
  <CIPHER>  Convert to this cipher

Options:
  -a, --account <ACCOUNT>  Account name or address
  -k, --kdf <KDF>          Key derivation function
  -h, --help               Print help

events

Inspect event records

Usage: sos tools events <COMMAND>

Commands:
  account  Print account event log records
  login    Print login folder event log records
  device   Print device event log records
  folder   Print folder event log records
  file     Print file event log records
  help     Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

More help

repair-vault

Repair a vault from a corresponding events file

Usage: sos tools repair-vault <ACCOUNT> <FOLDER>

Arguments:
  <ACCOUNT>  Account name or address
  <FOLDER>   Folder identifier

Options:
  -h, --help  Print help

security-report

Generate a security report.

Inspect all passwords in an account and report passwords with an entropy score less than 3 or
passwords that are breached.

Usage: sos tools security-report [OPTIONS] <FILE>

Arguments:
  <FILE>
          Write report to this file

Options:
      --force
          Force overwrite if the file exists

  -a, --account <ACCOUNT>
          Account name or address

  -i, --include-all
          Include all entries.
          
          Security reports by default only include entries that fail, use this option to include
          entries that passed the security threshold.

  -f, --format <FORMAT>
          Output format: csv or json
          
          [default: csv]

  -h, --help
          Print help (see a summary with '-h')

db

Backend database management tools

Usage: sos tools db <COMMAND>

Commands:
  upgrade          Upgrade from filesystem to SQLite database backend
  upgrade-archive  Upgrade a version 1 or 2 backup archive to version 3
  migrate          Migrate a database file, create the file when necessary
  help             Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

More help