@dellasera/plugdo

plugdo

plugdo Stack command line tool

• Usage
• Commands

Usage

$ npm install -g @dellasera/plugdo
$ plugdo COMMAND
running command...
$ plugdo (-v|--version|version)
@dellasera/plugdo/0.2.0 darwin-x64 node-v8.11.3
$ plugdo --help [COMMAND]
USAGE
  $ plugdo COMMAND
...

Commands

• plugdo apply
• plugdo bundle
• plugdo create
• plugdo delete
• plugdo hello
• plugdo help [COMMAND]
• plugdo inspect
• plugdo plan
• plugdo update

plugdo apply

execute the release plan

USAGE
  $ plugdo apply

See code: src/commands/apply.js

plugdo bundle

Bundle import and export a stack configuration

USAGE
  $ plugdo bundle

OPTIONS
  -c, --create=create  name of the stack to be saved
  -l, --load=load      name of the stack to be imported
  -n, --name=name      the name will replace the stack name of the bundle for a new one
  -p, --path=path      directory path of the bundle for creation or import

DESCRIPTION
  Create bundle
  > plugdo bundle --create="stackName" --path="~/desktop/bundles"

  Load bundle
  > plugdo bundle --load="stackName" --path="~/desktop/bundles" --name="newStackName"

See code: src/commands/bundle.js

plugdo create

create stack, server, workspace and db

USAGE
  $ plugdo create

OPTIONS
  -a, --accesskey=accesskey      cloud access key
  -b, --branch=branch            github branch. It define the current code change in the deployment pipeline
  -c, --configs=configs          driver configurations, you can define many separated by comma
  -d, --db=db                    db name (lowercase without white spaces)
  -e, --envpath=envpath          define the file of the env variables required by the workspace
  -f, --path=path                workspace local path

  -g, --github=github            github url including the user and password. Example
                                 https://username:[e-mail]/username/repository.git

  -h, --githubcopy=githubcopy    github url to be copied. Example
                                 https://username:[e-mail]/username/repository.git

  -i, --server=server            server name (lowercase without white spaces)

  -k, --secretkey=secretkey      cloud secret key

  -l, --links=links              name of the workspaces linked by host name in the network

  -m, --description=description  component description

  -o, --os=os                    server OS. "linux" is the default and you can change it to "windows"

  -p, --port=port                port number for inbound access, you can define many separated by comma

  -r, --image=image              docker image name to be used in docker compose file

  -s, --stack=stack              stack name (lowercase without white spaces)

  -t, --type=type                define the workspace type, by default is static

  -u, --domain=domain            domain name of the workspace

  -w, --workspace=workspace      workspace name (lowercase without white spaces)

  -x, --expose=expose            port number exposed of the docker image

DESCRIPTION
  When you create a server, the configs of AWS driver is documented in the following link:
  - https://docs.docker.com/machine/drivers/aws/#options

See code: src/commands/create.js

plugdo delete

delete stack, server, workspace and db

USAGE
  $ plugdo delete

OPTIONS
  -d, --db=db                db name (lowercase without white spaces)
  -f, --force
  -i, --server=server        server name (lowercase without white spaces)
  -n, --none                 change the updated value to false
  -s, --stack=stack          stack name (lowercase without white spaces)
  -w, --workspace=workspace  workspace name (lowercase without white spaces)

See code: src/commands/delete.js

plugdo hello

Describe the command here

USAGE
  $ plugdo hello

OPTIONS
  -n, --name=name  name to print

DESCRIPTION
  ...
  Extra documentation goes here

See code: src/commands/hello.js

plugdo help [COMMAND]

display help for plugdo

USAGE
  $ plugdo help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

plugdo inspect

get the information of the stacks

USAGE
  $ plugdo inspect

OPTIONS
  -i, --server=server        server name (lowercase without white spaces)
  -s, --stack=stack          stack name (lowercase without white spaces)
  -w, --workspace=workspace  workspace name (lowercase without white spaces)

See code: src/commands/inspect.js

plugdo plan

create the release plan

USAGE
  $ plugdo plan

OPTIONS
  -j, --json
  -s, --show

See code: src/commands/plan.js

plugdo update

update stack, server, workspace and db

USAGE
  $ plugdo update

OPTIONS
  -a, --accesskey=accesskey      cloud access key
  -b, --branch=branch            github branch. It define the current code change in the deployment pipeline
  -b, --image=image              docker image name to be used in docker compose file
  -c, --configs=configs          driver configurations, you can define many separated by comma
  -d, --db=db                    db name (lowercase without white spaces)
  -d, --description=description  component description
  -e, --envpath=envpath          define the file of the env variables required by the workspace
  -f, --path=path                workspace local path

  -g, --github=github            github url including the user and password. Example
                                 https://username:[e-mail]/username/repository.git

  -h, --githubcopy=githubcopy    github url to be copied. Example
                                 https://username:[e-mail]/username/repository.git

  -i, --server=server            server name (lowercase without white spaces)

  -k, --secretkey=secretkey      cloud secret key

  -l, --links=links              name of the workspaces linked by host name in the network

  -n, --none                     change the updated value to false

  -o, --os=os                    server OS. "linux" is the default and you can change it to "windows"

  -p, --port=port                port number for inbound access, you can define many separated by comma

  -s, --stack=stack              stack name (lowercase without white spaces)

  -t, --type=type                define the workspace type, by default is static

  -u, --domain=domain            domain name of the workspace

  -w, --workspace=workspace      workspace name (lowercase without white spaces)

  -x, --expose=expose            port number exposed of the docker image

DESCRIPTION
  When you update a server, the configs of AWS driver is documented in the following link:
  - https://docs.docker.com/machine/drivers/aws/#options

See code: src/commands/update.js