Skip to main content

Installing Kanuni CLI

The Kanuni CLI can be installed on macOS, Linux, and Windows. Choose your preferred installation method below.

System Requirements​

  • Operating System: macOS 10.15+, Linux (Ubuntu 18.04+, CentOS 7+), Windows 10+
  • Memory: Minimum 512MB RAM
  • Storage: 100MB free disk space
  • Network: Internet connection for API calls

Installation Methods​

The easiest way to install Kanuni is through npm:

# Install globally using npm
npm install -g @v-lawyer/kanuni

# Verify installation
kanuni --version

This method works on macOS, Linux, and Windows with Node.js 18+ installed.

Option 2: Quick Install Script (macOS/Linux)​

Use our installation script for automatic platform detection and setup:

curl -fsSL https://v-lawyer.ai/kanuni/install.sh | bash

The script will:

  • Detect your platform automatically
  • Download the appropriate binary
  • Install it to ~/.local/bin
  • Add to PATH if needed

Option 3: Install via Homebrew (macOS/Linux)​

If you have Homebrew installed:

# Add the V-Lawyer tap
brew tap v-lawyer/tap

# Install Kanuni
brew install kanuni

# Verify installation
kanuni --version

Option 4: Download Binary Directly​

Download pre-compiled binaries from GitHub Releases.

macOS (Intel)​

# Download and extract
curl -L https://github.com/v-lawyer/kanuni-cli/releases/latest/download/kanuni-darwin-x64.tar.gz | tar xz

# Move to PATH
sudo mv kanuni /usr/local/bin/

# Verify installation
kanuni --version

macOS (Apple Silicon)​

# Download and extract
curl -L https://github.com/v-lawyer/kanuni-cli/releases/latest/download/kanuni-darwin-arm64.tar.gz | tar xz

# Move to PATH
sudo mv kanuni /usr/local/bin/

# Verify installation
kanuni --version

Linux​

# Download and extract
curl -L https://github.com/v-lawyer/kanuni-cli/releases/latest/download/kanuni-linux-x64.tar.gz | tar xz

# Move to PATH
sudo mv kanuni /usr/local/bin/

# Verify installation
kanuni --version

Windows​

# Download the ZIP file
curl -L https://github.com/v-lawyer/kanuni-cli/releases/latest/download/kanuni-windows-x64.zip -o kanuni.zip

# Extract (or use Windows Explorer)
unzip kanuni.zip

# Add to PATH and verify
kanuni --version

Option 5: Docker​

Run Kanuni in a Docker container:

docker run --rm -it ghcr.io/v-lawyer/kanuni-cli:latest --help

Option 6: Build from Source​

For developers who want to build from source:

# Clone the repository
git clone https://github.com/v-lawyer/kanuni-cli.git
cd kanuni-cli

# Build the project
cargo build --release

# The binary will be in target/release/kanuni
./target/release/kanuni --version

# Optionally, install to PATH
cargo install --path .

Post-Installation Setup​

1. Shell Completions (Optional)​

Generate shell completions for your shell to enable tab completion:

Bash​

kanuni completions bash > ~/.kanuni-completions.bash
echo "source ~/.kanuni-completions.bash" >> ~/.bashrc
source ~/.bashrc

Zsh​

kanuni completions zsh > ~/.kanuni-completions.zsh
echo "source ~/.kanuni-completions.zsh" >> ~/.zshrc
source ~/.zshrc

Fish​

kanuni completions fish > ~/.config/fish/completions/kanuni.fish

PowerShell​

kanuni completions powershell | Out-String | Invoke-Expression

2. Configuration​

Kanuni stores its configuration in:

  • macOS/Linux: ~/.config/kanuni/config.toml
  • Windows: %APPDATA%\kanuni\config.toml

You can initialize the configuration with:

kanuni config show

3. Authentication​

After installation, you'll need to authenticate with V-Lawyer:

kanuni auth login

See the Authentication Guide for details.

Updating Kanuni​

Using npm​

npm update -g @v-lawyer/kanuni

Using Homebrew​

brew upgrade kanuni

Using Install Script​

# Re-run the install script - it will update to the latest version
curl -fsSL https://v-lawyer.ai/kanuni/install.sh | bash

Manual Update​

Follow the same steps as installation, but replace the existing binary.

Uninstallation​

Using npm​

npm uninstall -g @v-lawyer/kanuni

Using Homebrew​

brew uninstall kanuni

Manual Uninstallation​

  1. Remove the binary:

    • macOS/Linux: sudo rm /usr/local/bin/kanuni
    • Windows: Delete kanuni.exe from its location

  2. Remove configuration and data (optional):

    • macOS/Linux: rm -rf ~/.config/kanuni
    • Windows: Delete %APPDATA%\kanuni

Troubleshooting​

Command Not Found​

If you get "command not found" after installation:

  1. Ensure the binary is in your PATH:

    echo $PATH

  2. Add the directory to your PATH if needed:

    export PATH="$PATH:/usr/local/bin"

Permission Denied​

If you get "permission denied" errors:

chmod +x /usr/local/bin/kanuni

SSL Certificate Issues​

If you encounter SSL certificate errors:

# macOS
brew install ca-certificates

# Linux
sudo apt-get install ca-certificates  # Debian/Ubuntu
sudo yum install ca-certificates       # CentOS/RHEL

Next Steps​

Now that you have Kanuni installed, you can:

Getting Help​

If you encounter any issues: