Command line
cargo install bothy-clibothy auth setup --client <json> [--device-client <json>]bothy auth login [--device] | logout | statusbothy init [--remote appdata|folder[:<name>]|path:<dir>] [--app-id <id>] [--encrypt [--remember]]bothy join [--remote ...] [--db-id <id>] [--remember]bothy unlock [--remember] | lock | passwdbothy put <collection> <id> <json|@file|@-> [--patch] [--unset a,b]bothy get <collection> <id> [--with-meta]bothy list <collection> [--limit N] [--after <id>]bothy del <collection> <id>bothy sync [--watch [--p2p [--stun host:port,…|--no-stun]]]bothy statusbothy devices list | rename <id> <name> | prune <id> --yesbothy snapshot createbothy compact [--dry-run]bothy conflicts [--since 2h|2026-10-21] | --clearbothy inspect remote | scan <text>…bothy export <collection> | --allGlobal options
Section titled “Global options”--db <name>picks a local database (defaultdefault).--jsonprints machine-readable output.--password-stdinreads passwords from stdin, one per line.
Exit codes
Section titled “Exit codes”| Code | Meaning |
|---|---|
| 0 | ok |
| 1 | error |
| 2 | usage |
| 3 | sign-in needed |
| 4 | offline |
| 5 | remote inconsistent or format too new |
Two machines
Section titled “Two machines”# machine 1bothy auth loginbothy init --remote folder:notesbothy put notes n1 '{"title": "Hello"}'bothy sync
# machine 2, a headless boardbothy auth setup --device-client client_secret_tv.jsonbothy auth login --device # shows a code to enter at google.com/devicebothy join --remote folder:notesbothy get notes n1Checking encryption
Section titled “Checking encryption”bothy inspect scan <text>… downloads every remote file of the database and fails if any
contains the text: a quick check that nothing you care about reaches Drive in plain text.
- Config and OAuth clients:
~/.config/bothyon Linux, the platform config directory elsewhere. - Databases:
~/.local/share/bothy/<db>.dbon Linux. BOTHY_HOME=<dir>puts everything under one directory.- The sign-in goes to the OS keyring, or to a file readable only by you where there is
none (
BOTHY_TOKEN_STORE=fileforces the file). Tokens are never printed.