Installation
System Requirements
- Operating System: macOS, Linux, or Windows (WSL2)
- Node.js: 16.6 or higher (for some MCP servers)
- Docker: For local testing and builds
Installation Methods
macOS (Homebrew)
The easiest way to install on macOS:
# Add Targetly tap
brew tap Targetly-Labs/tap
# Install Targetly
brew install targetly
# Verify installation
tly --version
Update Targetly:
brew upgrade targetly
Uninstall:
brew uninstall targetly
Linux (Script)
Install using our install script:
curl -fsSL https://targetly.dev/install.sh | sh
The script will:
- Download the latest binary for your architecture
- Install to
/usr/local/bin/tly - Make it executable
Manual Installation:
# AMD64
curl -L https://github.com/Targetly-Labs/Targetly/releases/latest/download/targetly-linux-amd64.tar.gz | tar xz
# ARM64
curl -L https://github.com/Targetly-Labs/Targetly/releases/latest/download/targetly-linux-arm64.tar.gz | tar xz
# Move to PATH
sudo mv tly /usr/local/bin/
sudo chmod +x /usr/local/bin/tly
Go Install
If you have Go installed (1.21+):
go install github.com/Targetly-Labs/Targetly/cli@latest
Make sure $GOPATH/bin is in your PATH:
export PATH=$PATH:$(go env GOPATH)/bin
Windows (WSL2)
Targetly works on Windows via WSL2:
-
Install WSL2:
wsl --install -
Inside WSL2, use the Linux installation method:
curl -fsSL https://targetly.dev/install.sh | sh -
Verify:
tly --version
Verify Installation
After installation, verify Targetly is working:
tly --version
Run help to see available commands:
tly --help
Configuration
Targetly stores configuration in ~/.targetly/config.json:
{
"api_url": "https://api.targetly.dev",
"token": "your-auth-token"
}
warning
Never commit your config.json file to version control. It contains sensitive authentication credentials.
Troubleshooting
Command not found: tly
Ensure the Targetly binary is in your PATH:
which tly
If nothing is returned:
- Restart your terminal
- Check if
/usr/local/binis in your PATH - Re-install with the appropriate method
Permission denied
Make sure the binary is executable:
chmod +x /usr/local/bin/tly
Update not working
For Homebrew:
brew update
brew upgrade targetly
For script installation, re-run the install script:
curl -fsSL https://targetly.dev/install.sh | sh
Next Steps
- Quickstart - Get started with your first deployment
- CLI Reference - Explore all CLI commands