tree: 25a879fb45e8ef97cc5eced0300e2168200fe37f [path history] [tgz]
  1. src/
  2. .gitignore
  3. build.rs
  4. Cargo.toml
  5. README.md
kythe/rust/cargo-kythe/README.md

cargo-kythe

cargo-kythe is a cargo subcommand for managing Kythe indices of cargo projects.

Installation

To install cargo-kythe simply enter the following command:

cargo install cargo-kythe

cargo-kythe requires nightly rust

Usage

cargo-kythe reads an environment variable KYTHE_DIR to determine the path to the local installation of kythe. You will probably need to download it from kythe/kythe

To index the top level package:

cargo kythe index

To index the package and all its dependencies:

cargo kythe full-index

To launch the sample web UI for viewing cross-references:

cargo kythe web

Indices are constructed in the target/kythe directory.