@kobionic/cli

Generic CLI application that dynamically loads modules from specified directory at runtime.

Usage: cli <command> [options]

Commands:
  cli mycommand   Does whatever a command can              [aliases: m, mod]

Options:
  ----commands-dir, -m  Specify directory to load commands from   [string]
  --help, -h           Show help                                 [boolean]
  --version, -v        Show version number                       [boolean]

Install CLI application

The package is published on npm and can be installed by running the following command:

npm install [--global] @kobionic/cli

Usage

Base commands

Basic commands are provided with the CLI application.

Command	Type	Description
completion	boolean	generates bash completion script

Base options

Basic commands are provided with the CLI application.

Option	Alias	RequiresArg	Type	Description
--commands-dir	-m	true	string	sets directory to load commands from
--help	-h		boolean	shows help
--version	-v		boolean	shows version number

Environment variables

Environment variables can be used to configure the application. Be careful as they take precedence over options passed to the CLI application!

Variable	Type	Default	Description
CLI_COMMANDS_DIR	string	<project-root>/cmds	the directory containing commands to be loaded at runtime

Authors

• Jeremie Rodriguez <[e-mail]> - Main developer

License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.