Skip to content

d-strobel/mage-fish-completions

Repository files navigation

Mage

Mage fish completions

Fish shell completions for Magefile targets, enabling easy navigation and execution of Mage tasks with tab completions.

Currently, it completes only the mage targets and target parameters.

About Mage

This project provides completions for Mage, a modern replacement for Make.

Mage is a tool that lets you write your build scripts in Go, making it easier to maintain and more powerful than traditional Makefiles.

Compatibility

This script has been tested with Mage version v1.15.0.

Ensure you are using a compatible version for the best experience.

Usage

General

  • Download the mage.fish file into the Fish completions folder (~/.config/fish/completions).
curl -o ~/.config/fish/completions/mage.fish https://raw.githubusercontent.com/d-strobel/mage-fish-completions/main/mage.fish
  • After downloading the completion script, restart your terminal to activate the completions.
  • Now you can navigate into a directory containing a Magefile, type mage in the terminal, and hit Tab to see the Mage targets with their corresponding descriptions.

Nix

For nix systems we provide a flake.nix that generates a derivation that can later be used with the nix home-manager.

License

This project is licensed under the Apache 2.0 License. See the LICENSE file for more details.

About

Fish shell completions for Magefile targets.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published