keybase /client
Keybase Go Library, Client, Service, OS X, iOS, Android, Electron
★ 9,272⑂ 1,289👁 276⑃ 20,352● 7,593▤ 110
+1
Daily
9,272
stars
1,289
forks
276
watchers
20,352
prs
7,593
issues
110
releases
README
Keybase
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.
If you're interested in our Docker image releases, please check out the Docker README.
!Sharing
Code Layout
- go: Core crypto libraries; the Keybase service; the command line client. Learn More
- shared/{android,ios}: 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 permiTop issues
#24105Open source the server components of Keybase177 comments · 2020-05-07#6899Release mobile app to f-droid67 comments · 2017-05-08#24764keybase client causing `/` mount issues under Ubuntu 22.04, Fedora 34 and newer60 comments · 2021-12-28#6374Server?51 comments · 2017-03-27#2032Decryption issue?48 comments · 2016-02-15#8999Keybase Install Error - macOS Sierra 10.12.647 comments · 2017-10-12#21097Airdrop pending 45 comments · 2019-11-19#24819kbfs Finder integration in macOS Catalina/Mojave broken with 5.9.2 release44 comments · 2022-02-02
Latest release
v6.6.3 v6.6.3 2026-06-03• Push notification handling for multiple accounts, account switching • Support audio attachments • Various bug fixes