Installation

Prerequisites

To build and run Felico, you’ll need:

Currently, Felico is only available by building from source. Follow these steps:

git clone https://github.com/mwoelker/felico.git
cd felico

cargo build --release

The compiled binary will be available at target/release/felico.

To use felico from anywhere, add the binary to your PATH:

Linux/macOS:

export PATH="$PATH:$(pwd)/target/release"

Add this line to your ~/.bashrc or ~/.zshrc to make it permanent.

Windows: Add C:\path\to\felico\target\release to your system PATH environment variable.

felico --version

If you plan to contribute to Felico, also set up the git hooks:

./scripts/git-hooks/install-hooks.sh

This will enable pre-commit checks that run formatting, linting, and tests.

Now that you have Felico installed, head to the Quick Start guide to write your first program!