Skip to content

installation.md

Latest commit

 

History

History
167 lines (112 loc) · 3.25 KB

installation.md

File metadata and controls

167 lines (112 loc) · 3.25 KB

Installation Guide

This guide covers all methods of installing ASK on your system.

Requirements

  • Operating System: macOS, Linux, or Windows
  • Go (optional): 1.24+ if building from source

macOS (Homebrew)

The easiest way to install ASK on macOS:

brew tap yeasy/ask
brew install ask

To update:

brew upgrade ask

Linux

Download Binary

Download the latest release for your architecture:

# AMD64
curl -LO https://github.com/yeasy/ask/releases/latest/download/ask_linux_amd64.tar.gz
tar xzf ask_linux_amd64.tar.gz
sudo mv ask /usr/local/bin/

# ARM64
curl -LO https://github.com/yeasy/ask/releases/latest/download/ask_linux_arm64.tar.gz
tar xzf ask_linux_arm64.tar.gz
sudo mv ask /usr/local/bin/

Verify Installation

ask version

Windows

Download Binary

  1. Download ask_windows_amd64.zip from Releases
  2. Extract the zip file
  3. Add the directory to your PATH

Using PowerShell

# Download and extract
Invoke-WebRequest -Uri "https://github.com/yeasy/ask/releases/latest/download/ask_windows_amd64.zip" -OutFile "ask.zip"
Expand-Archive -Path "ask.zip" -DestinationPath "C:\tools\ask"

# Add to PATH (run as Administrator)
[Environment]::SetEnvironmentVariable("Path", $env:Path + ";C:\tools\ask", "Machine")

Build from Source

Prerequisites

  • Go: Version 1.24 or higher.
  • Wails: Required for building the desktop application.
  • Node.js: Required for building the frontend components.

1. Build CLI Tool

To build the command-line interface (CLI) tool:

# Clone the repository
git clone https://github.com/yeasy/ask.git
cd ask

# Install dependencies and build
make build

# Move binary to path (macOS/Linux)
sudo mv ask /usr/local/bin/

Or install directly using go install:

go install github.com/yeasy/ask@latest

2. Build Desktop Application

The desktop application is built using Wails.

Step 1: Install Wails

go install github.com/wailsapp/wails/v2/cmd/wails@latest

Step 2: Build App

Run the following command in the project root:

make build-desktop

This will generate the application in the build/bin/ directory.

Platform Specifics

macOS:

  • The output will be build/bin/ask-desktop.app.
  • If you encounter an "unidentified developer" warning, go to System Settings > Privacy & Security and allow the app to run.
  • To build a .dmg (requires create-dmg): 
    wails build -platform darwin/universal

Windows:

  • The output will be build/bin/ask-desktop.exe.
  • Ensure you have the WebView2 runtime installed (standard on Windows 10/11).

Linux:

  • The output will be build/bin/ask-desktop.
  • You may need to install GTK3 and WebKit2GTK development headers: 
    # Debian/Ubuntu
sudo apt install libgtk-3-dev libwebkit2gtk-4.0-dev

# Fedora
sudo dnf install gtk3-devel webkit2gtk3-devel

Verify Installation

After installation, verify ASK is working:

ask version
ask --help

Next Steps

  1. Initialize your first project
  2. Search for skills
  3. Install a skill