- Get the Kythe source code
- Building Kythe
- Updating and building the website
Get the Kythe source code
Decide where you want to store kythe code, e.g.
~/my/code/dir (note that
after we clone from git, it will append ‘kythe’ as the last directory).
Also set the env var
KYTHE_DIR=~/my/code/dir/kythe in your
while you’re at it.
If you use ssh to authenticate to github:
Kythe relies on the following external dependencies:
- clang >= 8
- docker (for release images
- go >= 1.7
- jdk >= 8
You will need to ensure these packages are installed on the system where you
intend to build Kythe. There are instructions for using
If you are using macOS, see Instructions for macOS.
Installing Debian Jessie Packages
Troubleshooting bazel/clang/llvm errors
You must either have
/usr/bin/clang aliased properly, or the
CC env var set
If you ran bazel and get errors like this:
then you need to clean and rebuild your TOOLCHAIN:
Note also that Kythe depends on LLVM, which in turn requires support for C++14.
In most installations, C++14 is not enabled by default, so the default Kythe
.bazelrc includes the necessary flag (
-std=c++14) to enable it.
If you have user-specific Bazel settings that override the defaults, you may
need to include these flags explicitly. If you get errors about undefined C++14
names (such as
std::is_final), check for this.
Building using Bazel
Please note that you must use a non-jdk7 version of Bazel. Some package managers
may provide the jdk7 version by default. To determine if you are using an
incompatible version of Bazel, look for
jdk7 in the build label that
is printed by
Also note that not all targets build with
//... - some targets are
purposefully omitted. This includes
many of the docker images we push.
Build a release of Kythe using Bazel and unpack it in /opt/kythe
Many examples on the site assume you have installed kythe in /opt/kythe.
Using the Go tool to build Go sources directly
Kythe’s Go sources can be directly built with the
go tool as well as with
The additional benefits of using Bazel are the built-in support for generating
the Go protobuf code in
kythe/proto/ and the automatic usage of the checked-in
third_party/go libraries (instead of adding to your
GOPATH). However, for
quick access to Kythe’s Go sources (which implement most of Kythe’s platform and
language-agnostic services), using the Go tool is very convenient.
Updating and building the website
- Make change in ./kythe/web/site
- Spell check
- Build a local version to verify fixes
Build and serve: