Installation
caro is available via Homebrew, Cargo, and as a standalone binary.
Homebrew
Section titled “Homebrew”| Install | Upgrade |
|---|---|
brew install wildcard/tap/caro | brew upgrade caro |
cargo install caro
# For Apple Silicon with MLX GPU acceleration:cargo install caro --features embedded-mlxPrecompiled binaries
Section titled “Precompiled binaries”Download from the releases page or use the install script:
curl -fsSL https://setup.caro.sh | bashLinux & BSD
Section titled “Linux & BSD”caro is available via Cargo and as precompiled binaries for most Linux distributions.
cargo install caroDebian, Ubuntu (apt)
Section titled “Debian, Ubuntu (apt)”# Add repository (coming soon)# sudo apt install caro
# For now, use the install script:curl -fsSL https://setup.caro.sh | bashFedora, CentOS, RHEL (dnf)
Section titled “Fedora, CentOS, RHEL (dnf)”# Package coming soon. For now, use:curl -fsSL https://setup.caro.sh | bashPrecompiled binaries
Section titled “Precompiled binaries”Download from the releases page:
| Platform | Download |
|---|---|
| Linux x86_64 | caro-linux-amd64 |
| Linux ARM64 | caro-linux-arm64 |
Windows
Section titled “Windows”caro is available via WinGet, Cargo, and as a standalone binary.
WinGet
Section titled “WinGet”# Coming soon# winget install wildcard.carocargo install caroPrecompiled binary
Section titled “Precompiled binary”Download caro-windows-amd64.exe from the releases page.
Build from source
Section titled “Build from source”git clone https://github.com/wildcard/caro.gitcd carocargo build --release./target/release/caro --versionPrerequisites: Rust 1.83+, CMake. For Apple Silicon GPU acceleration, install Xcode.
# Install Rustcurl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | shsource "$HOME/.cargo/env"
# Install CMake via Homebrewbrew install cmake
# Clone and buildgit clone https://github.com/wildcard/caro.gitcd carocargo build --release# Install dependenciessudo apt updatesudo apt install -y build-essential cmake curl
# Install Rustcurl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | shsource "$HOME/.cargo/env"
# Clone and buildgit clone https://github.com/wildcard/caro.gitcd carocargo build --release# Install dependenciessudo dnf install -y cmake gcc-c++ curl
# Install Rustcurl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | shsource "$HOME/.cargo/env"
# Clone and buildgit clone https://github.com/wildcard/caro.gitcd carocargo build --releaseVerifying Installation
Section titled “Verifying Installation”After installation, verify everything is working:
# Check versioncaro --version# Output: caro 0.1.0
# Test basic functionalitycaro "show current directory"# Output: pwd
# Test with a more complex querycaro "find all markdown files"# Output: find . -name "*.md"First Run
Section titled “First Run”On first run, caro will download the required model (~1.1GB):
$ caro "list files"Downloading model... [====================] 100%Model cached at ~/.cache/caro/models/
find . -type fConfiguration
Section titled “Configuration”caro stores configuration in:
- macOS:
~/Library/Application Support/caro/ - Linux:
~/.config/caro/ - Windows:
%APPDATA%\caro\
Model cache location:
- macOS:
~/Library/Caches/caro/models/ - Linux:
~/.cache/caro/models/ - Windows:
%LOCALAPPDATA%\caro\cache\
Troubleshooting
Section titled “Troubleshooting””command not found: caro”
Section titled “”command not found: caro””Ensure Cargo’s bin directory is in your PATH:
# Add to ~/.bashrc or ~/.zshrcexport PATH="$HOME/.cargo/bin:$PATH"
# Reload shellsource ~/.bashrc # or ~/.zshrcBuild fails with CMake error
Section titled “Build fails with CMake error”Install CMake:
# macOSbrew install cmake
# Ubuntu/Debiansudo apt install cmake
# Fedorasudo dnf install cmakeModel download fails
Section titled “Model download fails”Check your internet connection and try again:
# Clear partial downloadrm -rf ~/.cache/caro/models/
# Retrycaro "test"Next Steps
Section titled “Next Steps”- Quick Start - Learn the basics
- macOS Setup - Enable GPU acceleration
- Configuration - Customize caro