Skip to main content

System Requirements

  • OS: macOS, Linux, or Windows (WSL2 recommended)
  • Architecture: amd64 or arm64
  • Memory: 256MB minimum, 1GB recommended
  • Disk: 50MB for binary, plus workspace storage

Installation Methods

The fastest way to install klaw:
This script:
  • Detects your OS and architecture
  • Downloads the appropriate binary
  • Installs to /usr/local/bin/klaw
  • Verifies the checksum
You may need to use sudo if /usr/local/bin requires elevated permissions.

Manual Download

Download the appropriate binary for your platform:

Build from Source

Requires Go 1.24 or later:

Verify Installation

Check that klaw is installed correctly:
Expected output:

Initial Configuration

After installation, klaw needs at least one LLM provider configured:

Option 1: Environment Variables

Option 2: Configuration File

Create ~/.klaw/config.toml:
Use environment variable references in config files for security:

Shell Completions

Enable tab completion for your shell:

Uninstallation

Troubleshooting

If you get a permission error when installing:
Or install to a user directory:
Ensure the installation directory is in your PATH:
If macOS prevents running klaw:
Or go to System Preferences → Security & Privacy → Allow.
When building from source, ensure you have Go 1.24+:

Next Steps

Quick Start

Start using klaw immediately

Configuration

Configure providers, channels, and more