alexxnica / kythe

Kythe is a pluggable, (mostly) language-agnostic ecosystem for building tools that work with code.

Kythe

Table of Contents

• Features
• Getting Started
• Contributing and Building Kythe
• Issue Tracker
• Documentation
• Examples
• Contact

Features

• Extensive documentation of the Kythe schema

• Indexer implementations for C++ and Java

• Compilation extractors for javac, Maven, cmake, Go, and Bazel

• Generic verifier for indexers

• Sample cross-reference service and accompanying web UI

• Many useful utility commands to work with Kythe artifacts

Getting Started

Download the latest Kythe release from https://github.com/google/kythe/releases and then unpack it for a snapshot of Kythe’s toolset.

tar xzf kythe-v*.tar.gz
rm -rf /opt/kythe
mv kythe-v*/ /opt/kythe

See /opt/kythe/README for a complete description of the packaged tools and their usages.

Contributing and Building Kythe

https://kythe.io/contributing

Issue Tracker

https://kythe.io/phabricator/maniphest

Documentation

https://kythe.io/docs/

Examples

https://kythe.io/examples

Contact

• https://groups.google.com/forum/#!forum/kythe - General Kythe Community

• https://groups.google.com/forum/#!forum/kythe-dev - Kythe Development