Skip to content

Installation

This page covers various methods to install uptool on your system.

Prerequisites

  • Go 1.25+ (if installing from source)
  • Git (for version control)
  • Internet connection (for downloading binaries or building from source)

Installation Methods

The easiest way to get started with uptool is using Docker. This method requires no local installation and works across all platforms.

# Pull the latest stable image
docker pull ghcr.io/santosr2/uptool:latest

# Run uptool directly
docker run --rm -v "$PWD:/workspace" ghcr.io/santosr2/uptool version

# Create an alias for convenience
echo 'alias uptool="docker run --rm -v \"\$PWD:/workspace\" ghcr.io/santosr2/uptool"' >> ~/.bashrc
source ~/.bashrc

# Now you can use uptool as a regular command
uptool scan

Docker Image Tags

  • latest - Latest stable release
  • v1.0.0 - Specific version (immutable)
  • v1 - Latest v1.x.x release (mutable)
  • v1.0 - Latest v1.0.x patch (mutable)
  • v1.0.0-rc1 - Pre-release versions

Multi-platform Support

The Docker image supports both linux/amd64 and linux/arm64 architectures automatically.

Method 2: Go Install (For Go users)

If you have Go 1.25+ installed:

go install github.com/santosr2/uptool/cmd/uptool@latest

This will install the latest version of uptool to your $GOPATH/bin directory.

Add to PATH

Ensure $GOPATH/bin is in your $PATH: 

export PATH="$PATH:$(go env GOPATH)/bin"

Method 3: Pre-built Binaries

Download pre-compiled binaries from the GitHub Releases page.

curl -LO https://github.com/santosr2/uptool/releases/latest/download/uptool-linux-amd64
chmod +x uptool-linux-amd64
sudo mv uptool-linux-amd64 /usr/local/bin/uptool

curl -LO https://github.com/santosr2/uptool/releases/latest/download/uptool-linux-arm64
chmod +x uptool-linux-arm64
sudo mv uptool-linux-arm64 /usr/local/bin/uptool

curl -LO https://github.com/santosr2/uptool/releases/latest/download/uptool-darwin-arm64
chmod +x uptool-darwin-arm64
sudo mv uptool-darwin-arm64 /usr/local/bin/uptool

curl -LO https://github.com/santosr2/uptool/releases/latest/download/uptool-darwin-amd64
chmod +x uptool-darwin-amd64
sudo mv uptool-darwin-amd64 /usr/local/bin/uptool

# Download from GitHub Releases
Invoke-WebRequest -Uri https://github.com/santosr2/uptool/releases/latest/download/uptool-windows-amd64.exe -OutFile uptool.exe

# Move to a directory in your PATH
Move-Item uptool.exe C:\Windows\System32\uptool.exe

Method 3: Build from Source

Clone the repository and build from source:

# Clone the repository
git clone https://github.com/santosr2/uptool.git
cd uptool

# Build the binary
mise run build

# Install to $GOPATH/bin
mise run install

# Or manually copy the binary
sudo cp dist/uptool /usr/local/bin/

Method 4: Using mise (Development Environment)

If you use mise for managing development tools:

# Add to your mise.toml
echo 'uptool = "latest"' >> mise.toml

# Install
mise install

Verification

Verify the installation by checking the version:

uptool version

Expected output:

uptool version 0.1.0

Configuration

After installation, you may want to configure uptool for your project. See the Configuration Guide for details.

Updating uptool

Docker

Docker images are always up-to-date when you pull:

# Pull the latest stable release
docker pull ghcr.io/santosr2/uptool:latest

# Or pull a specific version
docker pull ghcr.io/santosr2/uptool:v1.0.0

Go Install

go install github.com/santosr2/uptool/cmd/uptool@latest

Pre-built Binaries

Download the latest release and replace your existing binary.

From Source

cd uptool
git pull origin main
mise run build
sudo cp dist/uptool /usr/local/bin/

Uninstallation

Go Install

rm $(which uptool)

Manual Installation

sudo rm /usr/local/bin/uptool

Next Steps