README ¶
Keybase
Hi, and welcome to the Keybase client repo. All our client apps (OSX, Windows, Linux, iOS, and Android) are being actively developed in this repository. Please, dig around.
Warnings
We'd love you to read our source code.
But - some of the things in this repo are explorations, and the app you build from source just might not do what it says it's doing. So, if you just want to install Keybase on your computer, you should monitor our releases for OSX, Linux, or Windows.
Code Layout
- go: Core crypto libraries; the Keybase service; the command line client. Learn More
- react-native: Android and iOS apps developed with React Native.
- desktop: Desktop application for OSX, Linux and Windows, made with the Electron framework, sharing React code with react-native.
- packaging: Scripts for releasing packages across the various platforms.
- protocol: Defines the protocol for communication for clients to the Keybase services. Uses Avro. Learn More
- media: Icons, graphics, media for Keybase apps.
- osx: The Mac OS X Keybase.app, development parallel to an Electron-based application above. Learn More
Problems?
Report any issues with client software on this GitHub issue tracker. Internally, we track our progress using Jira, but all PRs come through GitHub for your review!
If you're having problem with our Website, try the keybase-issues issue tracker.
We check and update both frequently.
License
Most code is released under the New BSD (3 Clause) License. If subdirectories include a different license, that license applies instead.
Directories ¶
Path | Synopsis |
---|---|
go
|
|
client
this command is only for testing purposes
|
this command is only for testing purposes |
engine
PaperKeyPrimary creates the initial paper backup key for a user.
|
PaperKeyPrimary creates the initial paper backup key for a user. |
libkb
Code used in populating JSON objects to generating Keybase-style signatures.
|
Code used in populating JSON objects to generating Keybase-style signatures. |
minterm
Package minterm implements minimal terminal functions.
|
Package minterm implements minimal terminal functions. |