Wahoo: The Fishshell Framework


About | Install | Usage | Contributing | Documentation

Wahoo is an all-purpose framework and decentralized package manager for the fishshell. It looks after your configuration, themes and plugins. It's light, fast and easy to use.

Requires sudo to install fish and other dependencies.

curl -L git.io/wa | sh
wa help

You don't need to use sudo if you already have fish installed or can use Homebrew, but if you are starting from scratch you need to sudo in order to install fish, its dependencies and modify the system's default shell.

Each command is preceded by wa, e.g, wa help

Update the framework using git.

Updates are not destructive. Unstaged changes are stashed and reapplied after pulling updates from upstream. Similarly, if you have committed changes to the repo they are rebased with master.

Install one or more themes or packages. Discover packages with wa get without arguments or themes with wa themes. If the package is already installed it will be updated to the latest version.

List all packages in the registry. Same as wa get without arguments.

Apply a theme. If the theme is not installed, it will be from the registry. To list all the installed themes type wa use without arguments.

Remove a theme or package. Packages listening to uninstall events will be called before the package is removed from disk to allow custom cleanup of resources, etc. See Documentation.

Current directory must be under git source control and have a remote origin.

Creates a new branch add-<theme/package name> in your local fork of Wahoo and adds a new entry to the local registry under $WAHOO_PATH/db using the $PWD's git remote origin. If you haven't forked Wahoo, this also forks the project on GitHub and updates your local clone remote origin and upstream.

Finally, the GitHub's repository is launched in your preferred browser. You can submit a PR from there.

If you prefer to roll your own, simply add a new file <package name>.pkg or <theme name>.theme with the remote URL into $WAHOO_PATH/db and submit a new PR. See Documentation.

Show Wahoo's help on the terminal.

Display version.

[] git

Fork the repo, clone your own copy and start using Wahoo to handle your fish configuration. If you think something is missing, make a theme or find a bug, consider creating a PR.

Consult the documentation to learn how to create packages.

MIT © Jorge Bucaran et al