The DeployR command line interface.
Note to Windows users that have the Microsoft HPC Pack.
If your environment has the Microsoft HPC Pack, the
node.exe from Node.js can
conflict with the
node.exe from the Microsoft HPC Pack (same name). You can
view the open issue here.
The current solution is to manually reorder the paths in the
variable giving Node.js's path a higher priority after installation.
To get started, you will want to install the DeployR command line interface (CLI) globally. You may need to use sudo for (OSX, *nix, BSD, etc). If you are using Windows, run your command shell as Administrator.
One-line install using npm:
npm install -g deployr-cli
This will put the
di command in your system path allowing it to be run from
DeployR CLI is self documenting and the best way to become familiar with the tool is to try it out from your command line:
di <resource> <action> <param1> <param2> ...
||Displays the 'Main menu' User Interface.|
||Prints out a list of available commands.|
||Prints out the help text associated with the command.|
||Set the DeployR server endpoint.|
||Log into DeployR.|
||Log out of DeployR.|
||Displays the current logged in user to DeployR.|
||Install a pre-built example.|
||Install a pre-built example by example name.|
||Displays DeployR server information based on the set server
||Allow you to edit your local
||Lists all configuration values currently set in the configuration file.|
||Sets the specified pair in the
||Gets the value for the specified in the
||Deletes the specified in the
All commands have corresponding help text associated with it. To read the help
text for a
di command, type:
di help <command>
For example, to display the help text for the
All configuration data for your local DeployR CLI install is located in the .diconf file in your home directory. Directly modifying this file is not advised. You should be able to make all configuration changes from the main menu UI or via:
di config set endpoint # set the DeployR server endpoint
If you need to have multiple configuration files, use --diconf options.
di --diconf /path/to/other/configuration/.diconf
di [commands] [options] --version prints DeployR version and exit --diconf [file] specify file to load configuration from --help prints cli help and exit
Any other shell other than
bash will simply ignore tab completions. The first
time you run
$ di from the command line it will add to your
.bash_profile or .
profile the necessary hooks. Upon sourcing these files,
the next time you run
$ di <TAB> the completions with appear.
$ di lo<TAB>login logout$ di w<TAB>whoami
For advance usage, see our API documentation
Inspired by the nodejitsu CLI and others.
Copyright (C) 2010-2016, Microsoft Corporation
This program is licensed to you under the terms of Version 2.0 of the Apache License. This program is distributed WITHOUT ANY EXPRESS OR IMPLIED WARRANTY, INCLUDING THOSE OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Please refer to the Apache License 2.0 for more details.