Installation

Installation

📋 Prerequisites

Requirement	Version	Notes
Go	1.22+	Required for building from source
Namecheap API	-	API credentials needed
Public IP	-	Must be whitelisted in Namecheap

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/namecheap.git
cd namecheap

Step 2: Build Binary

# Using Make (recommended)
make build

# Or build directly
go build -o namecheap-dns ./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:

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

3. Add to PATH:

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

---

✅ Verify Installation

Run the version command to verify installation:

namecheap-dns --version

Expected output:

namecheap-dns version 0.1.0

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

---

🎯 Next Steps

After installation, proceed to:

1. Configuration Guide - Set up your Namecheap accounts
2. Usage Guide - Learn how to use the tool

---

🔧 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.