gh-gpt is both an executable binary that can be run, and a library that can be used in Rust programs.

Installing the command-line executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install gh-gpt

It will make the gh-gpt command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall gh-gpt uninstalls.

Adding gh_gpt library as a dependency

Run this command in a terminal, in your project's directory:

cargo add gh-gpt

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

gh-gpt = "0.1.1"

The gh_gpt library will be automatically available globally. Read the gh_gpt library documentation.

Back to the crate overview.