Dgctl NPM | npm.io

Digger dgctl CLI

Usage

$ npm install -g dgctl
$ dgctl COMMAND
running command...
$ dgctl (--version)
dgctl/0.0.35 linux-x64 node-v16.16.0
$ dgctl --help [COMMAND]
USAGE
  $ dgctl COMMAND
...

Commands

`dgctl autocomplete [SHELL]`

display autocomplete installation instructions

USAGE
  $ dgctl autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  shell type

FLAGS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

DESCRIPTION
  display autocomplete installation instructions

EXAMPLES
  $ dgctl autocomplete

  $ dgctl autocomplete bash

  $ dgctl autocomplete zsh

  $ dgctl autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

`dgctl block`

Adds a infra block to a Digger infra bundle

USAGE
  $ dgctl block

DESCRIPTION
  Adds a infra block to a Digger infra bundle

See code: dist/commands/block/index.ts

`dgctl block add [NAME]`

Adds a block to the project

USAGE
  $ dgctl block add [NAME] [-t container|mysql|postgres|docdb|redis|imported] [-n <value>] [-i <value>] [-s
    <value>]

ARGUMENTS
  NAME  new name for the block

FLAGS
  -i, --id=<value>       id of the resource to import
  -n, --name=<value>     new name for the block
  -s, --service=<value>  aws service name to search
  -t, --type=<option>    type of block
                         <options: container|mysql|postgres|docdb|redis|imported>

DESCRIPTION
  Adds a block to the project

`dgctl block deploy [NAME]`

Deploy application to AWS

USAGE
  $ dgctl block deploy [NAME] [-c <value>] [-d] [-p <value>] [-n]

FLAGS
  -c, --context=<value>  The code context for block deployment
  -d, --displayOnly      Only display commands, do not run them for block deployment
  -n, --no-input         Skip prompts
  -p, --profile=<value>  AWS profile to use

DESCRIPTION
  Deploy application to AWS

`dgctl block genpipeline [NAME]`

Generate pipeline for your block

USAGE
  $ dgctl block genpipeline [NAME] [-p github|gitlab]

FLAGS
  -p, --provider=<option>  The CI provider
                           <options: github|gitlab>

DESCRIPTION
  Generate pipeline for your block

`dgctl block list`

list all blocks in the project

USAGE
  $ dgctl block list

DESCRIPTION
  list all blocks in the project

EXAMPLES
  $ dgctl block list

`dgctl block logs [NAME]`

Show application logs from AWS

USAGE
  $ dgctl block logs [NAME] [-p <value>] [-f]

FLAGS
  -f, --follow           Follow logs
  -p, --profile=<value>  AWS profile to use

DESCRIPTION
  Show application logs from AWS

`dgctl block pack [NAME]`

Packs an existing dgctl block folder that can be shared

USAGE
  $ dgctl block pack [NAME]

ARGUMENTS
  NAME  name of the block to pack

DESCRIPTION
  Packs an existing dgctl block folder that can be shared

`dgctl block register [NAME]`

Registers an existing dgctl block folder as a block to the project by adding it to dgctl.json

USAGE
  $ dgctl block register [NAME] [-t container|mysql|postgres|docdb|redis|imported]

ARGUMENTS
  NAME  new name for the block

FLAGS
  -t, --type=<option>  type of block
                       <options: container|mysql|postgres|docdb|redis|imported>

DESCRIPTION
  Registers an existing dgctl block folder as a block to the project by adding it to dgctl.json

`dgctl block remove [NAME]`

removes a block from the project

USAGE
  $ dgctl block remove [NAME]

DESCRIPTION
  removes a block from the project

`dgctl block rename [NAME]`

rename a block in the project

USAGE
  $ dgctl block rename [NAME] [-n <value>]

FLAGS
  -n, --name=<value>  new name to rename to

DESCRIPTION
  rename a block in the project

EXAMPLES
  $ dgctl block rename

`dgctl block unpack [NAME]`

Unpacks s dgctl block folder and registers it to dgctl.json

USAGE
  $ dgctl block unpack [NAME] [-n <value>] [-u <value>]

ARGUMENTS
  NAME  name of the block to unpack

FLAGS
  -n, --name=<value>  Name of the block preset from dgctl block repository
  -u, --url=<value>   Url path to a json file that contains a packed block configuration

DESCRIPTION
  Unpacks s dgctl block folder and registers it to dgctl.json

`dgctl config NAME`

Allows changing dgctl configuration

USAGE
  $ dgctl config [NAME] [-c]

ARGUMENTS
  NAME  (aws) name for the config to change. Example `dgctl config <name>`

FLAGS
  -c, --create  force creation of a new profile

DESCRIPTION
  Allows changing dgctl configuration

EXAMPLES
  $ dgctl config

See code: dist/commands/config.ts

`dgctl eject`

describe the command here

USAGE
  $ dgctl eject [-f]

FLAGS
  -f, --force

DESCRIPTION
  describe the command here

EXAMPLES
  $ dgctl eject

See code: dist/commands/eject.ts

`dgctl generate`

Generates terraform based on the Digger infra bundle

USAGE
  $ dgctl generate

DESCRIPTION
  Generates terraform based on the Digger infra bundle

See code: dist/commands/generate.ts

`dgctl help [COMMANDS]`

Display help for dgctl.

USAGE
  $ dgctl help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for dgctl.

See code: @oclif/plugin-help

`dgctl infra [ACTION]`

describe the command here

USAGE
  $ dgctl infra [ACTION] [-n <value>] [-f]

FLAGS
  -f, --force
  -n, --name=<value>  name to print

DESCRIPTION
  describe the command here

EXAMPLES
  $ dgctl infra

See code: dist/commands/infra.ts

`dgctl init [NAME]`

