Installation

Prerequisites

Before installing similarity-go, make sure you have:

• Go 1.24.5 or later installed on your system
• Access to a terminal or command prompt

Installation Methods

Method 1: Install from Source (Recommended)

Clone the repository and build from source:

# Clone the repository
git clone https://github.com/paveg/similarity-go.git
cd similarity-go

# Build the binary
go build -o bin/similarity-go

# Or use Make commands
make build        # Build current platform
make build-all    # Cross-compile all platforms
make install      # Install to $GOPATH/bin

Method 2: Go Install

Install directly using go install:

go install github.com/paveg/similarity-go@latest

Method 3: Download Pre-built Binaries

Download pre-built binaries from the releases page:

1. Go to the releases page
2. Download the appropriate binary for your OS and architecture
3. Extract the archive
4. Move the binary to a directory in your PATH

Verify Installation

After installation, verify that similarity-go is working correctly:

./bin/similarity-go --version

You should see output similar to:

similarity-go version 1.0.0

Next Steps

Now that you have similarity-go installed, you can:

1. Follow the Quick Start Guide to run your first analysis
2. Learn about CLI Commands for advanced usage
3. Explore Configuration Options to customize behavior

Troubleshooting

Command Not Found

If you get a “command not found” error, make sure:

1. The binary is in a directory that’s in your PATH
2. The binary has execute permissions: chmod +x similarity-go
3. Your Go bin directory is in your PATH: export PATH=$PATH:$(go env GOPATH)/bin

Build Errors

If you encounter build errors when installing from source:

1. Ensure you have Go 1.24.5 or later: go version
2. Update your Go installation if needed
3. Clear your module cache: go clean -modcache
4. Try building again