About this project

Keybase/client is the official source repository for the Keybase client ecosystem. It bundles the core Go libraries (crypto primitives, the Keybase service, and the `keybase` command-line client) alongside the user-facing applications for every major platform: a macOS native app under `osx/`, a cross-platform desktop app under `shared/desktop` built on Electron, and mobile apps for iOS and Android under `shared/{ios,android}` written in React Native so that React code is shared between desktop and mobile. The `protocol/` directory defines the Avro-based wire protocol used by clients to talk to Keybase services, `packaging/` holds release scripts for each platform (including a Docker image for Linux), and `media/` stores icons and graphics. The README is explicit that some parts of the tree are explorations and that building from source may not produce a fully working app; users who only want to install Keybase are pointed to the official release page. Contributors are expected to install pre-commit hooks via pre-commit.com, and external pull requests are not built by Jenkins CI until a Keybase team member reviews them, since building unreviewed code is treated as a security risk. Issues are tracked on GitHub, with a separate `keybase-issues` tracker for website problems and a troubleshooting doc for the CLI. Most of the code is released under the New BSD 3-Clause License, with subdirectory-specific licenses taking precedence where noted. The repository also carries a standard cryptographic-software export notice (ECCN 5D002.C.1, TSU exception) reminding users to check their local laws before using the encryption code.