https://github.com/d-strobel/mage-fish-completions

Fish shell completions for Magefile targets.
https://github.com/d-strobel/mage-fish-completions

fish fish-shell mage magefile shell-completion

Last synced: 4 months ago
JSON representation

Fish shell completions for Magefile targets.

• Host: GitHub
• URL: https://github.com/d-strobel/mage-fish-completions
• Owner: d-strobel
• License: apache-2.0
• Created: 2024-06-09T22:00:11.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2025-05-20T19:29:22.000Z (about 1 year ago)
• Last Synced: 2025-05-20T21:12:20.578Z (about 1 year ago)
• Topics: fish, fish-shell, mage, magefile, shell-completion
• Language: Shell
• Homepage:
• Size: 26.4 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![Mage](https://img.shields.io/badge/Mage-v1.15.0-blue)

# 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](https://github.com/magefile/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](https://github.com/magefile/mage/releases/tag/v1.15.0).

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

## Usage

### General

* Download the [mage.fish](mage.fish) file into the Fish completions folder (`~/.config/fish/completions`).

```bash

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](LICENSE) file for more details.