Skip to main content
Clanker can be installed via Homebrew (recommended) or built from source. Follow the instructions below for your preferred method. The easiest way to install Clanker is through Homebrew:
1

Add the Clanker tap

brew tap clankercloud/tap
2

Install Clanker

brew install clanker
3

Verify installation

clanker --help
You should see the Clanker help output with available commands.

​
Install from source

If you prefer to build from source or want to contribute to development:
1

Clone the repository

git clone https://github.com/bgdnvk/clanker.git
cd clanker
2

Install using Make

make install
This will build the binary and install it to your system.
3

Verify installation

clanker --help

​
Requirements

​
Go (for source installation)

If installing from source, you need Go installed on your system: 
brew install go

​
AWS CLI v2

For AWS functionality, install the AWS CLI v2 (recommended over v1): 
brew install awscli
AWS CLI v1 breaks the --no-cli-pager flag. Use AWS CLI v2 for the best experience.

​
kubectl (for Kubernetes)

For Kubernetes features, install kubectl: 
brew install kubectl

​
Other cloud CLIs (optional)

Depending on which cloud providers you use: 
# Install gcloud CLI
brew install google-cloud-sdk

​
Verify your installation

After installation, verify that Clanker is working correctly:
1

Check version

clanker --help
This should display the help menu with all available commands.
2

Test basic functionality

If you have an OpenAI API key, try a simple query:
export OPENAI_API_KEY="your-key-here"
clanker ask "hello, are you working?"

​
Update Clanker

​
Homebrew

To update Clanker when installed via Homebrew: 
brew update
brew upgrade clanker

​
From source

To update when installed from source: 
cd clanker
git pull
make install

​
Uninstall

​
Homebrew

brew uninstall clanker
brew untap clankercloud/tap

​
From source

Remove the binary from your system (location depends on your make install configuration): 
which clanker  # Find the binary location
rm $(which clanker)  # Remove it

​
Platform support

Clanker has only been tested on macOS. Linux and Windows support may work but are not officially tested.
If you encounter issues on other platforms, please open an issue on GitHub.

​
Next steps

Configuration

Set up your AI providers and cloud credentials

Quick start

Run your first query and explore Clanker’s features

Build docs developers (and LLMs) love

Get started for freeTalk to us