hxe

Installation Guide

This guide covers different ways to install HXE on various platforms.

Prerequisites

• Go 1.23 or higher - Download Go
• Git - For cloning the repository
• Make (optional) - For using build scripts

Installation Methods

1. From Source (Recommended)

Clone the repository and build from source:

# Clone the repository
git clone https://github.com/rangertaha/hxe.git
cd hxe

# Build the project
go build -o bin/hxe ./cmd/hxe

# Install globally (optional)
sudo cp bin/hxe /usr/local/bin/

2. Using GitHub Packages

HXE is available as a Go module from GitHub Packages:

# Configure Go to use GitHub Packages
export GOPRIVATE=github.com/rangertaha/hxe
export GOPROXY=https://proxy.golang.org,direct

# Install HXE
go install github.com/rangertaha/hxe/cmd/hxe@latest

# Or add to your project
go get github.com/rangertaha/hxe/pkg/client

3. Using Make

If you have Make installed, you can use the provided build scripts:

# Clone the repository
git clone https://github.com/rangertaha/hxe.git
cd hxe

# Build backend server
make server

# Build desktop application
make desktop

# Clean build artifacts
make clean

# Install globally
make install

4. Cross-platform Builds

Build HXE for different platforms:

# Linux AMD64
GOOS=linux GOARCH=amd64 go build -o bin/hxe-linux-amd64 ./cmd/hxe

# macOS AMD64
GOOS=darwin GOARCH=amd64 go build -o bin/hxe-darwin-amd64 ./cmd/hxe

# Windows AMD64
GOOS=windows GOARCH=amd64 go build -o bin/hxe-windows-amd64.exe ./cmd/hxe

# Linux ARM64
GOOS=linux GOARCH=arm64 go build -o bin/hxe-linux-arm64 ./cmd/hxe

Platform-Specific Instructions

Linux

Ubuntu/Debian

# Install dependencies
sudo apt update
sudo apt install git golang-go make

# Clone and build
git clone https://github.com/rangertaha/hxe.git
cd hxe
go build -o bin/hxe ./cmd/hxe
sudo cp bin/hxe /usr/local/bin/

CentOS/RHEL/Fedora

# Install dependencies
sudo dnf install git golang make

# Clone and build
git clone https://github.com/rangertaha/hxe.git
cd hxe
go build -o bin/hxe ./cmd/hxe
sudo cp bin/hxe /usr/local/bin/

macOS

Using Homebrew

# Install Go
brew install go

# Clone and build
git clone https://github.com/rangertaha/hxe.git
cd hxe
go build -o bin/hxe ./cmd/hxe
sudo cp bin/hxe /usr/local/bin/

Using MacPorts

# Install Go
sudo port install go

# Clone and build
git clone https://github.com/rangertaha/hxe.git
cd hxe
go build -o bin/hxe ./cmd/hxe
sudo cp bin/hxe /usr/local/bin/

Windows

Using Chocolatey

# Install Go
choco install golang

# Clone and build
git clone https://github.com/rangertaha/hxe.git
cd hxe
go build -o bin/hxe.exe ./cmd/hxe

Using Scoop

# Install Go
scoop install go

# Clone and build
git clone https://github.com/rangertaha/hxe.git
cd hxe
go build -o bin/hxe.exe ./cmd/hxe

Verification

After installation, verify that HXE is working correctly:

# Check version
hxe --version

# Show help
hxe --help

# Test basic functionality
hxe run echo "Hello, HXE!"

Configuration

After installation, create your first configuration:

# Create configuration directory
mkdir -p ~/.config/hxe

# Generate default configuration
hxe --config ~/.config/hxe/config.hcl --daemon

Next Steps

1. Configure HXE
2. Start the daemon
3. Use the client library
4. Explore the CLI

Troubleshooting

Common Issues

Go not found

# Add Go to PATH
export PATH=$PATH:/usr/local/go/bin
# Add to ~/.bashrc or ~/.zshrc for persistence

Permission denied

# Make sure the binary is executable
chmod +x bin/hxe

Build errors

# Clean and rebuild
go clean
go mod tidy
go build -o bin/hxe ./cmd/hxe

Getting Help

• 📧 Email: rangertaha@gmail.com
• 🐛 Issues: GitHub Issues
• 📖 Documentation: GitHub Wiki

This site is open source. Improve this page.