Keybase Go Library, Client, Service, OS X, iOS, Android, Electron
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Quick fix for CircleCI (#15612) Jan 20, 2019
browser Update button border radii. (#14115) Oct 5, 2018
git-hooks use pre-commit.com hooks for everything (#6022) Feb 27, 2017
go also bust home cache on announcent change (#15608) Jan 19, 2019
media Added key pattern to public assets (#11795) May 11, 2018
osx bump installer version to 1.1.68 (#15313) Jan 4, 2019
packaging packaging: Require an active dbus service if the systemd user manager… ( Jan 16, 2019
protocol also bust home cache on announcent change (#15608) Jan 19, 2019
pvl-tools fix (#12023) May 24, 2018
shared Hook up Reloadable for mobile for the wallets tab (#15541) Jan 20, 2019
.codecov.yml New Avatar sizes (#11837) May 21, 2018
.editorconfig Chat2: rolled up (#10744) Mar 9, 2018
.eslintignore Prep for platform specific flow (#11925) May 22, 2018
.eslintrc Sort keys 2: The Sortening (#14934) Dec 5, 2018
.gitattributes customResponseIncomingCallMap (#13742) Sep 14, 2018
.gitignore files were being excluded by exuberant .gitignore rule Dec 14, 2018
.pre-commit-config.yaml remove prettier eslint (#11796) May 14, 2018
.prettierignore update prettier (#14095) Oct 5, 2018
.prettierrc customResponseIncomingCallMap (#13742) Sep 14, 2018
CODEOWNERS Try out GitHub's code owners feature Jul 18, 2017
Jenkinsfile jenkins: Disable systests on Windows (#15587) Jan 18, 2019
LICENSE BSD-3-clause license here too Nov 1, 2015
README.md README: Add some contributor guidelines. Oct 9, 2017
docker-compose.yml bump max mysql conns for ci (#14059) Oct 3, 2018

README.md

Keybase Build Status Build status

Hi, and welcome to the Keybase client repo. All our client apps (macOS, 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 macOS, Linux, or Windows.

Sharing

Code Layout

  • go: Core crypto libraries; the Keybase service; the command line client. Learn More
  • shared/react-native: Android and iOS apps developed with React Native.
  • shared/desktop: Desktop application for macOS, 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 macOS 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 problems with the command line keybase client, take a look at the troubleshooting doc.

If you're having problems 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.

Development Guidelines

We check all git commits with pre-commit hooks generated via pre-commit.com pre-commit hooks. To enable use of these pre-commit hooks:

  • Install the pre-commit utility. For some common cases:
    • pip install pre-commit
    • brew install pre-commit
  • Remove any existing pre-commit hooks via rm .git/hooks/pre-commit
  • Configure via pre-commit install

Then proceed as normal.

External Contributors

If you forked this repository on GitHub and made a PR, then it'll show up as having failed Jenkins CI. We do not build external PRs because it's a security risk to do so without a review first. If your PR is successfully reviewed by a member of the Keybase team, then we will merge your commits to a branch on our primary fork and build from there.

Cryptography Notice

This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software. BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted. See http://www.wassenaar.org/ for more information.

The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms. The form and manner of this distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code.