Ahoy
Create self-documenting cli programs from YAML files. Easily wrap bash, grunt, npm, docker, (anything) to standardize your processes and make the lives of the people working on your project better.
Overview
Ahoy is a command line tool designed to automate and organize workflows by creating a CLI app for each project without any code or dependencies. It simplifies the process by allowing users to write commands in a YAML file, offering features such as command listing, help text per command, tab completion, and the ability to run commands from any subdirectory.
Features
- Non-invasive: Integrates seamlessly into existing workflows by wrapping commands and scripts already in use.
- Consistent: Commands run relative to the .ahoy.yml file but can be executed from any subfolder.
- Visual: Provides a comprehensive list of commands with descriptions for easy reference.
- Flexible: Commands are specific to each folder tree, enabling unique commands for different repos or workspaces.
- Command templates: Allows users to insert arguments into commands using {{args}}.
- Fully interactive: Supports interactive shells like MySQL and prompts while working with commands.
- Self-documenting: Command help and shell completion are automatically generated from .ahoy.yml declarations.
macOS
Using Homebrew: If ahoy is in homebrew-core, run the following command to install:
brew install <ahoy>
Linux
