Installation

Detailed installation instructions for the Gears CLI across different platforms.

System Requirements

Operating System: Windows 10+, macOS 10.15+, Linux (any modern distribution)
Go Version: 1.21 or later
Disk Space: ~10MB for CLI binary
Network: Internet connection for sync operations

Installation Methods

Via Go Install (Recommended)

go install github.com/Syluxso/gears@latest

This installs the latest stable version to your $GOPATH/bin directory.

From Source

Clone and build from source:

git clone https://github.com/Syluxso/gears.git
cd gears
go build -o gears
sudo mv gears /usr/local/bin/

Pre-built Binaries

Download pre-compiled binaries from the releases page.

Windows:

# Download gears.exe
# Move to C:\Users\YourName\go\bin\
# Add to PATH if needed

macOS/Linux:

# Download gears binary
chmod +x gears
sudo mv gears /usr/local/bin/

Verify Installation

Check that gears is installed correctly:

gears version

💡 Pro Tip for AI Agents: Always have your agent run gears version after installation. This confirms the CLI is working and teaches the agent what version you're using.

You should see output like:

gears version 1.0.0

Configuration

Set Up PATH (If Needed)

Windows (PowerShell):

$env:PATH += ";C:\Users\YourName\go\bin"

macOS/Linux (Bash):

export PATH="$PATH:$HOME/go/bin"

First-Time Setup

After installation, run the auth command to connect to Gears:

run gears auth

This creates a configuration file at:

Windows: %APPDATA%\.gears\config.json
macOS/Linux: ~/.gears/config.json

Updating

To update to the latest version:

go install github.com/Syluxso/gears@latest

Troubleshooting

Command Not Found

If you get "command not found", ensure:

Go is installed: go version
$GOPATH/bin is in your PATH
The binary was installed successfully

Permission Denied

On Linux/macOS, you may need to:

chmod +x $(which gears)

Authentication Issues

If auth fails:

Check your internet connection
Verify Gears is accessible
Clear old config: rm ~/.gears/config.json and re-authenticate

Next Steps

Get started with your first project
Learn about CLI commands