Skip to content
Permalink
master
Switch branches/tags
Go to file
 
 
Cannot retrieve contributors at this time
require 'yaml'
require 'fileutils'
cheatsheet do
title 'Keybase.io'
docset_file_name 'Keybase.io'
keyword 'keybase'
source_url 'http://cheat.kapeli.com'
style <<-EOS
td.command {
text-align: right;
vertical-align:middle;
}
td.description .name {
display: none;
}
.single-icon td.description {
width: 1%;
text-align: center;
}
.example-single-command.category-layouts td.command,
.example-single-command.category-layouts td.td_command:nth-child(1) {
width: 12em;
}
.example-single-command.category-layouts td.description {
/* override width for Layouts category */
width: 13em;
}
/* bootstrap color for stacking example */
.text-danger {
color: #a94442;
}
EOS
category do
id 'Getting Going'
entry do
command 'version'
name 'Version'
notes '
```terminal
keybase version
```
Print the version number.'
end
entry do
command 'help'
name 'Help'
notes '
```terminal
keybase help
```
Get help.'
end
entry do
command 'signup'
name 'Sign up'
notes '
```terminal
keybase signup
```
Sign up.'
end
entry do
command 'login'
name 'Login'
notes '
```terminal
keybase login
```
Login.'
end
end
category do
id 'Proving Accounts'
entry do
command 'prove twitter'
name 'Prove Twitter'
notes '
```terminal
keybase prove twitter
```
Prove you own a [Twitter](https://twitter.com) account.'
end
entry do
command 'prove github'
name 'Prove GitHub'
notes '
```terminal
keybase prove github
```
Prove you own a [GitHub](https://github.com) account.'
end
entry do
command 'prove reddit'
name 'Prove Reddit'
notes '
```terminal
keybase prove reddit
```
Prove you own a [Reddit](https://reddit.com) account.'
end
entry do
command 'prove coinbase'
name 'Prove Coinbase'
notes '
```terminal
keybase prove coinbase
```
Prove you own a [Coinbase](https://coinbase.com) account.'
end
entry do
command 'prove hackernews'
name 'Prove Hacker News'
notes '
```terminal
keybase prove hackernews
```
Prove you own a [YCombinator - Hacker News](https://news.ycombinator.com/) account.'
end
entry do
command 'prove web you.com'
name 'Prove website via HTTP'
notes '
```terminal
keybase prove web you.com
```
Prove you own the domain/website you are claiming via HTTP.'
end
entry do
command 'prove dns you.com'
name 'Prove website via DNS'
notes '
```terminal
keybase prove dns you.com
```
Prove you own the domain/website you are claiming via DNS.'
end
end
category do
id 'Pushing / Revoking Your Key'
entry do
command 'push'
name 'Push key'
notes'
```terminal
keybase push
```
Push your public key to [Keybase](https://keybase.io).'
end
entry do
command 'revoke'
name 'Revoke key'
notes'
```terminal
keybase revoke
```
Remove/replace your public key.'
end
end
category do
id 'Id\'ing and Tracking'
entry do
command 'search'
name 'Search'
notes '
```terminal
keybase search <user>
```
Find users like `<user>`.'
end
entry do
command 'id'
name 'Identify'
notes '
```terminal
keybase id <user>
```
Look <user> up, verify identity.'
end
entry do
command 'track'
name 'Track'
notes '
```terminal
keybase track <user>
```
Same as id, but track publicly.'
end
entry do
command 'track --track-local'
name 'Track local only'
notes '
```terminal
keybase track <user> --track-local
```
Track, but local only.'
end
end
category do
id 'Bitcoin'
entry do
command 'btc'
name 'Bitcoin'
notes '
```terminal
keybase btc <bitcoin>
```
Sign and set the [Bitcoin](https://bitcoin.org/en/) address on your profile.'
end
end
category do
id 'Encrypting'
entry do
command 'encrypt -m'
name 'Encrypt message'
notes '
```terminal
keybase encrypt <user> -m <message>
```
Encrypt message.'
end
entry do
command 'encrypt -s -m'
name 'Encrypt message and sign it'
notes '
```terminal
keybase encrypt <user> -s -m <message>
```
Encrypt message and also sign it.'
end
entry do
command 'encrypt <file.txt>'
name 'Encrypt file'
notes '
```terminal
keybase encrypt <user> <file.txt>
```
Encrypt file `<file.txt>` to `<file.asc>`.'
end
entry do
command 'encrypt <file.txt> -o'
name 'Encrypt file with output'
notes '
```terminal
keybase encrypt <user> <file.txt> -o <output.asc>
```
Encrypt file `<file.txt>` to the provided `<output.asc>`.'
end
entry do
command 'echo | encrypt'
name 'Encrypt stream'
notes '
```terminal
echo \'secret\' | keybase encrypt <user>
```
Encrypt stream.'
end
end
category do
id 'Decrypting'
entry do
command 'decrypt <file.txt.asc>'
name 'Decrypt file'
notes '
```terminal
keybase decrypt <file.txt.asc>
```
Decrypt `<file.txt.asc>` to `stdout`.'
end
entry do
command 'decrypt -o'
name 'Decrypt with output'
notes '
```terminal
keybase decrypt <file.txt.asc> -o <output.txt>
```
Decrypt `<file.txt.asc>` to the provided `<output.txt>`.'
end
entry do
command 'decrypt'
name 'Decrypt stream'
notes '
```terminal
cat <file.txt.asc> | keybase decrypt
```
Decrypt stream.'
end
end
category do
id 'Signing'
entry do
command 'sign -m'
name 'Sign message'
notes '
```terminal
keybase sign -m <message>
```
Sign message.'
end
entry do
command 'pgp sign --clearsign -m'
name 'Sign message without encoding'
notes '
```terminal
keybase pgp sign --clearsign -m <message>
```
Sign, but don\'t encode contents.'
end
entry do
command 'sign <file.txt> --detach-sign'
name 'Generate signature only'
notes '
```terminal
keybase sign <file.txt> --detach-sign
```
Generate signature `<file.txt.asc>`.'
end
entry do
command 'echo'
name 'Sign stream'
notes '
```terminal
echo <message> | keybase sign
```
Sign stream.'
end
end
category do
id 'Verifying'
entry do
command 'verify <file.txt.asc>'
name 'Verify file'
notes '
```console
keybase verify <file.txt.asc>
```
Verify self-signed file.'
end
entry do
command 'verify <file.txt.asc> <file.txt>'
name 'Verify file with detached signature'
notes '
```console
keybase verify <file.txt.asc> <file.txt>
```
Verify file with detached signature.'
end
entry do
command 'verify'
name 'Verify stream'
notes '
```console
cat <file.txt.asc> | keybase verify
```
Verify stream of self-signed file.'
end
end
notes <<-'END'
* Alpha command list for [Keybase](https://keybase.io)'s command line tool, taken from Keybase's [documentation page](https://keybase.io/docs/command_line)
* Last updated: 12/04/14
END
end