From 7648c0b37409989449465564b7581fd1af5ff9d8 Mon Sep 17 00:00:00 2001 From: Lakshman Patel Date: Wed, 5 Aug 2026 12:10:22 +0530 Subject: [PATCH] feat(release): add Homebrew tap publish + README 60s install paths Add brews section so goreleaser publishes graycodeai/tap/hawk on each tagged release (brews is current in v2.17.0 pinned by release CI), and document the three install paths (script, brew, npm) in the README. Requires: create the GrayCodeAI/homebrew-tap repository with an empty Formula/ dir before the next release. --- .goreleaser.yml | 19 +++++++++++++++++++ README.md | 24 ++++++++++++++++++++++++ 2 files changed, 43 insertions(+) diff --git a/.goreleaser.yml b/.goreleaser.yml index 61861367..6e4681ab 100644 --- a/.goreleaser.yml +++ b/.goreleaser.yml @@ -119,6 +119,25 @@ changelog: - title: "Other" order: 999 +# --------------------------------------------------------------------------- +# Homebrew — publishes a formula to GrayCodeAI/homebrew-tap so users can +# `brew install graycodeai/tap/hawk`. Requires HOMEBREW_TAP_TOKEN or +# TAP_GITHUB_TOKEN in the release workflow (both already wired there). +# --------------------------------------------------------------------------- +brews: + - repository: + owner: GrayCodeAI + name: homebrew-tap + token: "{{ .Env.HOMEBREW_TAP_TOKEN }}" + directory: Formula + homepage: "https://github.com/GrayCodeAI/hawk" + description: "AI coding agent — reads, writes, and runs code in your terminal" + license: "MIT" + install: | + bin.install "hawk" + test: | + system "#{bin}/hawk", "--version" + # --------------------------------------------------------------------------- # Release — auto-detect prereleases (rc/beta tags). Created on the repo # itself (not a separate release repo). diff --git a/README.md b/README.md index d731f2fe..2ee9ea31 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,30 @@ hawk is an AI-powered coding agent that lives in your terminal. It reads your co Follow [GrayCode](https://github.com/GrayCodeAI) for progress. When Hawk is ready to try, we will announce it on [graycodeai.com](https://graycodeai.com/changelog). +## Install (60 seconds) + +Pick one — all install the same `hawk` binary (versioned into `~/.hawk/bin`, symlinked as `hawk`): + +```bash +# 1. Script (any shell, verifies checksum; cosign signature when available) +curl -fsSL https://raw.githubusercontent.com/GrayCodeAI/hawk/main/install.sh | sh + +# 2. Homebrew (macOS / Linuxbrew) — after the next tagged release +brew install graycodeai/tap/hawk + +# 3. npm (wraps the same release binaries) +npm install -g @graycodeai/hawk +``` + +If `~/.hawk/bin` is not on your `PATH`, add it to your shell profile. + +Then: + +```bash +hawk # interactive REPL (/config on first run: API key + model) +hawk path # verify readiness +``` + ## Quick Start (contributors — from source) ```bash