Setup

Installing Rust

Before installing Clings, you must have the latest version of Rust installed. Visit www.rust-lang.org/tools/install for further instructions. This will also install Cargo, Rust's package/project manager.

🐧 If you are on Linux, make sure you have gcc installed (for a linker).

Debian: sudo apt install gcc
Fedora: sudo dnf install gcc

🍎 If you are on MacOS, make sure you have Xcode and its developer tools installed: xcode-select --install

Installing Clings

The following command will download and compile Clings:

cargo install clings

If the installation fails… (click to expand)

Make sure you have the latest Rust version by running rustup update

Try adding the --locked flag: cargo install clings --locked

Otherwise, please report the issue

Initialization

After installing Clings, run the following command to initialize the clings/ directory:

clings init

If the command clings can't be found… (click to expand)

You are probably using Linux and installed Rust using your package manager.

Cargo installs binaries to the directory ~/.cargo/bin. Sadly, package managers often don't add ~/.cargo/bin to your PATH environment variable.

Either add ~/.cargo/bin manually to PATH

Or uninstall Rust from the package manager and install it using the official way with rustup

Now, go into the newly initialized directory and launch Clings for further instructions on getting started with the exercises:

cd clings/
clings

Working environment

Editor

Our general recommendation is VS Code with the rust-analyzer plugin. But any editor that supports rust-analyzer should be enough for working on the exercises.

Terminal

While working with Clings, please use a modern terminal for the best user experience. The default terminal on Linux and Mac should be sufficient. On Windows, we recommend the Windows Terminal.

Usage

After being done with the setup, visit the usage page for some info about using Clings 🚀