README
¶
Keybase
Welcome to the Keybase client repository! You'll find here everything from our core crypto libraries to the last-mile UX used to power our mobile and desktop clients. What we have here is still very much a work-in-progress, with some code more mature than others.
Code Layout
- go: Core crypto libraries; the Keybase service and command line client. Learn More
- electron: Desktop application for OSX, Linux and Windows, made via the electron framework framework
- 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
- react-native: Android and iOS apps developed via the react-native framework.
- 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. |
Click to show internal directories.
Click to hide internal directories.