Creates a Digger infra bundle project

USAGE
  $ dgctl init [NAME] [-f] [-b] [-t container|mysql|postgres|docdb|redis|imported]

ARGUMENTS
  NAME  name of the block to initialise

FLAGS
  -b, --block
  -f, --force
  -t, --type=<option>  type of block
                       <options: container|mysql|postgres|docdb|redis|imported>

DESCRIPTION
  Creates a Digger infra bundle project

EXAMPLES
  $ dgctl init

See code: dist/commands/init.ts

`dgctl login [KEY]`

USAGE
  $ dgctl login [KEY]

DESCRIPTION
  Login with Digger key

EXAMPLES
  $ dgctl login

See code: dist/commands/login.ts

`dgctl plugins`

List installed plugins.

USAGE
  $ dgctl plugins [--core]

FLAGS
  --core  Show core plugins.

DESCRIPTION
  List installed plugins.

EXAMPLES
  $ dgctl plugins

See code: @oclif/plugin-plugins

`dgctl plugins:install PLUGIN...`

Installs a plugin into the CLI.

USAGE
  $ dgctl plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ dgctl plugins add

EXAMPLES
  $ dgctl plugins:install myplugin 

  $ dgctl plugins:install https://github.com/someuser/someplugin

  $ dgctl plugins:install someuser/someplugin

`dgctl plugins:inspect PLUGIN...`

Displays installation properties of a plugin.

USAGE
  $ dgctl plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] Plugin to inspect.

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

GLOBAL FLAGS
  --json  Format output as json.

DESCRIPTION
  Displays installation properties of a plugin.

EXAMPLES
  $ dgctl plugins:inspect myplugin

`dgctl plugins:install PLUGIN...`

Installs a plugin into the CLI.

USAGE
  $ dgctl plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  Plugin to install.

FLAGS
  -f, --force    Run yarn install with force flag.
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Installs a plugin into the CLI.
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
  the CLI without the need to patch and update the whole CLI.


ALIASES
  $ dgctl plugins add

EXAMPLES
  $ dgctl plugins:install myplugin 

  $ dgctl plugins:install https://github.com/someuser/someplugin

  $ dgctl plugins:install someuser/someplugin

`dgctl plugins:link PLUGIN`

Links a plugin into the CLI for development.

USAGE
  $ dgctl plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Links a plugin into the CLI for development.
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
  command will override the user-installed or core plugin implementation. This is useful for development work.


EXAMPLES
  $ dgctl plugins:link myplugin

`dgctl plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

USAGE
  $ dgctl plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ dgctl plugins unlink
  $ dgctl plugins remove

`dgctl plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

USAGE
  $ dgctl plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ dgctl plugins unlink
  $ dgctl plugins remove

`dgctl plugins:uninstall PLUGIN...`

Removes a plugin from the CLI.

USAGE
  $ dgctl plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Removes a plugin from the CLI.

ALIASES
  $ dgctl plugins unlink
  $ dgctl plugins remove

`dgctl plugins update`

Update installed plugins.

USAGE
  $ dgctl plugins update [-h] [-v]

FLAGS
  -h, --help     Show CLI help.
  -v, --verbose

DESCRIPTION
  Update installed plugins.

`dgctl preset [PRESET]`

Initialise project based on preset

USAGE
  $ dgctl preset [PRESET] [-a] [-p <value>]

FLAGS
  -a, --advanced
  -p, --path=<value>  Full path to a json file that contains dgctl configuration

DESCRIPTION
  Initialise project based on preset

EXAMPLES
  $ dgctl preset

See code: dist/commands/preset.ts

`dgctl provision [FILE]`

describe the command here

USAGE
  $ dgctl provision [FILE] [-s] [-p <value>] [-b <value>]

FLAGS
  -b, --bucket=<value>   S3 bucket name
  -p, --profile=<value>  AWS profile to use
  -s, --s3-state         Store terraform state in s3

DESCRIPTION
  describe the command here

EXAMPLES
  $ dgctl provision

See code: dist/commands/provision.ts

`dgctl secret`

Perform secret management actions

USAGE
  $ dgctl secret

DESCRIPTION
  Perform secret management actions

See code: dist/commands/secret/index.ts

`dgctl secret add [KV]`

describe the command here

USAGE
  $ dgctl secret add [KV] [-b <value>]

FLAGS
  -b, --block=<value>  name of the block

DESCRIPTION
  describe the command here

EXAMPLES
  $ dgctl secret add

`dgctl secret delete [KEY]`

Delete secret

USAGE
  $ dgctl secret delete [KEY] [-b <value>]

FLAGS
  -b, --block=<value>  name of the block

DESCRIPTION
  Delete secret

`dgctl update [CHANNEL]`

update the dgctl CLI

USAGE
  $ dgctl update [CHANNEL] [-a] [-v <value> | -i] [--force]

FLAGS
  -a, --available        Install a specific version.
  -i, --interactive      Interactively select version to install. This is ignored if a channel is provided.
  -v, --version=<value>  Install a specific version.
  --force                Force a re-download of the requested version.

DESCRIPTION
  update the dgctl CLI

EXAMPLES
  Update to the stable channel:

    $ dgctl update stable

  Update to a specific version:

    $ dgctl update --version 1.0.0

  Interactively select version:

    $ dgctl update --interactive

  See available versions:

    $ dgctl update --available

See code: @oclif/plugin-update

`dgctl variable [COMMAND] [KV]`

Manage environment variables for your infrastructure

USAGE
  $ dgctl variable [COMMAND] [KV] [-b <value>]

FLAGS
  -b, --block=<value>  name of the block

DESCRIPTION
  Manage environment variables for your infrastructure

EXAMPLES
  $ dgctl variable

See code: dist/commands/variable.ts

oclif