Skip to content

Installation

Install ai-rulez using your preferred package manager.

Package Managers

brew install goldziher/tap/ai-rulez

pnpm add -g ai-rulez

pip install ai-rulez

uv tool install ai-rulez

Go

The module path is github.com/Goldziher/ai-rulez/v5, and the binary is the cmd/ai-rulez package. Install it with the /v5 path (a path without it resolves to an old 1.x build):

go install github.com/Goldziher/ai-rulez/v5/cmd/ai-rulez@latest

This builds a local cgo executable using the native library shipped in the Go module. It needs a C toolchain and the module cache at runtime; use a release package for distribution.

For a statically linked build from a clone, use Task to fetch and verify the pinned native library:

git clone https://github.com/Goldziher/ai-rulez
cd ai-rulez
task build
./bin/ai-rulez version

Run Without Installing

You can also run ai-rulez directly without a permanent installation.

uvx ai-rulez --help

pnpm dlx ai-rulez@latest --help

Enable tab completion for your shell to see all available commands and flags interactively.

Highly Recommended

Setting up shell completion is a one-time step that makes the CLI much faster and easier to use. You'll be able to discover all commands just by pressing the <Tab> key.

Add to ~/.bashrc or ~/.bash_profile:

source <(ai-rulez completion bash)

Add to ~/.zshrc:

source <(ai-rulez completion zsh)

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

ai-rulez completion fish | source

Add to your PowerShell profile:

ai-rulez completion powershell | Out-String | Invoke-Expression

Verify Installation

Check that the installation was successful:

ai-rulez version

Next Steps