LinuxCommandLibrary

keybase

Secure messaging, file sharing, cryptographic identity

TLDR

Follow another user

$ keybase follow [username]
copy

Add a new proof
$ keybase prove [service] [service_username]
copy

Sign a file
$ keybase sign [[-i|--infile]] [input_file] [[-o|--outfile]] [output_file]
copy

Verify a signed file
$ keybase verify [[-i|--infile]] [input_file] [[-o|--outfile]] [output_file]
copy

Encrypt a file
$ keybase encrypt [[-i|--infile]] [input_file] [[-o|--outfile]] [output_file] [receiver]
copy

Decrypt a file
$ keybase decrypt [[-i|--infile]] [input_file] [[-o|--outfile]] [output_file]
copy

Revoke current device, log out, and delete local data
$ keybase deprovision
copy

SYNOPSIS


keybase [global-options] <command> [command-options] [arguments]

Examples of common usage:
keybase login
keybase chat send teamname "Hello, world!"
keybase fs ls /keybase/private/yourusername
keybase pgp encrypt -i file.txt -o file.txt.pgp username
keybase git create myrepo

PARAMETERS

--debug
    Enables verbose debugging output for diagnostics and troubleshooting.

--json
    Outputs command results in machine-readable JSON format, useful for scripting and integration.

--force
    Forces an operation that might otherwise require confirmation or be prevented. Use with caution.

--home <path>
    Specifies the Keybase home directory, overriding the default system location.

--log-file <path>
    Directs Keybase's log output to the specified file instead of standard error.

-U, --username <name>
    Specifies the username to use for commands that require a specific identity.

-P, --paperkey <key>
    Provides a paper key directly for login or device provisioning without interactive prompts.

DESCRIPTION

Keybase is a cross-platform application that leverages public-key cryptography to provide secure communication, file storage, and identity verification. It allows users to cryptographically prove their online identities (e.g., Twitter, GitHub) by signing them with their Keybase cryptographic key. The keybase command-line interface provides access to a comprehensive suite of features, including end-to-end encrypted chat, a secure Git repository hosting service (Keybase Git), and a distributed, encrypted file system (KBFS). It acts as a powerful tool for developers and security-conscious individuals to manage cryptographic keys, sign and verify data, and interact securely within the Keybase ecosystem. The command-line utility interacts with a background service/daemon that handles the cryptographic operations and network communication.

CAVEATS

Keybase's functionality heavily relies on its background service (daemon), which must be running for most commands to work. While Keybase aims for strong security, the security of your account ultimately depends on the security of your devices and master key. Some features, like the 'public folders' on KBFS, are publicly readable, so care must be taken with sensitive data. The Keybase service was acquired by Zoom in 2020, which has led to some community discussion regarding its future and independence.

KEY CONCEPTS


Keybase utilizes public-key cryptography to establish a chain of trust, linking users' social media identities to their cryptographic keys. It supports identity proofs (e.g., verifying Twitter or GitHub accounts) and device management, allowing users to securely add and revoke devices. The platform offers end-to-end encryption for all communications and file storage.

CLIENT-SERVER ARCHITECTURE


The keybase command-line utility acts as a client that communicates with a persistent background service, or daemon. This daemon handles the complex cryptographic operations, network interactions, and file system mounting (for KBFS). Users typically interact with the keybase command, which then relays requests to the running service.

HISTORY

Keybase was publicly launched in 2014-2015, initially focusing on providing an easy-to-use interface for PGP and cryptographically proving online identities. Over time, it expanded significantly to include a secure chat client, an encrypted file system (KBFS), and a Git hosting service. The development focused on integrating cryptographic primitives into everyday tools for mass adoption. In May 2020, Keybase was acquired by Zoom, which continues to maintain and develop the service, though some features like Keybase Teams for businesses were discontinued post-acquisition.

SEE ALSO

gpg(1), openssl(1), git(1), ssh(1), finger(1)

Copied to clipboard