@setster/setster-cli
v1.0.0
Published
Setster command line interface
Downloads
2
Readme
Setster Command Line Interface
Setster Command Line Interface to create a new Setster Engage starter kit and also to interact with Setster from the cli
Usage
$ npm install -g @setster/setster-cli
$ setster-cli COMMAND
running command...
$ setster-cli (-v|--version|version)
@setster/setster-cli/1.0.0 darwin-x64 node-v14.18.1
$ setster-cli --help [COMMAND]
USAGE
$ setster-cli COMMAND
...
Commands
setster-cli autocomplete [SHELL]
setster-cli create [PATH]
setster-cli help [COMMAND]
setster-cli remove
setster-cli start
setster-cli autocomplete [SHELL]
display autocomplete installation instructions
USAGE
$ setster-cli autocomplete [SHELL]
ARGUMENTS
SHELL shell type
OPTIONS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
EXAMPLES
$ setster-cli autocomplete
$ setster-cli autocomplete bash
$ setster-cli autocomplete zsh
$ setster-cli autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
setster-cli create [PATH]
Command used to create a new Setster Widget project
USAGE
$ setster-cli create [PATH]
ARGUMENTS
PATH [default: .] The relative path to the folder where you want to create the project
OPTIONS
-h, --help show CLI help
See code: src/commands/create.ts
setster-cli help [COMMAND]
display help for setster-cli
USAGE
$ setster-cli help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
setster-cli remove
Command used to remove an existing Setster Widget project
USAGE
$ setster-cli remove
OPTIONS
-h, --help show CLI help
See code: src/commands/remove.ts
setster-cli start
Command used to start an existing Setster Widget project
USAGE
$ setster-cli start
OPTIONS
-d, --developer Use this flag to start the project in developer mode. This will allow to watch for any file changes
in the project and restart the project when a file changes
-h, --help show CLI help
See code: src/commands/start.ts