Installation

Installation

Prerequisites

Requirement	Version	Notes
Go	1.22+	Required for building from source
DNS Provider API	-	API credentials for your DNS provider (Namecheap, Cloudflare, etc.)
Public IP	-	Must be whitelisted (for Namecheap provider)

Note: For API setup instructions, see Configuration Guide.

---

Installation Methods

Option 1: Build from Source ⭐ Recommended

Click to expand installation steps

Step 1: Clone Repository

git clone https://github.com/SamyRai/zonekit.git
cd zonekit

Step 2: Build Binary

# Using Make (recommended)
make build

# Or build directly
go build -o zonekit ./main.go

Step 3: Install to System (Optional)

make install

This installs to $GOPATH/bin or $GOBIN.

Option 2: Download Pre-built Binaries

Click to expand download instructions

1. Download the latest release from: Releases

2. Extract the archive for your platform:

   • zonekit-linux-amd64 (Linux)
   • zonekit-darwin-amd64 (macOS Intel)
   • zonekit-darwin-arm64 (macOS Apple Silicon)
   • zonekit-windows-amd64.exe (Windows)

3. Add to PATH:

   # Linux/macOS
   chmod +x zonekit
   sudo mv zonekit /usr/local/bin/
   
   # Windows
   # Add the directory containing zonekit.exe to your PATH

---

Verify Installation

Run the version command to verify installation:

zonekit --version

Expected output:

zonekit version 0.1.0

Success! If you see the version, installation is complete.

---

Development Setup

For contributors, additional setup is required:

# Install development tools
make dev-setup

# Run tests
make test

# Run linter
make lint

See Contributing Guide for more details.