Commands
Below is a list of commands available with the DD Components CLI:
Any of these commands can be written short-hand by replacing ddcomponents with ddcomp.
Overview
whoami
Prints the email-address you are currently authenticated with to your terminal instance.
$ ddcomponents whoami
--help
Prints the list of ddcomponents commands you have access to to your terminal instance.
$ ddcomponents --help
--version
Prints ddcomponents version you are currently on in your terminal instance.
$ ddcomponents --version
If you are behind the current version you can run:
npm update -g @sportsdigita/ddcomponents-cli
setenv
Allows the user to set which enviornment they want to authenticate/publish with.
$ ddcomponents setenv [--env]
flags
| Flag | Description |
|---|---|
| env | sets the environment. dev, staging, or prod |
login
Allows the user to authenticate to the enviornment they are pointed to. This will ask you for your Digideck email and password.
$ ddcomponents login
setorg
Allows the user to select which organization they are developing components for. You will be able to selected any organization you have authorization with.
SD Admins will be forced to enter an organization ID.
$ ddcomponents setorg [--orgid]
flags
| Flag | Description |
|---|---|
| orgid | organizationId string you wish to set your org to |
init
Creates and installs all files and dependencies for developing components in the directory you are in. This will give you a starting point/skeleton to begin quickly developing.
$ ddcomponents init [--nodeName --title --desc --description]
flags
| Flag | Description |
|---|---|
| title | Component title |
| nodeName | Component Node Name <node-name></node-name> must be unique |
| desc or description | component description |
publish
See Publishing
$ ddcomponents publish [-y]
flags
| Flag | Description |
|---|---|
| y | add -y flag to skip the are you sure prompt |
install
Install the necessary files for development and install the SSL self signed certificate for serving localhost over https
$ ddcomponents install
serve
Serves a local component for development within the DIGIDECK Test Harness.
See Using The DIGIDECK Test Harness
$ ddcomponents serve