48c858df0f
- Task 13: Full documentation (README, INSTALLATION, USAGE, ARCHITECTURE) - Task 14: Release prep (CHANGELOG, RELEASE_CHECKLIST) - Update PROJECT_STATE.md to reflect 100% completion
1.8 KiB
1.8 KiB
Installation Guide
Prerequisites
- Go 1.21+ — for building from source
- Git — for cloning the repository
- Make — optional, for build automation
Installation Methods
Method 1: Build from Source
git clone https://git.tukangketik.id/swanadiva/HostKeeper.git
cd hostkeeper
make build
sudo cp bin/hostkeeper /usr/local/bin/
Method 2: Go Install
go install git.tukangketik.id/swanadiva/hostkeeper/cmd/hostkeeper@latest
This installs to $GOPATH/bin or $HOME/go/bin.
Method 3: Cross-Platform Build
./build.sh
Binaries will be in the build/ directory with SHA256 checksums.
Platform-Specific Instructions
macOS
# Install Go via Homebrew
brew install go
# Build and install
git clone https://git.tukangketik.id/swanadiva/HostKeeper.git
cd hostkeeper
make build
cp bin/hostkeeper /usr/local/bin/
Linux (Ubuntu/Debian)
# Install Go
sudo apt update
sudo apt install golang git make
# Build and install
git clone https://git.tukangketik.id/swanadiva/HostKeeper.git
cd hostkeeper
make build
sudo cp bin/hostkeeper /usr/local/bin/
Windows
# Install Go from https://golang.org/dl/
# Clone repository
git clone https://git.tukangketik.id/swanadiva/HostKeeper.git
cd hostkeeper
# Build
go build -o hostkeeper.exe ./cmd/hostkeeper
Termux (Android)
pkg install golang git make
git clone https://git.tukangketik.id/swanadiva/HostKeeper.git
cd hostkeeper
make build
cp bin/hostkeeper $PREFIX/bin/
Verification
hostkeeper version
Expected output:
hostkeeper dev (built: ...)
Troubleshooting
Command Not Found
Ensure the binary is in your PATH:
export PATH=$PATH:/usr/local/bin
Build Failures
make clean
make deps
make build