Installation

This guide covers all installation methods for cuenv across different platforms and environments.

System Requirements

Minimum Requirements

• Operating System: Linux, macOS, or Windows (WSL2 recommended)
• Rust: 1.70 or later
• Memory: 4 GB RAM minimum, 8 GB recommended
• Storage: 1 GB free space

Optional Dependencies

• Nix Package Manager: For enhanced package management features
• Docker: For containerized environments
• Git: For version control integration

Installation Methods

Method 1: Using Nix (Recommended)

If you have Nix installed, this is the preferred way to install cuenv:

# Install from flake
nix profile install github:cuenv/cuenv

# Or run directly
nix run github:cuenv/cuenv -- --help

Method 2: Using Homebrew

For macOS and Linux users with Homebrew:

brew install cuenv/cuenv

Method 3: From Crates.io

Note

This method will be available once cuenv reaches stable release.

cargo install cuenv-cli

Method 4: From GitHub Releases

Note

Pre-built binaries will be available once cuenv reaches stable release.

Download pre-built binaries from the releases page.

Method 5: From Source

Build from source for the latest development features:

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

# Build with optimizations
cargo build --release

# Install to cargo bin directory
cargo install --path crates/cuenv-cli

Method 6: Development Environment

For contributors and developers:

# Clone and enter development environment
git clone https://github.com/cuenv/cuenv.git
cd cuenv

# Enter the development shell
nix develop

# Or using direnv (if configured)
direnv allow

Platform-Specific Setup

Linux

Ubuntu/Debian

# Install dependencies
sudo apt update
sudo apt install build-essential pkg-config libssl-dev

# Install Rust if not already installed
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source ~/.cargo/env

# Install cuenv
cargo install cuenv-cli

Fedora/RHEL

# Install dependencies
sudo dnf install gcc pkg-config openssl-devel

# Install Rust if not already installed
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source ~/.cargo/env

# Install cuenv
cargo install cuenv-cli

Arch Linux

# Install dependencies
sudo pacman -S base-devel openssl pkg-config

# Install Rust if not already installed
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source ~/.cargo/env

# Install cuenv
cargo install cuenv-cli

macOS

Using Homebrew

brew install cuenv/cuenv

Manual Installation

# Install Xcode Command Line Tools
xcode-select --install

# Install Rust if not already installed
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source ~/.cargo/env

# Install cuenv
cargo install cuenv-cli

Windows

Windows Subsystem for Linux (Recommended)

# Install WSL2 and Ubuntu
wsl --install -d Ubuntu

# Follow Linux installation steps inside WSL

Native Windows

# Install Visual Studio Build Tools
# Download from: https://visualstudio.microsoft.com/downloads/

# Install Rust
# Download from: https://rustup.rs/

# Install cuenv
cargo install cuenv-cli

Verification

After installation, verify cuenv is working correctly:

# Check version
cuenv version

# Test basic functionality
mkdir test-cuenv
cd test-cuenv
# Create a simple configuration
echo 'package cuenv' > env.cue
echo 'env: {}' >> env.cue
echo 'tasks: {}' >> env.cue

# Verify it loads
cuenv env print

Shell Integration

Bash

Add to ~/.bashrc:

# cuenv shell integration
source <(cuenv shell init bash)

Zsh

Add to ~/.zshrc:

# cuenv shell integration
source <(cuenv shell init zsh)

Fish

Add to ~/.config/fish/config.fish:

# cuenv shell integration
cuenv shell init fish | source

IDE Integration

Note

Official IDE extensions are planned for future releases. The instructions below describe planned functionality and third-party CUE support.

Visual Studio Code

Caution

The cuenv VS Code extension is not yet available. For CUE syntax support, use the CUE language extension.

# For CUE syntax highlighting (available now)
code --install-extension cuelang.cue

IntelliJ/CLion

Caution

The cuenv plugin is not yet available. For CUE support, use the CUE plugin from JetBrains Marketplace.

Vim/Neovim

Add CUE syntax support with vim-cue:

" Add to your vimrc
Plug 'jjo/vim-cue'

Troubleshooting

Common Issues

Command not found

Ensure ~/.cargo/bin is in your PATH:

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

Permission denied

On Linux/macOS, ensure the binary is executable:

chmod +x ~/.cargo/bin/cuenv

Build failures

Update Rust to the latest version:

rustup update

SSL/TLS errors

Update certificates and try again:

# Ubuntu/Debian
sudo apt update && sudo apt install ca-certificates

# macOS
brew install ca-certificates

Getting Help

If you encounter issues:

1. Check the troubleshooting guide
2. Search existing GitHub issues
3. Create a new issue with:
   • Your operating system and version
   • Rust version (rustc --version)
   • Installation method used
   • Complete error message

Next Steps

After installation:

• Follow the Quick Start guide
• Explore configuration options
• Learn about task orchestration
• Set up your first typed environment