npm install dgctlDigger dgctl CLI
=================
sh-session
$ 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)
* dgctl block
* [](#dgctl-block-add-name)
* [dgctl block deploy [NAME]](#dgctl-block-deploy-name)
* [dgctl block genpipeline [NAME]](#dgctl-block-genpipeline-name)
* dgctl block list
* [](#dgctl-block-logs-name)
* [dgctl block pack [NAME]](#dgctl-block-pack-name)
* [dgctl block register [NAME]](#dgctl-block-register-name)
* [dgctl block remove [NAME]](#dgctl-block-remove-name)
* [dgctl block rename [NAME]](#dgctl-block-rename-name)
* [dgctl block unpack [NAME]](#dgctl-block-unpack-name)
* dgctl config NAME
*
*
* [](#dgctl-help-commands)
* [dgctl infra [ACTION]](#dgctl-infra-action)
* [dgctl init [NAME]](#dgctl-init-name)
* [dgctl login [KEY]](#dgctl-login-key)
* dgctl plugins
*
*
*
*
*
*
*
*
* [](#dgctl-preset-preset)
* [dgctl provision [FILE]](#dgctl-provision-file)
* dgctl secret
* [](#dgctl-secret-add-kv)
* [dgctl secret delete [KEY]](#dgctl-secret-delete-key)
* [dgctl update [CHANNEL]](#dgctl-update-channel)
* [dgctl variable [COMMAND] [KV]](#dgctl-variable-command-kv)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_
Adds a infra block to a Digger infra bundle
USAGE
$ dgctl blockDESCRIPTION
Adds a infra block to a Digger infra bundle
_See code: dist/commands/block/index.ts_
Adds a block to the project
USAGE
$ dgctl block add [NAME] [-t container|mysql|postgres|docdb|redis|imported] [-n ] [-i ] [-s
]ARGUMENTS
NAME new name for the block
FLAGS
-i, --id= id of the resource to import
-n, --name= new name for the block
-s, --service= aws service name to search
-t, --type=
DESCRIPTION
Adds a block to the project
Deploy application to AWS
USAGE
$ dgctl block deploy [NAME] [-c ] [-d] [-p ] [-n]FLAGS
-c, --context= 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= AWS profile to use
DESCRIPTION
Deploy application to AWS
Generate pipeline for your block
USAGE
$ dgctl block genpipeline [NAME] [-p github|gitlab]FLAGS
-p, --provider=
DESCRIPTION
Generate pipeline for your block
list all blocks in the project
USAGE
$ dgctl block listDESCRIPTION
list all blocks in the project
EXAMPLES
$ dgctl block list
Show application logs from AWS
USAGE
$ dgctl block logs [NAME] [-p ] [-f]FLAGS
-f, --follow Follow logs
-p, --profile= AWS profile to use
DESCRIPTION
Show application logs from AWS
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
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=
DESCRIPTION
Registers an existing dgctl block folder as a block to the project by adding it to dgctl.json
removes a block from the project
USAGE
$ dgctl block remove [NAME]DESCRIPTION
removes a block from the project
rename a block in the project
USAGE
$ dgctl block rename [NAME] [-n ]FLAGS
-n, --name= new name to rename to
DESCRIPTION
rename a block in the project
EXAMPLES
$ dgctl block rename
Unpacks s dgctl block folder and registers it to dgctl.json
USAGE
$ dgctl block unpack [NAME] [-n ] [-u ]ARGUMENTS
NAME name of the block to unpack
FLAGS
-n, --name= Name of the block preset from dgctl block repository
-u, --url= Url path to a json file that contains a packed block configuration
DESCRIPTION
Unpacks s dgctl block folder and registers it to dgctl.json
Allows changing dgctl configuration
USAGE
$ dgctl config [NAME] [-c]ARGUMENTS
NAME (aws) name for the config to change. Example
FLAGS
-c, --create force creation of a new profile
DESCRIPTION
Allows changing dgctl configuration
EXAMPLES
$ dgctl config
_See code: dist/commands/config.ts_
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_
Generates terraform based on the Digger infra bundle
USAGE
$ dgctl generateDESCRIPTION
Generates terraform based on the Digger infra bundle
_See code: dist/commands/generate.ts_
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_
describe the command here
USAGE
$ dgctl infra [ACTION] [-n ] [-f]FLAGS
-f, --force
-n, --name= name to print
DESCRIPTION
describe the command here
EXAMPLES
$ dgctl infra
_See code: dist/commands/infra.ts_
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=
DESCRIPTION
Creates a Digger infra bundle project
EXAMPLES
$ dgctl init
_See code: dist/commands/init.ts_
Login with Digger key
USAGE
$ dgctl login [KEY]DESCRIPTION
Login with Digger key
EXAMPLES
$ dgctl login
_See code: dist/commands/login.ts_
List installed plugins.
USAGE
$ dgctl plugins [--core]FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ dgctl plugins
_See code: @oclif/plugin-plugins_
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
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
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
Links a plugin into the CLI for development.
USAGE
$ dgctl plugins:link PLUGINARGUMENTS
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
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
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
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
Update installed plugins.
USAGE
$ dgctl plugins update [-h] [-v]FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
Initialise project based on preset
USAGE
$ dgctl preset [PRESET] [-a] [-p ]FLAGS
-a, --advanced
-p, --path= 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_
describe the command here
USAGE
$ dgctl provision [FILE] [-s] [-p ] [-b ]FLAGS
-b, --bucket= S3 bucket name
-p, --profile= 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_
Perform secret management actions
USAGE
$ dgctl secretDESCRIPTION
Perform secret management actions
_See code: dist/commands/secret/index.ts_
describe the command here
USAGE
$ dgctl secret add [KV] [-b ]FLAGS
-b, --block= name of the block
DESCRIPTION
describe the command here
EXAMPLES
$ dgctl secret add
Delete secret
USAGE
$ dgctl secret delete [KEY] [-b ]FLAGS
-b, --block= name of the block
DESCRIPTION
Delete secret
update the dgctl CLI
USAGE
$ dgctl update [CHANNEL] [-a] [-v | -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= 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_
Manage environment variables for your infrastructure
USAGE
$ dgctl variable [COMMAND] [KV] [-b ]FLAGS
-b, --block= name of the block
DESCRIPTION
Manage environment variables for your infrastructure
EXAMPLES
$ dgctl variable
_See code: dist/commands/variable.ts_