fish-install's Introduction

fish-install

Unobtrusively install Fish functions into the shell.

No config adjustment required. $fish_function_path is modified instead.

CLI

fish-install [install] $directory

Install $directory as a new Fish search path.

fish-install remove $directory

Remove $directory (all occurrences) from $fish_function_path.

fish-install list

List installed directories.

API

`fishInstall(path, [cb(err)])`

`fishInstall.install(path, [cb(err)])`

path — directory with functions to install.

Note: functions themselves are not copied anywhere, so the directory should better be persistent.

`fishInstall.remove(path, [cb(err)])`

path — directory to remove from $fish_function_path.

`fishInstall.list([cb(err)])`

List installed paths.

Publishing Fish functions to npm

Install fish-install as a dependency.
Put your functions to a separate directory (say functions).
Add the following to package.json:

"scripts": {
  "install": "fish-install functions",
  "uninstall": "fish-install remove functions"
}

Install

As a set-up utility for functions:

npm install fish-install

As a system-wide command line utility:

npm install -g fish-install

License

MIT

fish-install's People

Contributors

Watchers

fish-install's Issues

Install from GitHub

Add tests

Add command for searching npm for fish packages

Incompatible with sudo npm install

If the module is installed in a directory the user has no write access to, $fish_function_path is not updated and Fish prompts this message:

fish: Unable to create a configuration directory for fish. Your personal settings will not be saved. Please set the $XDG_CONFIG_HOME variable to a directory where the current user has write access.
+ /usr/lib/node_modules/fish-cat-highlighted/functions