# Install ahoy with Homebrew, Nix, scoop, winget Creates self documenting CLI programs from commands in YAML files. Version 2.5.0 via Homebrew; verified 2026-06-15. ## Install ```sh sudo av install brew:ahoy ``` Additional install commands: ### macOS - Homebrew (100%): ```sh brew install ahoy ``` Evidence: local Homebrew formula metadata ### Linux - Nix (92%): ```sh nix profile install nixpkgs#ahoy ``` Evidence: nixpkgs package indexes: pkgs/by-name/ah/ahoy/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1 ### Windows - Scoop (92%): ```sh scoop install main/ahoy ``` Evidence: Scoop official bucket manifest trees: bucket/ahoy.json from https://api.github.com/repos/ScoopInstaller/Main/git/trees/master?recursive=1 - winget (92%): ```sh winget install --id Ahoy.Ahoy -e ``` Evidence: Windows Package Manager source index: Ahoy.Ahoy from https://cdn.winget.microsoft.com/cache/source.msix ## Package facts - **Package key:** brew:ahoy - **Package manager:** Homebrew - **Package manager page:** - **Version:** 2.5.0 - **Source summary:** Creates self documenting CLI programs from commands in YAML files - **Homepage:** - **Repository:** - **Upstream docs:** - **License:** MIT - **Source archive:** - **Last updated:** 2026-06-15T18:07:14+10:00 - **Generated:** 2026-07-08T07:18:31+00:00 ## Executables - ahoy (cli) - ahoy (alias) ## Build dependencies - go ## Install behavior - Post-install hook: not defined - Bottle: available on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, arm64_ventura, sonoma, ventura, x86_64_linux ## Freshness - Page generated: 2026-07-08 - Package-manager version: 2.5.0 - Package-manager updated: 2026-06-15 - Local data: ok - Upstream repository: https://github.com/ahoy-cli/ahoy - Upstream latest detected: v2.5.0 (current) ## Project history and usage Ahoy is a project-local task runner that turns commands written in a YAML file into a self-documenting CLI. Its purpose is to let each repository expose its own small command surface without requiring contributors to learn a bespoke shell script layout or install a language-specific task runner. ### Project history The GitHub repository was created in October 2015, and the earliest listed GitHub release is 1.0.0 from the next day. The older Read the Docs site documents the original framing: a zero-code, dependency-free way to give projects their own CLI, particularly for running interactive commands inside Docker containers. The current README keeps the same core idea while expanding the implementation details: commands live in .ahoy.yml, run relative to that file, can be invoked from subdirectories, and can import multiple config files. The project later moved under the ahoy-cli organization and added newer command-alias, environment-file, and completion features. ### Adoption history Ahoy's adoption is strongest in teams that want Makefile-like ergonomics but richer command help and project-local behavior. The README's Docker and database examples reflect its origin in development-environment workflows, especially wrapping docker-compose, shell, database, test, and deployment commands. The supplied package facts list Homebrew, Nix, Scoop, and winget packages, showing that Ahoy crossed from a macOS/Linux developer convenience into cross-platform package-manager distribution. ### How it is used A project adds a .ahoy.yml file declaring commands, descriptions, aliases, imports, environment files, and an entrypoint. Running ahoy lists commands and per-command help; running ahoy executes the configured shell command relative to the config file. Official examples include replacing long docker exec invocations with short project commands, initializing an example .ahoy.yml, and using environment files for global or command-specific variables. ### Why package nerds care Ahoy sits in the small but beloved category of developer workflow shims: lighter than a build system, more discoverable than a pile of shell scripts, and easy to package as a single CLI binary. For package maintainers, its value is that the runtime surface is simple while the user-facing workflow can standardize a repository's command vocabulary. ### Timeline - 2015: GitHub repository created and release 1.0.0 published. - 2015: Release 1.1.0 published and documented by the older Read the Docs site. - 2016-2017: Version 2 alpha and beta releases appeared. - 2026: Official repository metadata shows continued activity under ahoy-cli/ahoy. ### Related projects - Ahoy overlaps with Make, npm scripts, just, Task, and docker-compose wrapper scripts, but focuses on project-specific command discovery and help. - The README points to ahoy-cli/zsh-ahoy for dedicated Zsh completion support. ### Sources - - - - - source_facts.package-manager ## Security Notes narrow executable package without higher-risk signals. - **Geiger risk:** green / low - narrow executable package without higher-risk signals ## Configuration and credential file locations These source-backed paths show where this package keeps local settings or durable credentials. Automic Vault can use them as review targets for secret scanning, migration, and command approval. ## Configuration files - Unix: .ahoy.yml ## Source Database Details - **Source Database:** Homebrew formula API - **Tap:** homebrew/core - **Full Name:** ahoy - **Version Scheme:** 0 - **Revision:** 0 - **Head Version:** HEAD - **Bottle Stable Root URL:** - **Deprecated:** no - **Disabled:** no - **Keg Only:** no - **URL Keys:** head, stable ## Other Package-Manager Records - Nix - ahoy: normalized package name match | nixpkgs package indexes: pkgs/by-name/ah/ahoy/package.nix from https://api.github.com/repos/NixOS/nixpkgs/git/trees/master?recursive=1 - Scoop - main/ahoy: normalized package name match | Scoop official bucket manifest trees: bucket/ahoy.json from https://api.github.com/repos/ScoopInstaller/Main/git/trees/master?recursive=1 - winget - Ahoy.Ahoy: normalized package name match | Windows Package Manager source index: Ahoy.Ahoy from https://cdn.winget.microsoft.com/cache/source.msix ## Related links - [Source-control packages](https://www.automicvault.com/pkg/source-control-tools/) - Belongs to a source-control command family. - [Terminal utility packages](https://www.automicvault.com/pkg/terminal-utilities/) - Matched terminal and command-line workflow metadata. - [Text processing packages](https://www.automicvault.com/pkg/text-processing-tools/) - Matched text, document, or structured-data processing metadata. - [Developer build packages](https://www.automicvault.com/pkg/developer-build-tools/) - Matched build, compiler, generator, or developer workflow metadata. - [go](https://www.automicvault.com/pkg/brew/go/) - Build dependency declared by Homebrew. - [run](https://www.automicvault.com/pkg/brew/run/) - Shares av.db curated category or tags: automation, cli, developer-tools, task-runner. - [clive](https://www.automicvault.com/pkg/brew/clive/) - Shares av.db curated category or tags: automation, cli, developer-tools. - [cmdshelf](https://www.automicvault.com/pkg/brew/cmdshelf/) - Shares av.db curated category or tags: automation, cli, developer-tools. - [docker-gen](https://www.automicvault.com/pkg/brew/docker-gen/) - Shares av.db curated category or tags: automation, cli, developer-tools. - [empty](https://www.automicvault.com/pkg/brew/empty/) - Shares av.db curated category or tags: automation, cli, developer-tools. - [entr](https://www.automicvault.com/pkg/brew/entr/) - Shares av.db curated category or tags: automation, cli, developer-tools. - [expect](https://www.automicvault.com/pkg/brew/expect/) - Shares av.db curated category or tags: automation, cli, developer-tools. - [gaze](https://www.automicvault.com/pkg/brew/gaze/) - Shares av.db curated category or tags: automation, cli, developer-tools. - [wgo](https://www.automicvault.com/pkg/brew/wgo/) - Local package facts share a topical domain. Shared terms: automation, cli, commands, developer, developer-tools. ## Combined YAML source View the package source record on GitHub. [combined/ahoy.yml](https://github.com/automic-vault/db/blob/main/combined/ahoy.yml) ## Sources - Nucleus package database - Geiger risk classifier - package-page enrichment - curated configuration and credential file locations - curated package history - package version freshness - av.db category and tag curation - package relationship graph - external package-manager database matches - cross-ecosystem install command graph