Installation

The codetour command line tool is called ct.

Install from binaries

Coming soon! See #54 for more information.

Precompiled binaries are provided for major platforms on a best-effort basis. Visit the releases page to download the appropriate version for your platform.

Install from source

The codetour tool can also be installed from its source code.

Codetour is written in Rust and therefore needs to be compiled with Cargo. If you haven't already installed Rust, please install it now.

Install crates.io version

Once you have Rust and Cargo, installing codetour is relatively easy.

Run the following command:

cargo install codetour

This will fetch the source code for the latest release from crates.io and compile it. You will have to have Cargo's bin directory to your PATH.

Run ct help in your terminal to verify if it works. Congratulations, you have installed codetour!

Add the --force flag to this command to update your installation to the latest release.

Install git version

The git version contains all the latest bug-fixes and features that will be released in the next version on crates.io. If you can't wait until the next release, you can build the git version yourself. Open your terminal and navigate to the directory of you choice. We need to clone the git repository and then build it with Cargo.

git clone --depth=1 https://github.com/sunjay/codetour.git
cd codetour
cargo build --release

The executable ct will be in the ./target/release folder, this should be added to your PATH.

Getting Started

Once you have codetour installed, you can start a new project with the new command or build an existing project with the build command. See their respective documentation for more information.

The remaining sections of this documentation go through other supported commands as well as the many features of codetour.