Initial commit.
All checks were successful
Release / release (push) Successful in 3m13s

This commit is contained in:
Jay
2025-10-25 21:23:20 -04:00
commit 91c61ca4c8
10 changed files with 1406 additions and 0 deletions

117
INSTALL.md Normal file
View File

@@ -0,0 +1,117 @@
# Installing AICLI
This document provides instructions for installing and configuring AICLI on various platforms.
## Pre-built Binaries
The easiest way to install AICLI is to download a pre-built binary from the [releases page](https://git.wisehodl.dev/jay/aicli/releases).
### Platform Selection Guide
Choose the appropriate binary for your platform:
- **Linux (64-bit x86)**: `aicli-linux-amd64`
- **Linux (32-bit x86)**: `aicli-linux-386`
- **Linux (64-bit ARM)**: `aicli-linux-arm64`
- **Linux (ARMv7)**: `aicli-linux-armv7`
- **Linux (ARMv6)**: `aicli-linux-armv6`
- **macOS (Intel)**: `aicli-darwin-amd64`
- **macOS (Apple Silicon)**: `aicli-darwin-arm64`
- **Windows (64-bit)**: `aicli-windows-amd64.exe`
- **Windows (32-bit)**: `aicli-windows-386.exe`
- **FreeBSD (64-bit)**: `aicli-freebsd-amd64`
- **OpenBSD (64-bit)**: `aicli-openbsd-amd64`
- **NetBSD (64-bit)**: `aicli-netbsd-amd64`
- **Solaris (64-bit)**: `aicli-solaris-amd64`
### Linux/macOS Installation
```bash
# Download the appropriate binary (replace with actual version and platform)
curl -LO https://git.wisehodl.dev/jay/aicli/releases/download/v1.0.0/aicli-linux-amd64
# Make executable
chmod +x aicli-linux-amd64
# Move to a directory in your PATH
sudo mv aicli-linux-amd64 /usr/local/bin/aicli
# Verify installation
aicli --version
```
### Windows Installation
1. Download the appropriate EXE file for your system
2. Rename the executable to `aicli.exe` if desired
3. Add the directory to your PATH or move the executable to a directory in your PATH
4. Open Command Prompt or PowerShell and verify the installation:
```
aicli --version
```
## Configuration
### API Key Setup
You'll need an API key to use AICLI. Set it up using one of these methods:
```bash
# Direct method (less secure)
export AICLI_API_KEY="your-api-key"
# File method (more secure)
echo "your-api-key" > ~/.aicli_key
export AICLI_API_KEY_FILE=~/.aicli_key
# Or specify in config file (see below)
```
### Configuration File
Create a configuration file at `~/.aicli.yaml` or use the sample config provided in the release:
```bash
# Download the sample config
curl -LO https://git.wisehodl.dev/jay/aicli/raw/branch/main/sample-config.yml
# Copy to your home directory
cp sample-config.yml ~/.aicli.yaml
# Edit with your preferred editor
nano ~/.aicli.yaml
```
See the README for detailed configuration options.
## Verification
Verify the downloaded files against the provided checksums:
```bash
# Download the checksum file
curl -LO https://git.wisehodl.dev/jay/aicli/releases/download/v1.0.0/SHA256SUMS
# Verify your downloaded binary
sha256sum -c SHA256SUMS --ignore-missing
```
## Building from Source
If you prefer to build from source:
```bash
# Clone the repository
git clone https://git.wisehodl.dev/jay/aicli.git
cd aicli
# Build
go build -o aicli
# Install
sudo mv aicli /usr/local/bin/
```
## Next Steps
See the [README.md](README.md) for usage instructions and examples.