.TH CHARM 1 "2023-07-26" "charm" "Do Charm stuff"
.SH NAME
charm - Do Charm stuff
.SH SYNOPSIS
\fBcharm\fP [\fIoptions\&.\&.\&.\fP] [\fIargument\&.\&.\&.\fP]
.SH DESCRIPTION
                                                            
.PP
  Do Charm stuff\&. Run without arguments for a TUI or use the
.PP
  sub-commands like a pro\&.                                  
.SH COMMANDS
.TP
\fBbackup-keys\fP
.RS 4
Backup your Charm account keys
.RE
.TP
\fBOPTIONS\fP
.RS 4
\fB--o --output\fP
keys backup filepath
.RE
.TP
\fBcompletion\fP [bash|zsh|fish|powershell]
.RS 4
Generate shell completion
.RE
.TP
\fBcrypt\fP
.RS 4
Use Charm encryption\&.
.RE
.TP
\fBCOMMANDS\fP
.RS 4
\fBdecrypt\fP
.RS 4
Decrypt stdin with your Charm account encryption key
.RE
.TP
\fBdecrypt-lookup\fP
.RS 4
Decrypt arg deterministically
.RE
.TP
\fBencrypt\fP
.RS 4
Encrypt stdin with your Charm account encryption key
.RE
.TP
\fBencrypt-lookup\fP
.RS 4
Encrypt arg deterministically
.RE
.RE
.TP
\fBfs\fP
.RS 4
Use the Charm file system\&.
.RE
.TP
\fBCOMMANDS\fP
.RS 4
\fBcat\fP [charm:]PATH
.RS 4
Output the content of the file at path\&.
.RE
.TP
\fBcp\fP [charm:]PATH [charm:]PATH
.RS 4
Copy a file, preface source or destination with "charm:" to specify a remote path\&.
.RE
.TP
\fBOPTIONS\fP
.RS 4
\fB--r --recursive\fP
copy directories recursively
.RE
.TP
\fBls\fP [charm:]PATH
.RS 4
List file or directory at path
.RE
.TP
\fBmv\fP [charm:]PATH [charm:]PATH
.RS 4
Move a file, preface source or destination with "charm:" to specify a remote path\&.
.RE
.TP
\fBOPTIONS\fP
.RS 4
\fB--r --recursive\fP
move directories recursively
.RE
.TP
\fBrm\fP [charm:]PATH
.RS 4
Remove file or directory at path
.RE
.TP
\fBtree\fP [charm:]PATH
.RS 4
Print a file system tree from path\&.
.RE
.RE
.TP
\fBhelp\fP [command]
.RS 4
Help about any command
.RE
.TP
\fBid\fP
.RS 4
Print your Charm ID
.RE
.TP
\fBimport-keys\fP BACKUP\&.tar
.RS 4
Import previously backed up Charm account keys\&.
.RE
.TP
\fBOPTIONS\fP
.RS 4
\fB--f --force-overwrite\fP
overwrite if keys exist; don’t prompt for input
.RE
.TP
\fBjwt\fP
.RS 4
Print a JWT
.RE
.TP
\fBkeys\fP
.RS 4
Browse or print linked SSH keys
.RE
.TP
\fBOPTIONS\fP
.RS 4
\fB--r --randomart\fP
print SSH 5\&.1 randomart for each key (the Drunken Bishop algorithm)
.TP
\fB--s --simple\fP
simple, non-interactive output (good for scripts)
.RE
.TP
\fBkv\fP
.RS 4
Use the Charm key value store\&.
.RE
.TP
\fBCOMMANDS\fP
.RS 4
\fBdelete\fP KEY[@DB]
.RS 4
Delete a key with an optional @ db\&.
.RE
.TP
\fBget\fP KEY[@DB]
.RS 4
Get a value for a key with an optional @ db\&.
.RE
.TP
\fBOPTIONS\fP
.RS 4
\fB--b --show-binary\fP
print binary values
.RE
.TP
\fBlist\fP [@DB]
.RS 4
List all key value pairs with an optional @ db\&.
.RE
.TP
\fBOPTIONS\fP
.RS 4
\fB--d --delimiter\fP
delimiter to separate keys and values
.TP
\fB--k --keys-only\fP
only print keys and don't fetch values from the db
.TP
\fB--r --reverse\fP
list in reverse lexicographic order
.TP
\fB--b --show-binary\fP
print binary values
.TP
\fB--v --values-only\fP
only print values
.RE
.TP
\fBreset\fP [@DB]
.RS 4
Delete local db and pull down fresh copy from Charm Cloud\&.
.RE
.TP
\fBset\fP KEY[@DB] VALUE
.RS 4
Set a value for a key with an optional @ db\&.
.RE
.TP
\fBsync\fP [@DB]
.RS 4
Sync local db with latest Charm Cloud db\&.
.RE
.RE
.TP
\fBlink\fP [code]
.RS 4
Link multiple machines to your Charm account
.RE
.TP
\fBname\fP [username]
.RS 4
Username stuff
.RE
.TP
\fBserve\fP
.RS 4
Start a self-hosted Charm Cloud server\&.
.RE
.TP
\fBOPTIONS\fP
.RS 4
\fB--data-dir\fP
Directory to store SQLite db, SSH keys and file data
.TP
\fB--health-port\fP
Health port to listen on
.TP
\fB--http-port\fP
HTTP port to listen on
.TP
\fB--ssh-port\fP
SSH port to listen on
.TP
\fB--stats-port\fP
Stats port to listen on
.RE
.TP
\fBwhere\fP
.RS 4
Find where your cloud\&.charm\&.sh folder resides on your machine
.RE
.SH COPYRIGHT
(C) 2021-2022 Charmbracelet, Inc\&.
.PP
Released under MIT license\&.