Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.shovels.ai/llms.txt

Use this file to discover all available pages before exploring further.

The fastest way to install is the one-line install script. It detects your platform, downloads the correct binary, and verifies the SHA256 checksum. 
curl -LsSf https://shovels.ai/install.sh | sh
The binary installs to ~/.shovels/bin by default.

​
Supported Platforms

OSArchitectureBinary
macOSApple Silicon (arm64)shovels-darwin-arm64
macOSIntel (amd64)shovels-darwin-amd64
Linuxarm64shovels-linux-arm64
Linuxamd64shovels-linux-amd64
Windowsamd64shovels-windows-amd64.exe

​
Install Script Options

The install script supports environment variables for customization:
VariableDescriptionDefault
SHOVELS_VERSIONPin to a specific release versionLatest
SHOVELS_INSTALL_DIRCustom installation directory~/.shovels/bin
Example with custom options: 
SHOVELS_VERSION=0.1.0 SHOVELS_INSTALL_DIR=/usr/local/bin \
  curl -LsSf https://shovels.ai/install.sh | sh

​
Manual Download

Download binaries directly from GitHub Releases. Each release includes SHA256 checksums for verification. 
# Example: download and verify on macOS arm64
curl -LO https://github.com/ShovelsAI/shovels-cli/releases/latest/download/shovels-darwin-arm64
curl -LO https://github.com/ShovelsAI/shovels-cli/releases/latest/download/checksums.txt
sha256sum -c checksums.txt --ignore-missing
chmod +x shovels-darwin-arm64
mv shovels-darwin-arm64 /usr/local/bin/shovels

​
Add to PATH

If the CLI isn’t found after installation, add the install directory to your PATH: 
# Add to ~/.zshrc (macOS) or ~/.bashrc (Linux)
export PATH="$HOME/.shovels/bin:$PATH"
Then reload your shell: 
source ~/.zshrc  # or ~/.bashrc

​
Verify Installation

shovels version
This prints the CLI version, git commit hash, and build date.

​
Updating

Re-run the install script to get the latest version: 
curl -LsSf https://shovels.ai/install.sh | sh
The CLI is a single static binary with no runtime dependencies. Updating simply replaces the binary file.