@reggi/here

npm i @reggi/here -g

Summary

A CLI tool to create an interface for bash shell commands, auto generates a --help list of all available functions, allows for cascading shell function dependency.

Why

Do you have a lot of shell scripts associated with a project? Is npm scripts and package.json overflowing? Do you want an easy way to document all of the bash scripts associated with a project?

How

Create a folder in a directory called scripts.

mkdir ./scripts

Then create a shell command.

touch ./scripts/0500-hello-world.sh

USAGE='--helloWorld (echo hello world)'
function helloWorld () {
  echo 'hello world'
}

Then run here in the directory with the scripts folder.

You should see this:

$ here
Usage: --function <args> [--function <args>]

	--helloWorld (echo hello world)
	--help (shows this help output)

Then you can execute the command using the flag:

$ here --helloWorld
hello world