charm

Encrypted cloud storage and key-value database

TLDR

Store a key-value pair
$ charm kv set [key] [value]
Retrieve a value
$ charm kv get [key]
List all keys
$ charm kv list
Delete a key
$ charm kv delete [key]
Encrypt a file using Charm keys
$ charm crypt encrypt [path/to/file]
Decrypt a file encrypted with Charm keys
$ charm crypt decrypt [path/to/file.enc]
Sync local data to Charm Cloud
$ charm sync
Show account identity and linked devices
$ charm id
Back up encryption keys to a file
$ charm backup-keys

SYNOPSIS

charm command [options] [arguments]

DESCRIPTION

charm is a command-line tool from Charmbracelet providing end-to-end encrypted cloud storage, key-value database, and file encryption. It enables syncing data securely across devices without managing your own server.The kv commands provide a simple key-value store useful for configuration, secrets, and application state. All data is encrypted client-side before syncing to Charm Cloud, ensuring privacy.File encryption via charm crypt uses your Charm keys to encrypt any file. The fs command provides a virtual file system stored in the cloud. Device linking allows accessing the same data from multiple machines.

PARAMETERS

kv set key value

Store a key-value pair.
kv get key
Retrieve value for key.
kv list
List all stored keys.
kv delete key
Delete a key-value pair.
crypt encrypt file
Encrypt a file.
crypt decrypt file
Decrypt a file.
sync
Synchronize with Charm Cloud.
id
Show or manage account identity.
link
Link a new device to account.
backup-keys
Export encryption keys.
fs
Access Charm file system.
-o, --output file
Output file for operations.

INSTALL

sudo pacman -S charm
brew install charm
nix profile install nixpkgs#charm

CAVEATS

Data is encrypted, but requires trusting Charm Cloud infrastructure. The free tier has storage limits. Key backup is essential - losing keys means losing access to data. Self-hosting is possible but requires more setup.

HISTORY

Charm was created by Charmbracelet, a company focused on making the command line more delightful, founded in 2020. Known for TUI libraries like Bubble Tea and Lip Gloss, they developed Charm Cloud as infrastructure for CLI tools needing cloud sync. The service launched to provide developers with easy, encrypted cloud storage without complex setup.

SEE ALSO

pass(1), age(1), glow(1), gpg(1)