The DeployR command line interface, a tool for running useful DeployR utilities.
Members
(static) name
Expose the CLI name di.
Properties:
| Name | Type | Description |
|---|---|---|
name |
String | The CLI name. |
Methods
(static) clearScreen()
Clears stdout and bring the cursor to postion 0.
(static) exec(command, callback)
Runs the specified command in the di CLI.
Parameters:
| Name | Type | Description |
|---|---|---|
command |
String | Command to execute |
callback |
function | Continuation to pass control to when complete. |
(static) exit()
Ends the di process with the a common exit message.
(static) findHelp()
Prompts user with a few helpful resources, then opens it in their browser.
(static) goto()
Menu selection to run commands.
(static) home()
Display the home di screen with the intial set of options.
(static) settings()
Prompts user with setting options.
(static) setup(callback)
Sets up the instances of the Resource clients for di. there is no io here, yet this function is ASYNC.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
function | continuation to pass control to when complete. |
(static) showError(command, err, shallow)
Displays the err to the user for the command supplied.
Parameters:
| Name | Type | Description |
|---|---|---|
command |
String | Command which has errored. |
err |
Error | Error received for the command. |
shallow |
Boolean | Indicate if a deep stack should be displayed |
(static) start(callback)
Starts the di CLI and runs the specified command.
Parameters:
| Name | Type | Description |
|---|---|---|
callback |
function | Continuation to pass control to when complete. |