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
security-report Generate a security report
audit Print and monitor audit logs
check Check file status and integrity
events Inspect event records
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
backup Create secure backup as a zip archive
restore Restore account from secure backup
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
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 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')
More help
audit
Print and monitor audit logs
Usage: sos audit <COMMAND>
Commands:
logs Print the events in an audit log file
monitor Monitor changes to an audit log file
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 check <COMMAND>
Commands:
vault Verify vault row checksums
header Print a vault file header
keys Print the vault keys
events Verify event log checksums
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
More help
events
Inspect event records
Usage: sos events <COMMAND>
Commands:
account Print account 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
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
Utility tools
Usage: sos tools <COMMAND>
Commands:
convert-cipher Convert the cipher for an account
repair-vault Repair a vault from a corresponding events file
help Print this message or the help of the given subcommand(s)
Options:
-h, --help Print help
More help