Installation

Prerequisites

• Rust 1.80 or later (if building from source)
• Git (for cloning repositories)

Install via Script (Recommended)

Install the latest release (Linux/macOS):

curl -fsSL https://docspring.github.io/cigen/install.sh | sh

This installs cigen into ~/.local/bin by default. Use --system for /usr/local/bin or --prefix <dir> for a custom directory. Uninstall with --uninstall.

Install from Source

# Clone the repository
git clone https://github.com/DocSpring/cigen.git
cd cigen

# Build and install
cargo install --path .

Verify Installation

cigen --version

Shell Completion

Generate shell completion scripts:

# Bash
cigen generate-completion bash > ~/.local/share/bash-completion/completions/cigen

# Zsh
cigen generate-completion zsh > ~/.zfunc/_cigen

# Fish
cigen generate-completion fish > ~/.config/fish/completions/cigen.fish

Development Installation

For development work:

git clone https://github.com/DocSpring/cigen.git
cd cigen

# Run directly with cargo
cargo run -- --help

# Or install in development mode
cargo install --path . --debug

Updating

To update to the latest version:

cd cigen
git pull
cargo install --path . --force

Troubleshooting

Build Issues

If you encounter build errors:

1. Ensure you have Rust 1.80+ installed: rustc --version
2. Update Rust: rustup update
3. Clean and rebuild: cargo clean && cargo build

Permission Issues

On Unix systems, ensure ~/.cargo/bin is in your PATH:

echo 'export PATH="$HOME/.cargo/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

Next Steps

• Follow the Quick Start guide
• Learn about cigen’s philosophy
• Explore configuration options