Installation

Instructions for building and installing Charl on Linux, macOS, and Windows.

Prerequisites

Before installing Charl, ensure the following software is installed:

  • Rust 1.70+ — Available from rustup.rs
  • Git — For cloning the repository

Installing Rust

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Linux and macOS

Step 1: Clone Repository

git clone https://github.com/charlcoding-stack/charlcode.git
cd charlcode

Step 2: Build

cargo build --release

Compilation takes approximately 2-5 minutes depending on system specifications.

Step 3: Install Binary

sudo cp target/release/charl /usr/local/bin/

Step 4: Verify Installation

charl --version

Expected output: charl 0.1.0

Windows

Step 1: Install Rust

Download and run rustup-init.exe from rustup.rs

Step 2: Clone and Build

git clone https://github.com/charlcoding-stack/charlcode.git
cd charlcode
cargo build --release

Step 3: Add to PATH

Copy target\release\charl.exe to a directory in your PATH, or:

copy target\release\charl.exe C:\Windows\System32\

Troubleshooting

Command not found

Ensure /usr/local/bin is in your PATH:

echo $PATH

Permission denied

Alternative installation to user directory:

mkdir -p ~/.local/bin
cp target/release/charl ~/.local/bin/
export PATH="$HOME/.local/bin:$PATH"

Note: Add the export command to ~/.bashrc or ~/.zshrc for permanent effect.

Next Steps