Skip to main content

Codiac-CLI

Codiac-CLI

oclif Version CircleCI Downloads/week License

Usage

$ npm install -g @codiac.io/codiac-cli
$ codiac COMMAND
running command...
$ codiac (--version|-v)
@codiac.io/codiac-cli/1.3.188 win32-x64 node-v22.16.0
$ codiac --help [COMMAND]
USAGE
  $ codiac COMMAND
...
$ npm install -g @codiac.io/codiac-cli
$ codiac COMMAND
running command...
$ codiac (--version|-v)
@codiac.io/codiac-cli/1.3.188 win32-x64 node-v22.16.0
$ codiac --help [COMMAND]
USAGE
  $ codiac COMMAND
...
$ npm install -g @codiac.io/codiac-cli
$ codiac COMMAND
running command...
$ codiac (--version|-v)
@codiac.io/codiac-cli/1.3.188 linux-x64 node-v22.15.1
$ codiac --help [COMMAND]
USAGE
  $ codiac COMMAND
...

codiac​

USAGE
  $ codiac

See code: dist/commands/index.ts

codiac asset create​

Creates a new asset in the given enterprise from an image that exists in a container registry.

USAGE
  $ codiac asset create [-h] [-k <value> | -i <value> | -r <value>] [-n <value>] [-c <value>] [-e <value>] [-p
    <value>] [--private -g] [-o] [--allow-http] [--disable-https] [--helm] [--take-defaults | [--silent | --echo |
    --to-script]]

FLAGS
  -c, --code=<value>
      The host name to assign this asset in the domain url.  eg: 'myasset' in 'myasset.your-domain.com' (Optional:
      defaults to the asset name).

  -e, --enterprise=<value>
      The name of the enterprise in which to create this asset. (defaults to the current enterprise context)

  -g, --hasIngress
      Declaration that the asset service is to be accessible from outside the cluster (optional: defaults to false).

  -h, --help
      Show CLI help.

  -i, --image=<value>
      The image name including scope prefix if applicable (eg: '@yourCompany/your-api-image').

  -k, --kit=<value>
      The name of the kit (with library prefix, eg: 'library/kitName') to use to create the asset.  Use '?' to be prompted
      for a kit (Optional: used instead of calling for the image).

  -n, --name=<value>
      The name to give the enterprise asset (Optional: defaults to the image name without the scope prefix).

  -o, --routedWithoutName
      Indicates that this asset will be the base ingress against your DNS. eg: true services yourwebsite.com (as
      root/naked) (optional: defaults to false).

  -p, --port=<value>...
      The default port number (from 0 to 65535) to assign the asset when deployed to a cabinet (optional).  To specify
      port forwarding (betw the service and container), use format: `<service-port>:<container-port>`, eg: `3555:80`

  -r, --registry=<value>
      The container registry in which the image exists (defaults to docker hub).

  --allow-http
      (Advanced) Enable this setting to allow http (ie: non-SSL/TLS) requests in through the ingress controller without
      getting redirected to https.  That is, Setting this to true will prevent the ingress controller from invoking an
      automatic redirect to https on any inbound http requests. (optional: defaults to false).

  --disable-https
      (Advanced) (optional: defaults to false) Enable this setting to remove support for https (aka: SSL/TLS) in the
      ingress controller.  Use this setting when tls terminates upstream of the cluster and its ingress controller.
      Setting this flag DOES NOT automatically set the `--allow-http` flag, so be diligent when using it.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --helm
      Indicates that this asset will be base on a Helm chart instead of a container (optional: defaults to false).

  --private
      (for use when hasIngress is also set) Prevents access from the internet.  That is, declares that asset service to
      only be accessible through ingress on internal networks (optional: defaults to false).  Useful for enabling private
      "east-west" (cross-cluster) communications without going out to the internet.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Creates a new asset in the given enterprise from an image that exists in a container registry.

ALIASES
  $ codiac asset new

See code: dist/commands/asset/create.ts

codiac asset destroy​

UN-deploys a given asset from a given cabinet. Defaults to removing only the pod deployments and leaving the service in place; set the --scorch argument to remove the service.

USAGE
  $ codiac asset destroy [-h] [-e <value>] [-c <value>] [-a <value>] [-v <value>] [-s] [-y]

FLAGS
  -a, --asset=<value>       Search string for the name of the asset to destroy (use ? to be prompted).
  -c, --cabinet=<value>     Name of the cabinet from which the asset is to be removed.
  -e, --enterprise=<value>  (optional: required only when asset name is not unique across enterprises) Code (name) of
                            the enterprise to work with
  -h, --help                Show CLI help.
  -s, --scorch              (Optional: defaults to false) Destroys the service too, instead of just the deployment and
                            pods.
  -v, --version=<value>     Search string for the version of the asset to destroy  (use ? to be prompted).
  -y, --silent              (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
                            prior runs.

DESCRIPTION
  UN-deploys a given asset from a given cabinet.  Defaults to removing only the pod deployments and leaving the service
  in place; set the --scorch argument to remove the service.

See code: dist/commands/asset/destroy.ts

codiac asset edit​

Changes asset attributes.

USAGE
  $ codiac asset edit [-e <value>] [-c <value>] [--echo | --to-script | [--silent -n <value>]]

FLAGS
  -c, --code=<value>        The host name to assign this asset in the domain url.  eg: 'myasset' in
                            'myasset.your-domain.com' (Optional: defaults to the asset name).
  -e, --enterprise=<value>  The name of the enterprise in which this asset resides. (defaults to the current enterprise
                            context).  NOTE: The enterprise assignment for an asset is immutable and cannot be modified;
                            this flag is used only for identifying the asset.
  -n, --name=<value>        The name of the asset to edit.  NOTE: The asset name is immutable and cannot be modified;
                            this flag is used only for identifying the asset.
  --echo                    Echo interaction mode; renders the equivalent non-interactive cli command for future use
                            before final execution.
  --silent                  Non-Interactive mode; executes without any user interaction and fails on any missing or
                            invalid arguments.
  --to-script               Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                            execution.

DESCRIPTION
  Changes asset attributes.

EXAMPLES
  $ codiac asset edit

  $ codiac asset edit -n my-api

  $ codiac asset edit -e main -n my-api

See code: dist/commands/asset/edit.ts

codiac asset entrypoint​

Sets the command run on container startup (Overrides the ENTRYPOINT set in the image itself, as well as any image elements specified using CMD)).

USAGE
  $ codiac asset entrypoint [-e <value>] [-d <value>] [-c <value>] [-c <value>] [-v <value>] [--echo | --to-script |
    [--silent -a <value>]]

FLAGS
  -a, --asset=<value>          The name of the asset to edit.  NOTE: The asset name is immutable and cannot be modified;
                               this flag is used only for identifying the asset.
  -c, --arg=<value>...         Gets passed to the entryPointCommand.  Often, the entrypointCommand opens a shell,
                               allowing this to be the command to run inside the shell,       eg: `--command="/bin/sh"
                               --arg="-c ls -a"` which yields: `/bin/sh -c ls -a`
  -c, --command=<value>        The command to run.  Not executed within a shell.
  -d, --workdir=<value>        (optional) Folder path within the image from which to execute the command. Overrides the
                               default working directory specified by the container image.
  -e, --enterprise=<value>     The name of the enterprise in which this asset resides. (defaults to the current
                               enterprise context).  NOTE: The enterprise assignment for an asset is immutable and
                               cannot be modified; this flag is used only for identifying the asset.
  -v, --version-range=<value>  (optional) The semantic version rule describing which versions of the asset will get this
                               entrypoint applied.  (eg: Just this one: `1.2.3`, or this one and any future patches:
                               `^1.2.3`, or any on or after this one: `>=1.2.3`, or any before this one `<1.2.3` , or
                               any between inclusive: `1.0.0 - 1.2.3`).  NOTE: Remember to wrap your range spec in
                               quotes if it has any spaces in it.
  --echo                       Echo interaction mode; renders the equivalent non-interactive cli command for future use
                               before final execution.
  --silent                     Non-Interactive mode; executes without any user interaction and fails on any missing or
                               invalid arguments.
  --to-script                  Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                               execution.

DESCRIPTION
  Sets the command run on container startup (Overrides the ENTRYPOINT set in the image itself, as well as any image
  elements specified using CMD)).

ALIASES
  $ codiac asset entrypoint

EXAMPLES
  Interactive

    $ codiac asset entrypoint

  Interactive, preset for the a specific asset.

    $ codiac asset entrypoint -a my-api

  Interactive as above, but when you have more than a single enterprise, and one of them is named `ml`.

    $ codiac asset entrypoint -e ml -a my-worker

  Invoking an executable from within a bash shell (this mock scenario just imports some credentials and workflows and
  once complete, the image shuts down)

    $ codiac asset entrypoint -a my-import --command '/bin/sh' --arg '-c'         --arg 'myexe import:credentials ^
      --separate --input=/backup/credentials && myexe import:workflow --separate --input=/backup/workflows'

  Same as above but non-interactive (for use in scripts and pipelines)

    $ codiac asset entrypoint --silent -e ml -a my-import --command '/bin/sh' --arg '-c'         --arg 'myexe ^
      import:credentials --separate --input=/backup/credentials && myexe import:workflow --separate ^
      --input=/backup/workflows'

codiac asset entrypoint delete​

Removes an existing override of the image startup command for this asset (restores the original ENTRYPOINT set in the image itself, as well as any image elements specified using CMD)).

USAGE
  $ codiac asset entrypoint delete [-e <value>] [-v <value>] [--echo | --to-script | [--silent -a <value>]]

FLAGS
  -a, --asset=<value>
      The name of the asset to adjust.

  -e, --enterprise=<value>
      The name of the enterprise in which this asset resides (defaults to the current enterprise context).

  -v, --version-range=<value>
      (optional, defaults to the entrypoint assigned to "any" version) Used to identify the entrypoint.  The semantic
      version rule describing which versions of the asset will get this entrypoint applied.  (eg: Just this one: `1.2.3`,
      or this one and any future patches: `^1.2.3`, or any on or after this one: `>=1.2.3`, or any before this one
      `<1.2.3` , or any between inclusive: `1.0.0 - 1.2.3`).  NOTE: Remember to wrap your range spec in quotes if it has
      any spaces in it.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Removes an existing override of the image startup command for this asset (restores the original ENTRYPOINT set in the
  image itself, as well as any image elements specified using CMD)).

EXAMPLES
  Interactive

    $ codiac asset entrypoint delete

  Interactive, preset for the a specific asset.

    $ codiac asset entrypoint delete -a my-api

  Interactive as above, but when you have more than a single enterprise, and one of them is named `ml`.

    $ codiac asset entrypoint delete -e ml -a my-worker

  Non-interactive, removal by specifying the version range with an explicit match

    $ codiac asset entrypoint delete -e ml -a my-worker -v '>=1.2.3' --silent

See code: dist/commands/asset/entrypoint/delete.ts

codiac asset entrypoint set​

Sets the command run on container startup (Overrides the ENTRYPOINT set in the image itself, as well as any image elements specified using CMD)).

USAGE
  $ codiac asset entrypoint set [-e <value>] [-d <value>] [-c <value>] [-c <value>] [-v <value>] [--echo | --to-script |
    [--silent -a <value>]]

FLAGS
  -a, --asset=<value>          The name of the asset to edit.  NOTE: The asset name is immutable and cannot be modified;
                               this flag is used only for identifying the asset.
  -c, --arg=<value>...         Gets passed to the entryPointCommand.  Often, the entrypointCommand opens a shell,
                               allowing this to be the command to run inside the shell,       eg: `--command="/bin/sh"
                               --arg="-c ls -a"` which yields: `/bin/sh -c ls -a`
  -c, --command=<value>        The command to run.  Not executed within a shell.
  -d, --workdir=<value>        (optional) Folder path within the image from which to execute the command. Overrides the
                               default working directory specified by the container image.
  -e, --enterprise=<value>     The name of the enterprise in which this asset resides. (defaults to the current
                               enterprise context).  NOTE: The enterprise assignment for an asset is immutable and
                               cannot be modified; this flag is used only for identifying the asset.
  -v, --version-range=<value>  (optional) The semantic version rule describing which versions of the asset will get this
                               entrypoint applied.  (eg: Just this one: `1.2.3`, or this one and any future patches:
                               `^1.2.3`, or any on or after this one: `>=1.2.3`, or any before this one `<1.2.3` , or
                               any between inclusive: `1.0.0 - 1.2.3`).  NOTE: Remember to wrap your range spec in
                               quotes if it has any spaces in it.
  --echo                       Echo interaction mode; renders the equivalent non-interactive cli command for future use
                               before final execution.
  --silent                     Non-Interactive mode; executes without any user interaction and fails on any missing or
                               invalid arguments.
  --to-script                  Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                               execution.

DESCRIPTION
  Sets the command run on container startup (Overrides the ENTRYPOINT set in the image itself, as well as any image
  elements specified using CMD)).

ALIASES
  $ codiac asset entrypoint

EXAMPLES
  Interactive

    $ codiac asset entrypoint set

  Interactive, preset for the a specific asset.

    $ codiac asset entrypoint set -a my-api

  Interactive as above, but when you have more than a single enterprise, and one of them is named `ml`.

    $ codiac asset entrypoint set -e ml -a my-worker

  Invoking an executable from within a bash shell (this mock scenario just imports some credentials and workflows and
  once complete, the image shuts down)

    $ codiac asset entrypoint set -a my-import --command '/bin/sh' --arg '-c'         --arg 'myexe ^
      import:credentials --separate --input=/backup/credentials && myexe import:workflow --separate ^
      --input=/backup/workflows'

  Same as above but non-interactive (for use in scripts and pipelines)

    $ codiac asset entrypoint set --silent -e ml -a my-import --command '/bin/sh' --arg '-c'         --arg 'myexe ^
      import:credentials --separate --input=/backup/credentials && myexe import:workflow --separate ^
      --input=/backup/workflows'

See code: dist/commands/asset/entrypoint/set.ts

codiac asset get [CMD]​

Renders a selected type of content for an asset

USAGE
  $ codiac asset get [CMD] [-h] [-e <value>] [-a <value>] [-n <value>] [-c <value>] [-r <value>] [-t
    logs|term|exec|env|config|status] [--terminal bash|sh] [-f] [-l <value>] [-F <value>] [-T
    annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onpredeploy|permit|probing | ]
    [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  CMD  (requires type=exec) command and its space-separated arguments to run in the target replica.

FLAGS
  -F, --configFile=<value>   (requires type=config) The root pathname to the config file to fetch.
  -T, --configType=<option>  Filters for the settings types that do not land in a config file (such as... env: OS
                             environment variables, footprint: container footprint specs, helm: helm chart settings,
                             label: container meta labels, annotation: container platform key-value pairs).
                             <options: annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onp
                             redeploy|permit|probing>
  -a, --asset=<value>        The name of the asset to view.
  -c, --cabinet=<value>      The name of the cabinet from which the content is to be drawn.
  -e, --enterprise=<value>   The name of the enterprise containing the asset being viewed.
  -f, --logsFollow           (requires type=logs) Follow (aka watch, tail, stream) the output.
  -h, --help                 Show CLI help.
  -l, --logsTail=<value>     [default: 10] (requires type=logs) Lines of recent logs to include in the output.  Enter -1
                             to include the entire log history stored in the container.
  -n, --environment=<value>  The name of the environment in which the cabinet resides.
  -r, --replica=<value>      The name of one of the asset instances currently running in the cabinet. Set to "any" to
                             select the first available replica without prompting for one.
  -t, --type=<option>        The type of content to retrieve.
                             <options: logs|term|exec|env|config|status>
  --echo                     Echo interaction mode; renders the equivalent non-interactive cli command for future use
                             before final execution.
  --silent                   Non-Interactive mode; executes without any user interaction and fails on any missing or
                             invalid arguments.
  --take-defaults            Prevents prompting for confirmation on parameters that were passed in or were set to
                             default values.
  --terminal=<option>        Command used to start the terminal (defaults to "bash")
                             <options: bash|sh>
  --to-script                Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                             execution.

DESCRIPTION
  Renders a selected type of content for an asset

ALIASES
  $ codiac asset monitor
  $ codiac asset mon
  $ codiac asset get

codiac asset helm [SETTING]​

Creates a new asset in the given enterprise from an image that exists in a container registry.

USAGE
  $ codiac asset helm [SETTING] [-h] [-i <value>] [-y  -r <value> -n <value> -c <value> -e <value> -p <value> -g
    -o]

ARGUMENTS
  SETTING  The key for the config setting to add

FLAGS
  -c, --code=<value>        The host name to assign this asset in the domain url.  eg: 'myasset' in
                            'myasset.your-domain.com' (Optional: defaults to the asset name).
  -e, --enterprise=<value>  The name of the enterprise in which to create this asset. (defaults to the current
                            enterprise context)
  -g, --hasIngress          Declaration that the asset service is to be externally accessible (optional: defaults to
                            false).
  -h, --help                Show CLI help.
  -i, --chart=<value>       The chart name including scope prefix if applicable (eg: '@yourCompany/your-helm-chart').
  -n, --name=<value>        The name to give the enterprise asset (Optional: defaults to the image name without the
                            scope prefix).
  -o, --routedWithoutName   Indicates that this asset will be the base ingress against your DNS. eg: true services
                            yourwebsite.com (as root/naked) (optional: defaults to false).
  -p, --port=<value>        The default port to assign the asset when deployed to a cabinet (optional).
  -r, --registry=<value>    The chart registry in which the chart exists (defaults to docker hub).
  -y, --silent              (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
                            prior runs. Requires: image,registry,name,code,enterprise,port,hasIngress,routedWithoutName

DESCRIPTION
  Creates a new asset in the given enterprise from an image that exists in a container registry.

ALIASES
  $ codiac asset new

See code: dist/commands/asset/helm.ts

codiac asset initializer create​

Declares an initialization container to execute before the asset container starts up.

USAGE
  $ codiac asset initializer create [-e <value>] [--command <value>] [--arg <value>] [-d <value>] [--cpu <value>] [--cpu-limit
    <value>] [--mem <value>] [--mem-limit <value>] [--no-env] [--no-config] [--no-filestores] [-v <value>] [--echo |
    --to-script | [--silent -a <value> -n <value> -i <value>]]

FLAGS
  -a, --asset=<value>
      The name of the asset to edit.  NOTE: The asset name is immutable and cannot be modified; this flag is used only for
      identifying the asset.

  -d, --working-dir=<value>
      (optional) Folder path within the image from which to execute the command. Overrides the default working directory
      specified by the container image.

  -e, --enterprise=<value>
      The name of the enterprise in which this asset resides. (defaults to the current enterprise context).  NOTE: The
      enterprise assignment for an asset is immutable and cannot be modified; this flag is used only for identifying the
      asset.

  -i, --image=<value>
      [default: busybox] The fully qualified address for the image to use, with optional version tag, (eg:
      `mystuff.azurecr.io/my-private-image`).  NOTE: DockerHub is default, so images from DockerHub do not need the
      registry url, eg: `redis:1.27`.

  -n, --name=<value>
      What to name this init container, to identify it when managing it.

  -v, --version-range=<value>
      (optional) The semantic version rule describing which versions of the asset will get this entrypoint applied.  (eg:
      Just this one: `1.2.3`, or this one and any future patches: `^1.2.3`, or any on or after this one: `>=1.2.3`, or any
      before this one `<1.2.3` , or any between inclusive: `1.0.0 - 1.2.3`).  NOTE: Remember to wrap your range spec in
      quotes if it has any spaces in it.

  --arg=<value>...
      (Optional; defaults to whatever the image has as its "CMD")       Gets passed to the entryPointCommand.  Often, the
      entrypointCommand opens a shell, allowing this to be the command to run inside the shell,             eg:
      `entryPointCommand="/bin/sh -c"` and `entryPointArgs="ls -a"` which yields: `/bin/sh -c ls -a`

  --command=<value>...
      Command run on container startup (Optional; defaults to the image's ENTRYPOINT, and if null, defaults to /bin/sh -c)
      Description from k8s docs: Not executed within a shell. The container image's ENTRYPOINT is used if this is not
      provided.       Variable references $(VAR_NAME) are expanded using the container's environment. If a variable cannot
      be resolved,       the reference in the input string will be unchanged. Double $ are reduced to a single $,
      which allows for escaping the $(VAR_NAME) syntax: i.e. "$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
      Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated.

  --cpu=<value>
      The amount of cpu (in fractional cores) plus the optional metric unit designation (`m, c, d`) to reserve in the pod
      for this init container. eg: `250m` for 250 millicores, or 25% of a single core.   NOTE: This value gets added to
      the amount specified by the footprint of the parent asset.

  --cpu-limit=<value>

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --mem=<value>

  --mem-limit=<value>

  --no-config

  --no-env

  --no-filestores

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Declares an initialization container to execute before the asset container starts up.

EXAMPLES
  $ codiac asset initializer create

See code: dist/commands/asset/initializer/create.ts

codiac asset list​

Shows the list of assets in a given enterprise.

USAGE
  $ codiac asset list [-h] [-e <value>] [-o text|tree|json|yaml] [-q <value>] [--silent | --echo | --to-script]

FLAGS
  -e, --enterprise=<value>  The name of the enterprise containing the assets being viewed (required if there are more
                            than one).
  -h, --help                Show CLI help.
  -o, --output=<option>     Format in which to render the results.
                            <options: text|tree|json|yaml>
  -q, --query=<value>       JMESPath expression to filter or reshape the results (see jmespath.org).
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Shows the list of assets in a given enterprise.

EXAMPLES
  Simple listing.

    $ codiac asset list

  List of asset names only.

    $ codiac asset list -q '[].name'

  Multi-property projection.

    $ codiac asset list -q '[].{ name: name, product: product }'

  Filter assets with ingress.

    $ codiac asset list -q "[?hasIngress == 'true']"

  Export as YAML.

    $ codiac asset list -o yaml

  Non-interactive invocation.

    $ codiac asset list -e myEnterprise --silent

  Renders the equivalent silent command without executing.

    $ codiac asset list -e myEnterprise --to-script

See code: dist/commands/asset/list.ts

codiac asset mon [CMD]​

Renders a selected type of content for an asset

USAGE
  $ codiac asset mon [CMD] [-h] [-e <value>] [-a <value>] [-n <value>] [-c <value>] [-r <value>] [-t
    logs|term|exec|env|config|status] [--terminal bash|sh] [-f] [-l <value>] [-F <value>] [-T
    annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onpredeploy|permit|probing | ]
    [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  CMD  (requires type=exec) command and its space-separated arguments to run in the target replica.

FLAGS
  -F, --configFile=<value>   (requires type=config) The root pathname to the config file to fetch.
  -T, --configType=<option>  Filters for the settings types that do not land in a config file (such as... env: OS
                             environment variables, footprint: container footprint specs, helm: helm chart settings,
                             label: container meta labels, annotation: container platform key-value pairs).
                             <options: annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onp
                             redeploy|permit|probing>
  -a, --asset=<value>        The name of the asset to view.
  -c, --cabinet=<value>      The name of the cabinet from which the content is to be drawn.
  -e, --enterprise=<value>   The name of the enterprise containing the asset being viewed.
  -f, --logsFollow           (requires type=logs) Follow (aka watch, tail, stream) the output.
  -h, --help                 Show CLI help.
  -l, --logsTail=<value>     [default: 10] (requires type=logs) Lines of recent logs to include in the output.  Enter -1
                             to include the entire log history stored in the container.
  -n, --environment=<value>  The name of the environment in which the cabinet resides.
  -r, --replica=<value>      The name of one of the asset instances currently running in the cabinet. Set to "any" to
                             select the first available replica without prompting for one.
  -t, --type=<option>        The type of content to retrieve.
                             <options: logs|term|exec|env|config|status>
  --echo                     Echo interaction mode; renders the equivalent non-interactive cli command for future use
                             before final execution.
  --silent                   Non-Interactive mode; executes without any user interaction and fails on any missing or
                             invalid arguments.
  --take-defaults            Prevents prompting for confirmation on parameters that were passed in or were set to
                             default values.
  --terminal=<option>        Command used to start the terminal (defaults to "bash")
                             <options: bash|sh>
  --to-script                Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                             execution.

DESCRIPTION
  Renders a selected type of content for an asset

ALIASES
  $ codiac asset monitor
  $ codiac asset mon
  $ codiac asset get

codiac asset monitor [CMD]​

Renders a selected type of content for an asset

USAGE
  $ codiac asset monitor [CMD] [-h] [-e <value>] [-a <value>] [-n <value>] [-c <value>] [-r <value>] [-t
    logs|term|exec|env|config|status] [--terminal bash|sh] [-f] [-l <value>] [-F <value>] [-T
    annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onpredeploy|permit|probing | ]
    [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  CMD  (requires type=exec) command and its space-separated arguments to run in the target replica.

FLAGS
  -F, --configFile=<value>   (requires type=config) The root pathname to the config file to fetch.
  -T, --configType=<option>  Filters for the settings types that do not land in a config file (such as... env: OS
                             environment variables, footprint: container footprint specs, helm: helm chart settings,
                             label: container meta labels, annotation: container platform key-value pairs).
                             <options: annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onp
                             redeploy|permit|probing>
  -a, --asset=<value>        The name of the asset to view.
  -c, --cabinet=<value>      The name of the cabinet from which the content is to be drawn.
  -e, --enterprise=<value>   The name of the enterprise containing the asset being viewed.
  -f, --logsFollow           (requires type=logs) Follow (aka watch, tail, stream) the output.
  -h, --help                 Show CLI help.
  -l, --logsTail=<value>     [default: 10] (requires type=logs) Lines of recent logs to include in the output.  Enter -1
                             to include the entire log history stored in the container.
  -n, --environment=<value>  The name of the environment in which the cabinet resides.
  -r, --replica=<value>      The name of one of the asset instances currently running in the cabinet. Set to "any" to
                             select the first available replica without prompting for one.
  -t, --type=<option>        The type of content to retrieve.
                             <options: logs|term|exec|env|config|status>
  --echo                     Echo interaction mode; renders the equivalent non-interactive cli command for future use
                             before final execution.
  --silent                   Non-Interactive mode; executes without any user interaction and fails on any missing or
                             invalid arguments.
  --take-defaults            Prevents prompting for confirmation on parameters that were passed in or were set to
                             default values.
  --terminal=<option>        Command used to start the terminal (defaults to "bash")
                             <options: bash|sh>
  --to-script                Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                             execution.

DESCRIPTION
  Renders a selected type of content for an asset

ALIASES
  $ codiac asset monitor
  $ codiac asset mon
  $ codiac asset get

codiac asset new​

Creates a new asset in the given enterprise from an image that exists in a container registry.

USAGE
  $ codiac asset new [-h] [-k <value> | -i <value> | -r <value>] [-n <value>] [-c <value>] [-e <value>] [-p
    <value>] [--private -g] [-o] [--allow-http] [--disable-https] [--helm] [--take-defaults | [--silent | --echo |
    --to-script]]

FLAGS
  -c, --code=<value>
      The host name to assign this asset in the domain url.  eg: 'myasset' in 'myasset.your-domain.com' (Optional:
      defaults to the asset name).

  -e, --enterprise=<value>
      The name of the enterprise in which to create this asset. (defaults to the current enterprise context)

  -g, --hasIngress
      Declaration that the asset service is to be accessible from outside the cluster (optional: defaults to false).

  -h, --help
      Show CLI help.

  -i, --image=<value>
      The image name including scope prefix if applicable (eg: '@yourCompany/your-api-image').

  -k, --kit=<value>
      The name of the kit (with library prefix, eg: 'library/kitName') to use to create the asset.  Use '?' to be prompted
      for a kit (Optional: used instead of calling for the image).

  -n, --name=<value>
      The name to give the enterprise asset (Optional: defaults to the image name without the scope prefix).

  -o, --routedWithoutName
      Indicates that this asset will be the base ingress against your DNS. eg: true services yourwebsite.com (as
      root/naked) (optional: defaults to false).

  -p, --port=<value>...
      The default port number (from 0 to 65535) to assign the asset when deployed to a cabinet (optional).  To specify
      port forwarding (betw the service and container), use format: `<service-port>:<container-port>`, eg: `3555:80`

  -r, --registry=<value>
      The container registry in which the image exists (defaults to docker hub).

  --allow-http
      (Advanced) Enable this setting to allow http (ie: non-SSL/TLS) requests in through the ingress controller without
      getting redirected to https.  That is, Setting this to true will prevent the ingress controller from invoking an
      automatic redirect to https on any inbound http requests. (optional: defaults to false).

  --disable-https
      (Advanced) (optional: defaults to false) Enable this setting to remove support for https (aka: SSL/TLS) in the
      ingress controller.  Use this setting when tls terminates upstream of the cluster and its ingress controller.
      Setting this flag DOES NOT automatically set the `--allow-http` flag, so be diligent when using it.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --helm
      Indicates that this asset will be base on a Helm chart instead of a container (optional: defaults to false).

  --private
      (for use when hasIngress is also set) Prevents access from the internet.  That is, declares that asset service to
      only be accessible through ingress on internal networks (optional: defaults to false).  Useful for enabling private
      "east-west" (cross-cluster) communications without going out to the internet.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Creates a new asset in the given enterprise from an image that exists in a container registry.

ALIASES
  $ codiac asset new

codiac asset obliterate​

Performs a full cascading delete of the given asset and all of its related data in Codiac (eg: versions, probes, configs, tags...). NOTE: This command does NOT delete anything from the image registry. NOTE: To obliterate an asset, you must first remove it from all cabinets; this command will not obliterate any asset that is currently deployed.

USAGE
  $ codiac asset obliterate [-e <value>] [--echo | --to-script | [--silent -n <value>]]

FLAGS
  -e, --enterprise=<value>  The name of the enterprise in which to create this asset. (defaults to the current
                            enterprise context)
  -n, --name=<value>        The name of the asset to obliterate.
  --echo                    Echo interaction mode; renders the equivalent non-interactive cli command for future use
                            before final execution.
  --silent                  Non-Interactive mode; executes without any user interaction and fails on any missing or
                            invalid arguments.
  --to-script               Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                            execution.

DESCRIPTION
  Performs a full cascading delete of the given asset and all of its related data in Codiac (eg: versions, probes,
  configs, tags...). NOTE: This command does NOT delete anything from the image registry.  NOTE: To obliterate an asset,
  you must first remove it from all cabinets; this command will not obliterate any asset that is currently deployed.

EXAMPLES
  $ codiac asset obliterate

  $ codiac asset obliterate -n my-api

  $ codiac asset obliterate -e main -n my-api

See code: dist/commands/asset/obliterate.ts

codiac asset probe create [CMD]​

Declares the implementation of a health or readiness probe for an asset.

USAGE
  $ codiac asset probe create [CMD] -u readiness|liveness|startup [-h] [-n <value>] [-a <value>] [-v <value>] [-d
    <value>] [-p <value>] [-t <value>] [--success-threshold <value>] [--failure-threshold <value>] [--predefined <value>
    | --exec | --grpc | --http | --socket] [-x <value>] [--grpcHost <value> ] [--grpcPort <value> ] [--httpScheme
    http|https ] [--httpHost <value> ] [--httpPort <value> ] [--httpPath <value> ] [-r <value> ] [--socketHost <value> ]
    [--socketPort <value> ] [--silent | --echo | --to-script]

ARGUMENTS
  CMD  (requires --exec) command and its space-separated arguments to run in the target replica.

FLAGS
  -a, --asset=<value>          The name of the asset to which this probe is to apply.
  -d, --delay=<value>          The time (in seconds) to wait before the first execution of the probe.
  -h, --help                   Show CLI help.
  -n, --enterprise=<value>     The name of the enterprise to which this probe is to apply.
  -p, --period=<value>         [default: 10] How often (in seconds) to fire the probe.
  -r, --httpHeader=<value>...  (For use only with http) Key value pair (in format x=y) to be used as an http header in
                               an http probe action.
  -t, --timeout=<value>        How long to wait (in seconds) for a probe to respond before declaring it a failed
                               execution (default and min 1 second).
  -u, --usage=<option>         (required) [default: readiness] The diagnostic purpose the probe will serve.
                               <options: readiness|liveness|startup>
  -v, --versions=<value>       Asset version range for which this probe is to be used. (optional: defaults to >=latest)
  -x, --action=<value>         The JSON specification for the probe action itself.  The structure follows the
                               actionType.
  --echo                       Renders the equivalent non-interactive command for future use before executing.
  --exec                       Declares the probe shall be carried out as an executable CLI command. A return code of
                               zero indicates success.  Any nonzero result indicates failure.
  --failure-threshold=<value>  The number of unsuccessful probe executions to allow before determining the pod
                               unhealthy.
  --grpc                       Declares the probe shall be carried out as a grpc api request.
  --grpcHost=<value>           (For use only with grpc).
  --grpcPort=<value>           (For use only with grpc).
  --http                       Declares the probe shall be carried out as an http request. Any code greater than or
                               equal to 200 and less than 400 indicates success. Any other code indicates failure.
  --httpHost=<value>           (For use only with http) The host name or IP to probe.
  --httpPath=<value>           (For use only with http) The URL path to probe.
  --httpPort=<value>           (For use only with http) The port to probe.
  --httpScheme=<option>        (For use only with http) The http protocol to use.
                               <options: http|https>
  --predefined=<value>         Calls out by name for an existing standard or shared probe action.  Use this argument
                               instead of defining the probe action with the exec, grpc, http or socket arguments.
  --silent                     Executes without any user interaction; fails on missing or invalid arguments.
  --socket                     Declares the probe shall be carried out as a TCP Socket request.
  --socketHost=<value>         (For use only with socket) The host to connect to.
  --socketPort=<value>         (For use only with socket) The port to connect to.
  --success-threshold=<value>  Minimum consecutive successes for the probe to be considered successful after having
                               failed. Defaults to 1. Must be 1 for liveness and startup Probes. Minimum value is 1.
  --to-script                  Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Declares the implementation of a health or readiness probe for an asset.

ALIASES
  $ codiac probe create

EXAMPLES
  Create a probe interactively.

    $ codiac asset probe create

  Exec probe using a predefined action.

    $ codiac asset probe create --predefined builtin-heartbeat-file-exists

  Exec probe with inline command.

    $ codiac asset probe create -p 15 --exec -- "cat /app/data/last-heartbeat.json"

  Http probe with headers.

    $ codiac asset probe create -n acme -a myapi -u readiness -p 15 --http --httpScheme https --httpHost ^
      myapi.acme.com --httpPort 443 --httpPath /diag/heartbeat -r Accept=application/json -r user-agent=MyUserAgent

  Non-interactive invocation.

    $ codiac asset probe create -n acme -a myapi --predefined builtin-heartbeat-file-exists --silent

  Renders the equivalent silent command without executing.

    $ codiac asset probe create -n acme -a myapi --predefined builtin-heartbeat-file-exists --to-script

See code: dist/commands/asset/probe/create.ts

codiac asset probe delete​

Removes an asset probe definition. DOES NOT running assets; assets will need to be redeployed for this change to affect their runtime instances.

USAGE
  $ codiac asset probe delete [-e <value>] [-a <value> | --id <value>] [-u readiness|liveness|startup] [-v <value>]
    [--take-defaults | [--silent | --echo | --to-script]]

FLAGS
  -a, --asset=<value>
      The asset that owns the probe.

  -e, --enterprise=<value>
      The name of the enterprise on which to apply this naming strategy. NOTE: You can leave this blank if there is only
      one.

  -u, --usage=<option>
      The diagnostic purpose the probe serves.
      <options: readiness|liveness|startup>

  -v, --version-range=<value>
      The semantic version range of the asset in which the probe definition applies. You can use the wildcard * to force
      delete probes for all version ranges. (Note: if specifying, best to select this one interactively if applicable,
      because you cannot just make one up, it must match the exact range on the the probe record.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --id=<value>...
      The system id of the probe itself. Specify multiple ids by separating with commands and/or adding this flag multiple
      times.  You can enter this parameter instead of the other probe descriptors.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Removes an asset probe definition.  DOES NOT running assets; assets will need to be redeployed for this change to
  affect their runtime instances.

EXAMPLES
  $ codiac asset probe delete

See code: dist/commands/asset/probe/delete.ts

codiac asset probe invoke [USAGE]​

Runs the given probe on an instance of the given asset.

USAGE
  $ codiac asset probe invoke [USAGE] [-e <value>] [-a <value> | ] [-c <value>] [--take-defaults | [--silent | --echo |
    --to-script]]

ARGUMENTS
  USAGE  (readiness|liveness|startup) The diagnostic purpose the probe serves.

FLAGS
  -a, --asset=<value>
      The asset that owns the probe.

  -c, --cabinet=<value>
      Target cabinet in which you want to invoke the asset probe

  -e, --enterprise=<value>
      The name of the enterprise in which the asset exists. NOTE: You can leave this blank if there is only one
      enterprise.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Runs the given probe on an instance of the given asset.

EXAMPLES
  $ codiac asset probe invoke

See code: dist/commands/asset/probe/invoke.ts

codiac asset probe list​

Retrieves the list of existing secret stores captured for a given enterprise.

USAGE
  $ codiac asset probe list [-e <value>] [-a <value>] [-t liveness|readiness|startup] [-x exec|grpc|http|socket] [-o
    json|yaml|auto] [--take-defaults | [--silent | --echo | --to-script]]

FLAGS
  -a, --asset=<value>
      The asset that owns the probe.

  -e, --enterprise=<value>
      (optional if there is only one) The enterprise in which the probes are defined.

  -o, --output=<option>
      [default: auto] format in which to render the data.
      <options: json|yaml|auto>

  -t, --type=<option>
      Filter on the purpose/lifecycle role of the probe.
      <options: liveness|readiness|startup>

  -x, --action=<option>
      Filter on the type of action used by the probe.
      <options: exec|grpc|http|socket>

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Retrieves the list of existing secret stores captured for a given enterprise.

EXAMPLES
  $ codiac asset probe list

See code: dist/commands/asset/probe/list.ts

codiac asset recycle​

Deploys a given asset to a given cabinet. Defaults to current version.

USAGE
  $ codiac asset recycle [-e <value>] [-a <value>] [--echo | --to-script | [--silent -c <value>]] [--take-defaults
    | ]

FLAGS
  -a, --asset=<value>
      Search string for the name of the asset to deploy (use ? to be prompted).

  -c, --cabinetName=<value>
      Target cabinet name you want deploy

  -e, --enterpriseCode=<value>
      Code (name) of the enterprise to deploy

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Deploys a given asset to a given cabinet.  Defaults to current version.

See code: dist/commands/asset/recycle.ts

codiac asset undeploy​

UN-deploys a given asset from a given cabinet. Defaults to removing only the pod deployments and leaving the service in place; set the --scorch argument to remove the service.

USAGE
  $ codiac asset undeploy [-h] [-e <value>] [-c <value>] [-a <value>] [-v <value>] [-s] [--silent | --echo |
    --to-script]

FLAGS
  -a, --asset=<value>       Search string for the name of the asset to destroy (use ? to be prompted).
  -c, --cabinet=<value>     Name of the cabinet from which the asset is to be removed.
  -e, --enterprise=<value>  Code (name) of the enterprise to work with (optional: required only when asset name is not
                            unique across enterprises).
  -h, --help                Show CLI help.
  -s, --scorch              Destroys the service too, instead of just the deployment and pods.
  -v, --version=<value>     Search string for the version of the asset to destroy (use ? to be prompted).
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  UN-deploys a given asset from a given cabinet.  Defaults to removing only the pod deployments and leaving the service
  in place; set the --scorch argument to remove the service.

ALIASES
  $ codiac cluster uninstall

EXAMPLES
  Undeploy interactively.

    $ codiac asset undeploy

  Undeploy a specific asset from a specific cabinet.

    $ codiac asset undeploy -e myEnterprise -a myApi -c dev --silent

  Renders the equivalent silent command without executing.

    $ codiac asset undeploy -e myEnterprise -a myApi -c dev --to-script

See code: dist/commands/asset/undeploy.ts

codiac asset view [CMD]​

Renders a selected type of content for an asset

USAGE
  $ codiac asset view [CMD] [-h] [-e <value>] [-a <value>] [-n <value>] [-c <value>] [-r <value>] [-t
    logs|term|exec|env|config|status] [--terminal bash|sh] [-f] [-l <value>] [-F <value>] [-T
    annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onpredeploy|permit|probing | ]
    [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  CMD  (requires type=exec) command and its space-separated arguments to run in the target replica.

FLAGS
  -F, --configFile=<value>   (requires type=config) The root pathname to the config file to fetch.
  -T, --configType=<option>  Filters for the settings types that do not land in a config file (such as... env: OS
                             environment variables, footprint: container footprint specs, helm: helm chart settings,
                             label: container meta labels, annotation: container platform key-value pairs).
                             <options: annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onp
                             redeploy|permit|probing>
  -a, --asset=<value>        The name of the asset to view.
  -c, --cabinet=<value>      The name of the cabinet from which the content is to be drawn.
  -e, --enterprise=<value>   The name of the enterprise containing the asset being viewed.
  -f, --logsFollow           (requires type=logs) Follow (aka watch, tail, stream) the output.
  -h, --help                 Show CLI help.
  -l, --logsTail=<value>     [default: 10] (requires type=logs) Lines of recent logs to include in the output.  Enter -1
                             to include the entire log history stored in the container.
  -n, --environment=<value>  The name of the environment in which the cabinet resides.
  -r, --replica=<value>      The name of one of the asset instances currently running in the cabinet. Set to "any" to
                             select the first available replica without prompting for one.
  -t, --type=<option>        The type of content to retrieve.
                             <options: logs|term|exec|env|config|status>
  --echo                     Echo interaction mode; renders the equivalent non-interactive cli command for future use
                             before final execution.
  --silent                   Non-Interactive mode; executes without any user interaction and fails on any missing or
                             invalid arguments.
  --take-defaults            Prevents prompting for confirmation on parameters that were passed in or were set to
                             default values.
  --terminal=<option>        Command used to start the terminal (defaults to "bash")
                             <options: bash|sh>
  --to-script                Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                             execution.

DESCRIPTION
  Renders a selected type of content for an asset

ALIASES
  $ codiac asset monitor
  $ codiac asset mon
  $ codiac asset get

See code: dist/commands/asset/view.ts

codiac asset vol add [MOUNTPATH]​

Declares a named path for mounting a volume to instances of the asset.

USAGE
  $ codiac asset vol add [MOUNTPATH] [-h] [-e <value>] [-a <value>] [-n <value>] [-d <value>] [--silent | --echo |
    --to-script]

ARGUMENTS
  MOUNTPATH  Fully qualified mounting path, inside the container, of the folder being mapped as a volume.  Must be
             unique for the asset.

FLAGS
  -a, --asset=<value>        The name of the asset to which this volume is being applied.
  -d, --description=<value>  Any notes or other information to help clarify the intended purpose of this folder, to
                             assist during the configuration phase when assigning an actual physical file store to it.
  -e, --enterprise=<value>   The name of the enterprise to which the asset belongs.
  -h, --help                 Show CLI help.
  -n, --name=<value>         Moniker for identifying, retrieving, and accessing this folder mapping.  Must be unique for
                             the asset.
  --echo                     Renders the equivalent non-interactive command for future use before executing.
  --silent                   Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Declares a named path for mounting a volume to instances of the asset.

ALIASES
  $ codiac asset vol create
  $ codiac asset vol add
  $ codiac asset volume add

codiac asset vol create [MOUNTPATH]​

Declares a named path for mounting a volume to instances of the asset.

USAGE
  $ codiac asset vol create [MOUNTPATH] [-h] [-e <value>] [-a <value>] [-n <value>] [-d <value>] [--silent | --echo |
    --to-script]

ARGUMENTS
  MOUNTPATH  Fully qualified mounting path, inside the container, of the folder being mapped as a volume.  Must be
             unique for the asset.

FLAGS
  -a, --asset=<value>        The name of the asset to which this volume is being applied.
  -d, --description=<value>  Any notes or other information to help clarify the intended purpose of this folder, to
                             assist during the configuration phase when assigning an actual physical file store to it.
  -e, --enterprise=<value>   The name of the enterprise to which the asset belongs.
  -h, --help                 Show CLI help.
  -n, --name=<value>         Moniker for identifying, retrieving, and accessing this folder mapping.  Must be unique for
                             the asset.
  --echo                     Renders the equivalent non-interactive command for future use before executing.
  --silent                   Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Declares a named path for mounting a volume to instances of the asset.

ALIASES
  $ codiac asset vol create
  $ codiac asset vol add
  $ codiac asset volume add

codiac asset vol del​

Deletes an existing volume mount in the asset.

USAGE
  $ codiac asset vol del [-h] [-n <value>] [-a <value>] [-e <value>] [--silent | --echo | --to-script]

FLAGS
  -a, --asset=<value>       The name of the asset from which to delete the volume mount.
  -e, --enterprise=<value>  The name of the enterprise to which the asset belongs (required only if more than one
                            enterprise exists).
  -h, --help                Show CLI help.
  -n, --name=<value>        Moniker for identifying, retrieving, and accessing the folder mapping to delete. Must be
                            unique for the asset.
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Deletes an existing volume mount in the asset.

ALIASES
  $ codiac asset vol delete
  $ codiac asset volumes delete
  $ codiac asset volume del
  $ codiac asset vol del
  $ codiac asset volumes del

EXAMPLES
  Select and delete a volume mount interactively.

    $ codiac asset vol del

  Delete a named volume mount.

    $ codiac asset vol del -e myEnterprise -n myMount --silent

  Renders the equivalent silent command without executing.

    $ codiac asset vol del -e myEnterprise -n myMount --to-script

codiac asset vol delete​

Deletes an existing volume mount in the asset.

USAGE
  $ codiac asset vol delete [-h] [-n <value>] [-a <value>] [-e <value>] [--silent | --echo | --to-script]

FLAGS
  -a, --asset=<value>       The name of the asset from which to delete the volume mount.
  -e, --enterprise=<value>  The name of the enterprise to which the asset belongs (required only if more than one
                            enterprise exists).
  -h, --help                Show CLI help.
  -n, --name=<value>        Moniker for identifying, retrieving, and accessing the folder mapping to delete. Must be
                            unique for the asset.
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Deletes an existing volume mount in the asset.

ALIASES
  $ codiac asset vol delete
  $ codiac asset volumes delete
  $ codiac asset volume del
  $ codiac asset vol del
  $ codiac asset volumes del

EXAMPLES
  Select and delete a volume mount interactively.

    $ codiac asset vol delete

  Delete a named volume mount.

    $ codiac asset vol delete -e myEnterprise -n myMount --silent

  Renders the equivalent silent command without executing.

    $ codiac asset vol delete -e myEnterprise -n myMount --to-script

codiac asset vol list​

Renders the currently declared mount paths for the asset.

USAGE
  $ codiac asset vol list [-h] [-e <value>] [-a <value>] [-n <value>] [-p <value>] [-o pretty|json|yaml|auto]
    [--silent | --echo | --to-script]

FLAGS
  -a, --asset=<value>       The name of the asset whose volumes to list.
  -e, --enterprise=<value>  The name of the enterprise to which the asset belongs (required only if more than one
                            enterprise exists).
  -h, --help                Show CLI help.
  -n, --name=<value>        Filter volumes within the asset by mount name.
  -o, --output=<option>     [default: auto] Output format of the actual settings data document.
                            <options: pretty|json|yaml|auto>
  -p, --path=<value>        Filter volumes within the asset by mount path.
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Renders the currently declared mount paths for the asset.

ALIASES
  $ codiac asset vol list
  $ codiac asset volumes list

EXAMPLES
  List all volume mounts for the current asset.

    $ codiac asset vol list

  List volumes for a specific enterprise asset.

    $ codiac asset vol list -e myEnterprise

  Export as JSON.

    $ codiac asset vol list -o json

  Non-interactive (scripted) invocation.

    $ codiac asset vol list -e myEnterprise --silent

codiac asset volume add [MOUNTPATH]​

Declares a named path for mounting a volume to instances of the asset.

USAGE
  $ codiac asset volume add [MOUNTPATH] [-h] [-e <value>] [-a <value>] [-n <value>] [-d <value>] [--silent | --echo |
    --to-script]

ARGUMENTS
  MOUNTPATH  Fully qualified mounting path, inside the container, of the folder being mapped as a volume.  Must be
             unique for the asset.

FLAGS
  -a, --asset=<value>        The name of the asset to which this volume is being applied.
  -d, --description=<value>  Any notes or other information to help clarify the intended purpose of this folder, to
                             assist during the configuration phase when assigning an actual physical file store to it.
  -e, --enterprise=<value>   The name of the enterprise to which the asset belongs.
  -h, --help                 Show CLI help.
  -n, --name=<value>         Moniker for identifying, retrieving, and accessing this folder mapping.  Must be unique for
                             the asset.
  --echo                     Renders the equivalent non-interactive command for future use before executing.
  --silent                   Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Declares a named path for mounting a volume to instances of the asset.

ALIASES
  $ codiac asset vol create
  $ codiac asset vol add
  $ codiac asset volume add

codiac asset volume create [MOUNTPATH]​

Declares a named path for mounting a volume to instances of the asset.

USAGE
  $ codiac asset volume create [MOUNTPATH] [-h] [-e <value>] [-a <value>] [-n <value>] [-d <value>] [--silent | --echo |
    --to-script]

ARGUMENTS
  MOUNTPATH  Fully qualified mounting path, inside the container, of the folder being mapped as a volume.  Must be
             unique for the asset.

FLAGS
  -a, --asset=<value>        The name of the asset to which this volume is being applied.
  -d, --description=<value>  Any notes or other information to help clarify the intended purpose of this folder, to
                             assist during the configuration phase when assigning an actual physical file store to it.
  -e, --enterprise=<value>   The name of the enterprise to which the asset belongs.
  -h, --help                 Show CLI help.
  -n, --name=<value>         Moniker for identifying, retrieving, and accessing this folder mapping.  Must be unique for
                             the asset.
  --echo                     Renders the equivalent non-interactive command for future use before executing.
  --silent                   Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Declares a named path for mounting a volume to instances of the asset.

ALIASES
  $ codiac asset vol create
  $ codiac asset vol add
  $ codiac asset volume add

See code: dist/commands/asset/volume/create.ts

codiac asset volume del​

Deletes an existing volume mount in the asset.

USAGE
  $ codiac asset volume del [-h] [-n <value>] [-a <value>] [-e <value>] [--silent | --echo | --to-script]

FLAGS
  -a, --asset=<value>       The name of the asset from which to delete the volume mount.
  -e, --enterprise=<value>  The name of the enterprise to which the asset belongs (required only if more than one
                            enterprise exists).
  -h, --help                Show CLI help.
  -n, --name=<value>        Moniker for identifying, retrieving, and accessing the folder mapping to delete. Must be
                            unique for the asset.
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Deletes an existing volume mount in the asset.

ALIASES
  $ codiac asset vol delete
  $ codiac asset volumes delete
  $ codiac asset volume del
  $ codiac asset vol del
  $ codiac asset volumes del

EXAMPLES
  Select and delete a volume mount interactively.

    $ codiac asset volume del

  Delete a named volume mount.

    $ codiac asset volume del -e myEnterprise -n myMount --silent

  Renders the equivalent silent command without executing.

    $ codiac asset volume del -e myEnterprise -n myMount --to-script

codiac asset volume delete​

Deletes an existing volume mount in the asset.

USAGE
  $ codiac asset volume delete [-h] [-n <value>] [-a <value>] [-e <value>] [--silent | --echo | --to-script]

FLAGS
  -a, --asset=<value>       The name of the asset from which to delete the volume mount.
  -e, --enterprise=<value>  The name of the enterprise to which the asset belongs (required only if more than one
                            enterprise exists).
  -h, --help                Show CLI help.
  -n, --name=<value>        Moniker for identifying, retrieving, and accessing the folder mapping to delete. Must be
                            unique for the asset.
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Deletes an existing volume mount in the asset.

ALIASES
  $ codiac asset vol delete
  $ codiac asset volumes delete
  $ codiac asset volume del
  $ codiac asset vol del
  $ codiac asset volumes del

EXAMPLES
  Select and delete a volume mount interactively.

    $ codiac asset volume delete

  Delete a named volume mount.

    $ codiac asset volume delete -e myEnterprise -n myMount --silent

  Renders the equivalent silent command without executing.

    $ codiac asset volume delete -e myEnterprise -n myMount --to-script

See code: dist/commands/asset/volume/delete.ts

codiac asset volume list​

Renders the currently declared mount paths for the asset.

USAGE
  $ codiac asset volume list [-h] [-e <value>] [-a <value>] [-n <value>] [-p <value>] [-o pretty|json|yaml|auto]
    [--silent | --echo | --to-script]

FLAGS
  -a, --asset=<value>       The name of the asset whose volumes to list.
  -e, --enterprise=<value>  The name of the enterprise to which the asset belongs (required only if more than one
                            enterprise exists).
  -h, --help                Show CLI help.
  -n, --name=<value>        Filter volumes within the asset by mount name.
  -o, --output=<option>     [default: auto] Output format of the actual settings data document.
                            <options: pretty|json|yaml|auto>
  -p, --path=<value>        Filter volumes within the asset by mount path.
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Renders the currently declared mount paths for the asset.

ALIASES
  $ codiac asset vol list
  $ codiac asset volumes list

EXAMPLES
  List all volume mounts for the current asset.

    $ codiac asset volume list

  List volumes for a specific enterprise asset.

    $ codiac asset volume list -e myEnterprise

  Export as JSON.

    $ codiac asset volume list -o json

  Non-interactive (scripted) invocation.

    $ codiac asset volume list -e myEnterprise --silent

See code: dist/commands/asset/volume/list.ts

codiac asset volumes del​

Deletes an existing volume mount in the asset.

USAGE
  $ codiac asset volumes del [-h] [-n <value>] [-a <value>] [-e <value>] [--silent | --echo | --to-script]

FLAGS
  -a, --asset=<value>       The name of the asset from which to delete the volume mount.
  -e, --enterprise=<value>  The name of the enterprise to which the asset belongs (required only if more than one
                            enterprise exists).
  -h, --help                Show CLI help.
  -n, --name=<value>        Moniker for identifying, retrieving, and accessing the folder mapping to delete. Must be
                            unique for the asset.
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Deletes an existing volume mount in the asset.

ALIASES
  $ codiac asset vol delete
  $ codiac asset volumes delete
  $ codiac asset volume del
  $ codiac asset vol del
  $ codiac asset volumes del

EXAMPLES
  Select and delete a volume mount interactively.

    $ codiac asset volumes del

  Delete a named volume mount.

    $ codiac asset volumes del -e myEnterprise -n myMount --silent

  Renders the equivalent silent command without executing.

    $ codiac asset volumes del -e myEnterprise -n myMount --to-script

codiac asset volumes delete​

Deletes an existing volume mount in the asset.

USAGE
  $ codiac asset volumes delete [-h] [-n <value>] [-a <value>] [-e <value>] [--silent | --echo | --to-script]

FLAGS
  -a, --asset=<value>       The name of the asset from which to delete the volume mount.
  -e, --enterprise=<value>  The name of the enterprise to which the asset belongs (required only if more than one
                            enterprise exists).
  -h, --help                Show CLI help.
  -n, --name=<value>        Moniker for identifying, retrieving, and accessing the folder mapping to delete. Must be
                            unique for the asset.
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Deletes an existing volume mount in the asset.

ALIASES
  $ codiac asset vol delete
  $ codiac asset volumes delete
  $ codiac asset volume del
  $ codiac asset vol del
  $ codiac asset volumes del

EXAMPLES
  Select and delete a volume mount interactively.

    $ codiac asset volumes delete

  Delete a named volume mount.

    $ codiac asset volumes delete -e myEnterprise -n myMount --silent

  Renders the equivalent silent command without executing.

    $ codiac asset volumes delete -e myEnterprise -n myMount --to-script

codiac asset volumes list​

Renders the currently declared mount paths for the asset.

USAGE
  $ codiac asset volumes list [-h] [-e <value>] [-a <value>] [-n <value>] [-p <value>] [-o pretty|json|yaml|auto]
    [--silent | --echo | --to-script]

FLAGS
  -a, --asset=<value>       The name of the asset whose volumes to list.
  -e, --enterprise=<value>  The name of the enterprise to which the asset belongs (required only if more than one
                            enterprise exists).
  -h, --help                Show CLI help.
  -n, --name=<value>        Filter volumes within the asset by mount name.
  -o, --output=<option>     [default: auto] Output format of the actual settings data document.
                            <options: pretty|json|yaml|auto>
  -p, --path=<value>        Filter volumes within the asset by mount path.
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Renders the currently declared mount paths for the asset.

ALIASES
  $ codiac asset vol list
  $ codiac asset volumes list

EXAMPLES
  List all volume mounts for the current asset.

    $ codiac asset volumes list

  List volumes for a specific enterprise asset.

    $ codiac asset volumes list -e myEnterprise

  Export as JSON.

    $ codiac asset volumes list -o json

  Non-interactive (scripted) invocation.

    $ codiac asset volumes list -e myEnterprise --silent

codiac asset where​

Shows the cabinets to which the given asset is currently deployed and which version is where.

USAGE
  $ codiac asset where [-e <value>] [--echo | --to-script | [--silent -a <value>]]

FLAGS
  -a, --asset=<value>       The name of the asset to show.
  -e, --enterprise=<value>  The name of the enterprise containing this asset. Required if there are more than one.
                            (defaults to the current enterprise context)
  --echo                    Echo interaction mode; renders the equivalent non-interactive cli command for future use
                            before final execution.
  --silent                  Non-Interactive mode; executes without any user interaction and fails on any missing or
                            invalid arguments.
  --to-script               Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                            execution.

DESCRIPTION
  Shows the cabinets to which the given asset is currently deployed and which version is where.

EXAMPLES
  $ codiac asset where

  $ codiac asset where -a my-api

  $ codiac asset where -e main -a my-api

  $ codiac asset where -e main -a my-api --silent

See code: dist/commands/asset/where.ts

codiac auth cab allow​

Sets permissions for a security Role on the given cabinet entity. (NOT additive: this command overwrites any existing permissions set for this role on the entity).

USAGE
  $ codiac auth cab allow -p modify|read|none [--enterprise <value>] [-e <value>] [-c <value>] [-r <value>]
    [--take-defaults | [--silent | --echo | --to-script]]

FLAGS
  -c, --cabinet=<value>
      Name of the cabinet being protected. Required in silent mode.

  -e, --environment=<value>
      Name of the environment that contains the cabinet. Required in silent mode.

  -p, --privilege=<option>
      (required) The permission to assign to the Role. ("modify" infers permission to create, read, update, and delete.
      "none" removes any permissions set for the role)
      <options: modify|read|none>

  -r, --role=<value>
      Name of the Role being assigned. Required in silent mode.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --enterprise=<value>
      Name of the enterprise in which the cabinet resides. (Required only if more than one exists).

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Sets permissions for a security Role on the given cabinet entity. (NOT additive: this command overwrites any existing
  permissions set for this role on the entity).

ALIASES
  $ codiac auth cab allow

EXAMPLES
  $ codiac auth cab allow --enteprise main --environment dev --cabinet myspike --role developer --privilege modify

  $ codiac auth cab allow -e prod -c green -r developer -p none

  $ codiac auth cab allow -e qa -c shasta -r productmanager -p read

codiac auth cab allowed​

Shows permissions for each security role on the given cabinet entity.

USAGE
  $ codiac auth cab allowed [--enterprise <value>] [-e <value>] [-c <value>] [--take-defaults | [--silent | --echo |
    --to-script]]

FLAGS
  -c, --cabinet=<value>
      Name of the cabinet to view. Required in silent mode.

  -e, --environment=<value>
      Name of the Environment containing the cabinet. Required in silent mode.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --enterprise=<value>
      Name of the Enterprise containing the cabinet. (Required only if more than one exists).

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Shows permissions for each security role on the given cabinet entity.

ALIASES
  $ codiac auth cab allowed

EXAMPLES
  $ codiac auth cab allowed -e dev -c spike2

  $ codiac auth cab allowed --enterprise modeling -e qa -c sprint5

codiac auth cabinet allow​

Sets permissions for a security Role on the given cabinet entity. (NOT additive: this command overwrites any existing permissions set for this role on the entity).

USAGE
  $ codiac auth cabinet allow -p modify|read|none [--enterprise <value>] [-e <value>] [-c <value>] [-r <value>]
    [--take-defaults | [--silent | --echo | --to-script]]

FLAGS
  -c, --cabinet=<value>
      Name of the cabinet being protected. Required in silent mode.

  -e, --environment=<value>
      Name of the environment that contains the cabinet. Required in silent mode.

  -p, --privilege=<option>
      (required) The permission to assign to the Role. ("modify" infers permission to create, read, update, and delete.
      "none" removes any permissions set for the role)
      <options: modify|read|none>

  -r, --role=<value>
      Name of the Role being assigned. Required in silent mode.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --enterprise=<value>
      Name of the enterprise in which the cabinet resides. (Required only if more than one exists).

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Sets permissions for a security Role on the given cabinet entity. (NOT additive: this command overwrites any existing
  permissions set for this role on the entity).

ALIASES
  $ codiac auth cab allow

EXAMPLES
  $ codiac auth cabinet allow --enteprise main --environment dev --cabinet myspike --role developer --privilege modify

  $ codiac auth cabinet allow -e prod -c green -r developer -p none

  $ codiac auth cabinet allow -e qa -c shasta -r productmanager -p read

See code: dist/commands/auth/cabinet/allow.ts

codiac auth cabinet allowed​

Shows permissions for each security role on the given cabinet entity.

USAGE
  $ codiac auth cabinet allowed [--enterprise <value>] [-e <value>] [-c <value>] [--take-defaults | [--silent | --echo |
    --to-script]]

FLAGS
  -c, --cabinet=<value>
      Name of the cabinet to view. Required in silent mode.

  -e, --environment=<value>
      Name of the Environment containing the cabinet. Required in silent mode.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --enterprise=<value>
      Name of the Enterprise containing the cabinet. (Required only if more than one exists).

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Shows permissions for each security role on the given cabinet entity.

ALIASES
  $ codiac auth cab allowed

EXAMPLES
  $ codiac auth cabinet allowed -e dev -c spike2

  $ codiac auth cabinet allowed --enterprise modeling -e qa -c sprint5

See code: dist/commands/auth/cabinet/allowed.ts

codiac auth ent allow​

Sets permissions for a security Role on the given enterprise entity. (NOT additive: this command overwrites any existing permissions set for this role on the entity).

USAGE
  $ codiac auth ent allow -p modify|read|none [-e <value>] [-r <value>] [--take-defaults | [--silent | --echo |
    --to-script]]

FLAGS
  -e, --enterprise=<value>
      Name of the Enterprise being protected. Required in silent mode.

  -p, --privilege=<option>
      (required) The permission to assign to the Role. ("modify" infers permission to create, read, update, and delete.
      "none" removes any permissions set for the role)
      <options: modify|read|none>

  -r, --role=<value>
      Name of the Role being assigned. Required in silent mode.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Sets permissions for a security Role on the given enterprise entity. (NOT additive: this command overwrites any
  existing permissions set for this role on the entity).

ALIASES
  $ codiac auth ent allow

EXAMPLES
  $ codiac auth ent allow -r deployer -p modify

  $ codiac auth ent allow -r deployer -p none

codiac auth ent allow onenvs​

Sets permissions for a security Role to be applied to any new environments created within the given enterprise. Only modifies default permissions on FUTURE for new environments; DOES NOT modify permissions on any existing environments. (NOT additive: this command overwrites any existing new-environment permissions set for this role).

USAGE
  $ codiac auth ent allow onenvs -p modify|read|none [--enterprise <value>] [-r <value>] [--take-defaults | [--silent |
    --echo | --to-script]]

FLAGS
  -p, --privilege=<option>
      (required) The permission to assign to the Role. ("modify" infers permission to create, read, update, and delete.
      "none" removes any permissions set for the role)
      <options: modify|read|none>

  -r, --role=<value>
      Name of the Role being assigned. Required in silent mode.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --enterprise=<value>
      Name of the Enterprise containing the environemnt. (Required only if more than one exists).

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Sets permissions for a security Role to be applied to any new environments created within the given enterprise.  Only
  modifies default permissions on FUTURE for new environments; DOES NOT modify permissions on any existing environments.
  (NOT additive: this command overwrites any existing new-environment permissions set for this role).

ALIASES
  $ codiac auth ent allow onenvs

EXAMPLES
  $ codiac auth ent allow onenvs --enterprise main --role developer --privilege modify

  $ codiac auth ent allow onenvs -r developer -p none

  $ codiac auth ent allow onenvs --enterprise dyno -r productmanager -p read

codiac auth ent allowed​

Shows permissions for each security role on the given enterprise entity.

USAGE
  $ codiac auth ent allowed [-e <value>] [--take-defaults | [--silent | --echo | --to-script]]

FLAGS
  -e, --enterprise=<value>
      Name of the Enterprise to view. Required in silent mode.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Shows permissions for each security role on the given enterprise entity.

ALIASES
  $ codiac auth ent allowed

EXAMPLES
  $ codiac auth ent allowed

  $ codiac auth ent allowed --enterprise modeling

codiac auth enterprise allow​

Sets permissions for a security Role on the given enterprise entity. (NOT additive: this command overwrites any existing permissions set for this role on the entity).

USAGE
  $ codiac auth enterprise allow -p modify|read|none [-e <value>] [-r <value>] [--take-defaults | [--silent | --echo |
    --to-script]]

FLAGS
  -e, --enterprise=<value>
      Name of the Enterprise being protected. Required in silent mode.

  -p, --privilege=<option>
      (required) The permission to assign to the Role. ("modify" infers permission to create, read, update, and delete.
      "none" removes any permissions set for the role)
      <options: modify|read|none>

  -r, --role=<value>
      Name of the Role being assigned. Required in silent mode.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Sets permissions for a security Role on the given enterprise entity. (NOT additive: this command overwrites any
  existing permissions set for this role on the entity).

ALIASES
  $ codiac auth ent allow

EXAMPLES
  $ codiac auth enterprise allow -r deployer -p modify

  $ codiac auth enterprise allow -r deployer -p none

See code: dist/commands/auth/enterprise/allow.ts

codiac auth enterprise allow onEnvironments​

Sets permissions for a security Role to be applied to any new environments created within the given enterprise. Only modifies default permissions on FUTURE for new environments; DOES NOT modify permissions on any existing environments. (NOT additive: this command overwrites any existing new-environment permissions set for this role).

USAGE
  $ codiac auth enterprise allow onEnvironments -p modify|read|none [--enterprise <value>] [-r <value>] [--take-defaults | [--silent |
    --echo | --to-script]]

FLAGS
  -p, --privilege=<option>
      (required) The permission to assign to the Role. ("modify" infers permission to create, read, update, and delete.
      "none" removes any permissions set for the role)
      <options: modify|read|none>

  -r, --role=<value>
      Name of the Role being assigned. Required in silent mode.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --enterprise=<value>
      Name of the Enterprise containing the environemnt. (Required only if more than one exists).

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Sets permissions for a security Role to be applied to any new environments created within the given enterprise.  Only
  modifies default permissions on FUTURE for new environments; DOES NOT modify permissions on any existing environments.
  (NOT additive: this command overwrites any existing new-environment permissions set for this role).

ALIASES
  $ codiac auth ent allow onenvs

EXAMPLES
  $ codiac auth enterprise allow onEnvironments --enterprise main --role developer --privilege modify

  $ codiac auth enterprise allow onEnvironments -r developer -p none

  $ codiac auth enterprise allow onEnvironments --enterprise dyno -r productmanager -p read

See code: dist/commands/auth/enterprise/allow/onEnvironments.ts

codiac auth enterprise allowed​

Shows permissions for each security role on the given enterprise entity.

USAGE
  $ codiac auth enterprise allowed [-e <value>] [--take-defaults | [--silent | --echo | --to-script]]

FLAGS
  -e, --enterprise=<value>
      Name of the Enterprise to view. Required in silent mode.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Shows permissions for each security role on the given enterprise entity.

ALIASES
  $ codiac auth ent allowed

EXAMPLES
  $ codiac auth enterprise allowed

  $ codiac auth enterprise allowed --enterprise modeling

See code: dist/commands/auth/enterprise/allowed.ts

codiac auth env allowed​

Shows permissions for each security role on the given environment entity.

USAGE
  $ codiac auth env allowed [--enterprise <value>] [-e <value>] [--take-defaults | [--silent | --echo | --to-script]]

FLAGS
  -e, --environment=<value>
      Name of the Environment to view. Required in silent mode.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --enterprise=<value>
      Name of the Enterprise containing the environment. (Required only if more than one exists).

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Shows permissions for each security role on the given environment entity.

ALIASES
  $ codiac auth env allowed

EXAMPLES
  $ codiac auth env allowed -e dev

  $ codiac auth env allowed --enterprise modeling -e dev

codiac auth enviro allow​

Sets permissions for a security Role on the given environment entity. (NOT additive: this command overwrites any existing permissions set for this role on the entity).

USAGE
  $ codiac auth enviro allow -p modify|read|none [--enterprise <value>] [-e <value>] [-r <value>] [--take-defaults |
    [--silent | --echo | --to-script]]

FLAGS
  -e, --environment=<value>
      Name of the Environment being protected. Required in silent mode.

  -p, --privilege=<option>
      (required) The permission to assign to the Role. ("modify" infers permission to create, read, update, and delete.
      "none" removes any permissions set for the role)
      <options: modify|read|none>

  -r, --role=<value>
      Name of the Role being assigned. Required in silent mode.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --enterprise=<value>
      Name of the Enterprise containing the environemnt. (Required only if more than one exists).

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Sets permissions for a security Role on the given environment entity. (NOT additive: this command overwrites any
  existing permissions set for this role on the entity).

ALIASES
  $ codiac auth enviro allow

EXAMPLES
  $ codiac auth enviro allow --enteprise main --environment dev --role developer --privilege modify

  $ codiac auth enviro allow -e prod -r developer -p none

  $ codiac auth enviro allow -e qa -r productmanager -p read

codiac auth enviro allow oncabs​

Sets permissions for a security Role to be applied to any new cabinets created within the given environment. Only modifies default permissions on FUTURE for new cabinets; DOES NOT modify permissions on any existing cabinets. (NOT additive: this command overwrites any existing new-cabinet permissions set for this role).

USAGE
  $ codiac auth enviro allow oncabs -p modify|read|none [--enterprise <value>] [-e <value>] [-r <value>] [--take-defaults |
    [--silent | --echo | --to-script]]

FLAGS
  -e, --environment=<value>
      Name of the Environment whose new cabinets are to be protected. Required in silent mode.

  -p, --privilege=<option>
      (required) The permission to assign to the Role. ("modify" infers permission to create, read, update, and delete.
      "none" removes any permissions set for the role)
      <options: modify|read|none>

  -r, --role=<value>
      Name of the Role being assigned. Required in silent mode.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --enterprise=<value>
      Name of the Enterprise containing the environemnt. (Required only if more than one exists).

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Sets permissions for a security Role to be applied to any new cabinets created within the given environment.  Only
  modifies default permissions on FUTURE for new cabinets; DOES NOT modify permissions on any existing cabinets. (NOT
  additive: this command overwrites any existing new-cabinet permissions set for this role).

ALIASES
  $ codiac auth enviro allow oncabs

EXAMPLES
  $ codiac auth enviro allow oncabs --enterprise main --environment dev --role developer --privilege modify

  $ codiac auth enviro allow oncabs -e prod -r developer -p none

  $ codiac auth enviro allow oncabs -e qa -r productmanager -p read

codiac auth environment allow​

Sets permissions for a security Role on the given environment entity. (NOT additive: this command overwrites any existing permissions set for this role on the entity).

USAGE
  $ codiac auth environment allow -p modify|read|none [--enterprise <value>] [-e <value>] [-r <value>] [--take-defaults |
    [--silent | --echo | --to-script]]

FLAGS
  -e, --environment=<value>
      Name of the Environment being protected. Required in silent mode.

  -p, --privilege=<option>
      (required) The permission to assign to the Role. ("modify" infers permission to create, read, update, and delete.
      "none" removes any permissions set for the role)
      <options: modify|read|none>

  -r, --role=<value>
      Name of the Role being assigned. Required in silent mode.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --enterprise=<value>
      Name of the Enterprise containing the environemnt. (Required only if more than one exists).

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Sets permissions for a security Role on the given environment entity. (NOT additive: this command overwrites any
  existing permissions set for this role on the entity).

ALIASES
  $ codiac auth enviro allow

EXAMPLES
  $ codiac auth environment allow --enteprise main --environment dev --role developer --privilege modify

  $ codiac auth environment allow -e prod -r developer -p none

  $ codiac auth environment allow -e qa -r productmanager -p read

See code: dist/commands/auth/environment/allow.ts

codiac auth environment allow onCabinets​

Sets permissions for a security Role to be applied to any new cabinets created within the given environment. Only modifies default permissions on FUTURE for new cabinets; DOES NOT modify permissions on any existing cabinets. (NOT additive: this command overwrites any existing new-cabinet permissions set for this role).

USAGE
  $ codiac auth environment allow onCabinets -p modify|read|none [--enterprise <value>] [-e <value>] [-r <value>] [--take-defaults |
    [--silent | --echo | --to-script]]

FLAGS
  -e, --environment=<value>
      Name of the Environment whose new cabinets are to be protected. Required in silent mode.

  -p, --privilege=<option>
      (required) The permission to assign to the Role. ("modify" infers permission to create, read, update, and delete.
      "none" removes any permissions set for the role)
      <options: modify|read|none>

  -r, --role=<value>
      Name of the Role being assigned. Required in silent mode.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --enterprise=<value>
      Name of the Enterprise containing the environemnt. (Required only if more than one exists).

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Sets permissions for a security Role to be applied to any new cabinets created within the given environment.  Only
  modifies default permissions on FUTURE for new cabinets; DOES NOT modify permissions on any existing cabinets. (NOT
  additive: this command overwrites any existing new-cabinet permissions set for this role).

ALIASES
  $ codiac auth enviro allow oncabs

EXAMPLES
  $ codiac auth environment allow onCabinets --enterprise main --environment dev --role developer --privilege modify

  $ codiac auth environment allow onCabinets -e prod -r developer -p none

  $ codiac auth environment allow onCabinets -e qa -r productmanager -p read

See code: dist/commands/auth/environment/allow/onCabinets.ts

codiac auth environment allowed​

Shows permissions for each security role on the given environment entity.

USAGE
  $ codiac auth environment allowed [--enterprise <value>] [-e <value>] [--take-defaults | [--silent | --echo |
  --to-script]]

FLAGS
  -e, --environment=<value>
      Name of the Environment to view. Required in silent mode.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --enterprise=<value>
      Name of the Enterprise containing the environment. (Required only if more than one exists).

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Shows permissions for each security role on the given environment entity.

ALIASES
  $ codiac auth env allowed

EXAMPLES
  $ codiac auth environment allowed -e dev

  $ codiac auth environment allowed --enterprise modeling -e dev

See code: dist/commands/auth/environment/allowed.ts

codiac auth register​

Create your own user account.

USAGE
  $ codiac auth register [-u <value>] [-p <value> | -i] [-c <value>] [--companyCode <value>] [-f <value>] [-l
    <value>] [--take-defaults | [--silent | --echo | --to-script]]

FLAGS
  -c, --company=<value>    Human readable friendly title for the organization (eg: 'ACME Anvils, Inc.').  NOT used for
                           system identification.  NOTE: Users can belong to more than one organization; this one shall
                           simply be the first for this user.
  -f, --firstName=<value>  (optional; you can edit this later)
  -i, --passwordIn         Reads the password directly from the standard input stream.  Enables users to avoid
                           explicitly rendering it in a command string. eg:  `cat mypass.txt | cod register -u joecool
                           --passwordIn`.  Invokes `--silent` mode, so interaction will be disabled.
  -l, --lastName=<value>   (optional; you can edit this later)
  -p, --password=<value>   password on Codiac in clear text.  NOT RECOMMENDED: use the `passwordIn` argument instead to
                           transmit your password via stdin.
  -u, --email=<value>      Must be a valid email. This will be your login/username on Codiac.
  --companyCode=<value>    (optional) Unique identifier for the organization within Codiac (eg: 'acme').  This value IS
                           used for system identification, and must be unique across all of Codiac.  This command will
                           fail if this given company code is already taken (Must be 3 to 9 alphanumeric characters, no
                           spaces or special characters).
  --echo                   Echo interaction mode; renders the equivalent non-interactive cli command for future use
                           before final execution.
  --silent                 Non-Interactive mode; executes without any user interaction and fails on any missing or
                           invalid arguments.
  --take-defaults          Setting this to true prevents prompting for confirmation on parameters that were passed in or
                           were automatically set to default values (Irrelevant in --silent mode).  This behavior does
                           NOT apply to scenarios that the command needs to override invalid user input; such cases will
                           always prompt for confirmation.  eg: when no argument was provided for file or type, and only
                           one exists, the system will render the autoselected file unless this flag is set.
  --to-script              Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                           execution.

DESCRIPTION
  Create your own user account.

EXAMPLES
  $ codiac auth register

See code: dist/commands/auth/register.ts

codiac auth role allowed [NAME]​

Renders the privileges granted to an existing Role on each enterprise, environment, and cabinet.

USAGE
  $ codiac auth role allowed [NAME] [--id <value> | ] [-e <value>] [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  NAME  Name of the Role.

FLAGS
  -e, --enterprise=<value>
      (required only if there are more than one) Name of the Enterprise in which to view the entities to which the role
      has access.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --id=<value>
      System ID of the Role.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Renders the privileges granted to an existing Role on each enterprise, environment, and cabinet.

EXAMPLES
  $ codiac auth role allowed -n deployer

  $ codiac auth role allowed --id abc123def456

  $ codiac auth role allowed -n deployer -e main

See code: dist/commands/auth/role/allowed.ts

codiac auth role assign​

Applies a Role to a user or group within the current tenant security context.

USAGE
  $ codiac auth role assign [-r <value>] [-u <value>] [--take-defaults | [--silent | --echo | --to-script]]

FLAGS
  -r, --role=<value>  Name of the Role being assigned. Required in silent mode.
  -u, --user=<value>  Username getting the role assignment. Required in silent mode.
  --echo              Echo interaction mode; renders the equivalent non-interactive cli command for future use before
                      final execution.
  --silent            Non-Interactive mode; executes without any user interaction and fails on any missing or invalid
                      arguments.
  --take-defaults     Setting this to true prevents prompting for confirmation on parameters that were passed in or were
                      automatically set to default values (Irrelevant in --silent mode).  This behavior does NOT apply
                      to scenarios that the command needs to override invalid user input; such cases will always prompt
                      for confirmation.  eg: when no argument was provided for file or type, and only one exists, the
                      system will render the autoselected file unless this flag is set.
  --to-script         Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                      execution.

DESCRIPTION
  Applies a Role to a user or group within the current tenant security context.

EXAMPLES
  $ codiac auth role assign -r deployer -u joe.cool@yourdomain.com

See code: dist/commands/auth/role/assign.ts

codiac auth role create [NAME]​

Adds a new Role to the current tenant security context. It is the Role object to which various types of access are granted, and a user or group is given rights by assigning them one or more roles.

USAGE
  $ codiac auth role create [NAME] [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  NAME  Name to give the new role.

FLAGS
  --echo           Echo interaction mode; renders the equivalent non-interactive cli command for future use before final
                   execution.
  --silent         Non-Interactive mode; executes without any user interaction and fails on any missing or invalid
                   arguments.
  --take-defaults  Setting this to true prevents prompting for confirmation on parameters that were passed in or were
                   automatically set to default values (Irrelevant in --silent mode).  This behavior does NOT apply to
                   scenarios that the command needs to override invalid user input; such cases will always prompt for
                   confirmation.  eg: when no argument was provided for file or type, and only one exists, the system
                   will render the autoselected file unless this flag is set.
  --to-script      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Adds a new Role to the current tenant security context.  It is the Role object to which various types of access are
  granted, and a user or group is given rights by assigning them one or more roles.

EXAMPLES
  $ codiac auth role create -n deployer

See code: dist/commands/auth/role/create.ts

codiac auth role delete [NAME]​

Deletes an existing Role from the current tenant security context. A role cannot be deleted if it is still assigned to an existing user or group.

USAGE
  $ codiac auth role delete [NAME] [--id <value> | ] [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  NAME  Name of the Role.

FLAGS
  --echo           Echo interaction mode; renders the equivalent non-interactive cli command for future use before final
                   execution.
  --id=<value>     System ID of the Role.
  --silent         Non-Interactive mode; executes without any user interaction and fails on any missing or invalid
                   arguments.
  --take-defaults  Setting this to true prevents prompting for confirmation on parameters that were passed in or were
                   automatically set to default values (Irrelevant in --silent mode).  This behavior does NOT apply to
                   scenarios that the command needs to override invalid user input; such cases will always prompt for
                   confirmation.  eg: when no argument was provided for file or type, and only one exists, the system
                   will render the autoselected file unless this flag is set.
  --to-script      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Deletes an existing Role from the current tenant security context.  A role cannot be deleted if it is still assigned
  to an existing user or group.

EXAMPLES
  $ codiac auth role delete -n deployer

  $ codiac auth role delete --id abc123def456

See code: dist/commands/auth/role/delete.ts

codiac auth role list​

Retrieves the existing Roles within the current tenant security context.

USAGE
  $ codiac auth role list [-o json|yaml|text] [--take-defaults | [--silent | --echo | --to-script]]

FLAGS
  -o, --output=<option>  [default: text] format in which to render the data.
                         <options: json|yaml|text>
  --echo                 Echo interaction mode; renders the equivalent non-interactive cli command for future use before
                         final execution.
  --silent               Non-Interactive mode; executes without any user interaction and fails on any missing or invalid
                         arguments.
  --take-defaults        Setting this to true prevents prompting for confirmation on parameters that were passed in or
                         were automatically set to default values (Irrelevant in --silent mode).  This behavior does NOT
                         apply to scenarios that the command needs to override invalid user input; such cases will
                         always prompt for confirmation.  eg: when no argument was provided for file or type, and only
                         one exists, the system will render the autoselected file unless this flag is set.
  --to-script            Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                         execution.

DESCRIPTION
  Retrieves the existing Roles within the current tenant security context.

EXAMPLES
  $ codiac auth role list

  $ codiac auth role list -o json

  $ codiac auth role list -o yaml > roles.yaml

See code: dist/commands/auth/role/list.ts

codiac auth role unassign​

Removes a Role from a user or group within the current tenant security context.

USAGE
  $ codiac auth role unassign [-r <value>] [-u <value>] [--take-defaults | [--silent | --echo | --to-script]]

FLAGS
  -r, --role=<value>  Name of the Role being assigned. Required in silent mode.
  -u, --user=<value>  Username getting the role assignment. Required in silent mode.
  --echo              Echo interaction mode; renders the equivalent non-interactive cli command for future use before
                      final execution.
  --silent            Non-Interactive mode; executes without any user interaction and fails on any missing or invalid
                      arguments.
  --take-defaults     Setting this to true prevents prompting for confirmation on parameters that were passed in or were
                      automatically set to default values (Irrelevant in --silent mode).  This behavior does NOT apply
                      to scenarios that the command needs to override invalid user input; such cases will always prompt
                      for confirmation.  eg: when no argument was provided for file or type, and only one exists, the
                      system will render the autoselected file unless this flag is set.
  --to-script         Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                      execution.

DESCRIPTION
  Removes a Role from a user or group within the current tenant security context.

EXAMPLES
  $ codiac auth role unassign -r deployer -u joe.cool@yourdomain.com

See code: dist/commands/auth/role/unassign.ts

codiac auth user invite​

Adds a user to the current organization. Users must be invited to an organization (with the exception of the original creator of the organization, who gets automatically added as the administrator). NOTE: Users are designated by their email address and can be part of multiple organizations. If the the given email is not yet registered in Codiac, the an invite email will be sent prompting the user to register with Codiac and join the current organziation. NOTE: Use the cod auth register to join yourself.

USAGE
  $ codiac auth user invite [-e <value>] [-f <value>] [-l <value>] [-r <value>] [--take-defaults | [--silent | --echo
    | --to-script]]

FLAGS
  -e, --email=<value>      This will be the user's login/username on Codiac.
  -f, --firstName=<value>  (optional; you can edit this later)
  -l, --lastName=<value>   (optional; you can edit this later)
  -r, --role=<value>...    Each security role to assign to the user. Use this flag multiple times, once for each role to
                           assign.
  --echo                   Echo interaction mode; renders the equivalent non-interactive cli command for future use
                           before final execution.
  --silent                 Non-Interactive mode; executes without any user interaction and fails on any missing or
                           invalid arguments.
  --take-defaults          Setting this to true prevents prompting for confirmation on parameters that were passed in or
                           were automatically set to default values (Irrelevant in --silent mode).  This behavior does
                           NOT apply to scenarios that the command needs to override invalid user input; such cases will
                           always prompt for confirmation.  eg: when no argument was provided for file or type, and only
                           one exists, the system will render the autoselected file unless this flag is set.
  --to-script              Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                           execution.

DESCRIPTION
  Adds a user to the current organization. Users must be invited to an organization (*with the exception of the original
  creator of the organization, who gets automatically added as the administrator*).  NOTE: Users are designated by their
  email address and can be part of multiple organizations. If the the given email is not yet registered in Codiac, the
  an invite email will be sent prompting the user to register with Codiac and join the current organziation.  NOTE: Use
  the `cod auth register` to join yourself.

EXAMPLES
  $ codiac auth user invite

See code: dist/commands/auth/user/invite.ts

codiac auth user list​

Retrieves the existing users within the current tenant security context.

USAGE
  $ codiac auth user list [-o json|yaml|text] [--take-defaults | [--silent | --echo | --to-script]]

FLAGS
  -o, --output=<option>  [default: text] format in which to render the data.
                         <options: json|yaml|text>
  --echo                 Echo interaction mode; renders the equivalent non-interactive cli command for future use before
                         final execution.
  --silent               Non-Interactive mode; executes without any user interaction and fails on any missing or invalid
                         arguments.
  --take-defaults        Setting this to true prevents prompting for confirmation on parameters that were passed in or
                         were automatically set to default values (Irrelevant in --silent mode).  This behavior does NOT
                         apply to scenarios that the command needs to override invalid user input; such cases will
                         always prompt for confirmation.  eg: when no argument was provided for file or type, and only
                         one exists, the system will render the autoselected file unless this flag is set.
  --to-script            Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                         execution.

DESCRIPTION
  Retrieves the existing users within the current tenant security context.

EXAMPLES
  $ codiac auth user list

  $ codiac auth user list -o json

  $ codiac auth user list -o yaml > users.yaml

See code: dist/commands/auth/user/list.ts

codiac autocomplete [SHELL]​

display autocomplete installation instructions

USAGE
  $ codiac autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  shell type

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

DESCRIPTION
  display autocomplete installation instructions

EXAMPLES
  $ codiac autocomplete

  $ codiac autocomplete bash

  $ codiac autocomplete zsh

  $ codiac autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

codiac branch [NAME]​

Creates a new branch for the parent project and any sourced dependencies.

USAGE
  $ codiac branch [NAME] [-s] [-h]

ARGUMENTS
  NAME  The name of the branch to create.

FLAGS
  -h, --help    Show CLI help.
  -s, --switch  Automatically switches to the new branch after creating it.

DESCRIPTION
  Creates a new branch for the parent project and any sourced dependencies.

See code: dist/commands/branch.ts

codiac branch current​

Renders the name of the current branch (for the main project and for any sourced dependencies).

USAGE
  $ codiac branch current [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Renders the name of the current branch (for the main project and for any sourced dependencies).

ALIASES
  $ codiac branches current

See code: dist/commands/branch/current.ts

codiac branch list​

Lists out existing branches for the project repo.

USAGE
  $ codiac branch list [-h] [-r | -l]

FLAGS
  -h, --help     Displays the help document for this command.
  -l, --locals   (Optional, defaults to false) Limits to local branches only.
  -r, --remotes  (Optional, defaults to false) Limits to remote branches only.

DESCRIPTION
  Lists out existing branches for the project repo.

ALIASES
  $ codiac branches list

See code: dist/commands/branch/list.ts

codiac branches current​

Renders the name of the current branch (for the main project and for any sourced dependencies).

USAGE
  $ codiac branches current [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Renders the name of the current branch (for the main project and for any sourced dependencies).

ALIASES
  $ codiac branches current

codiac branches list​

Lists out existing branches for the project repo.

USAGE
  $ codiac branches list [-h] [-r | -l]

FLAGS
  -h, --help     Displays the help document for this command.
  -l, --locals   (Optional, defaults to false) Limits to local branches only.
  -r, --remotes  (Optional, defaults to false) Limits to remote branches only.

DESCRIPTION
  Lists out existing branches for the project repo.

ALIASES
  $ codiac branches list

codiac build​

Builds the project and the docker container

USAGE
  $ codiac build [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h] [-f <value>] [-n] [-d -b <value>] [--version <value>] [-M] [-m] [-p] [-r] [-i <value>]
    [-c] [-s images|packages] [-i <value>] [-t <value>]

FLAGS
  -M, --major                     Increments the version by one Major version number (using Major.Minor.Patch).
  -b, --buildDef=<value>          Replaces the default build command with the given process.  For a multi-command
                                  sequence, separate each with a Pipe (|) character.
  -c, --clear                     Completely deletes the output folder before building.
  -d, --asDefault                 Overwrites the default build command for the project with the buildDef argument
  -f, --frameworkVersion=<value>  (Future) Explicitly sets the version of the Toyhauler base image to use (default:
                                  latest).
  -h, --help                      Show CLI help.
  -i, --image=<value>...          (optional, defaults to all) Limits the list of images to build.  Value must match the
                                  name property of an image export defined in the codiac project file (codiac.json)
  -i, --preid=<value>             Sets the prereleaseId and resets the prerelease number (or increments it if the same
                                  preid is already set) (using Major.Minor.Patch-PreId.PreRelease).  NOTE:  Increments
                                  the Patch version number when appending.
  -m, --minor                     Increments the version by one Minor version number (using Major.Minor.Patch).
  -n, --noCache                   Ignores the local Docker image cache, thereby forcing a fresh download of each image
                                  from its container registry layer in the build.
  -p, --patch                     Increments the version by one Patch version number (using Major.Minor.Patch).
  -r, --prerelease                Increments the prerelease number (using Major.Minor.Patch-PreRelease).  NOTE:
                                  Increments the Patch version number when appending.
  -s, --skip=<option>             (optional) Prevents the building of any declared container images or packages.
                                  <options: images|packages>
  -t, --buildTarget=<value>       (optional) Calls out the only stage to be built for images defined with multistage
                                  builds.
  -v, --verbose                   Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>                    Fires this command with an argument list that was previously remembered using the
                                  --rememberAs flag.
  --remember                      Saves the arguments, so they are invoked as defaults whenever this command gets
                                  called.
  --rememberAs=<value>            Saves the given argument list so that it can be called by name.
  --unremember=<value>            Administrative only: DOES NOT fire the actual command.  Simply clears the arguments
                                  that were previously stored under the given name (use "--unRemember default" to clear
                                  default argument list memorized with the --remember flag).
  --version=<value>               Overwrites the full version for the build (using Major.Minor.Patch).
  --withoutdefaults               Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Builds the project and the docker container

See code: dist/commands/build.ts

codiac cab allow​

Sets permissions for a security Role on the given cabinet entity. (NOT additive: this command overwrites any existing permissions set for this role on the entity).

USAGE
  $ codiac cab allow -p modify|read|none [--enterprise <value>] [-e <value>] [-c <value>] [-r <value>]
    [--take-defaults | [--silent | --echo | --to-script]]

FLAGS
  -c, --cabinet=<value>
      Name of the cabinet being protected. Required in silent mode.

  -e, --environment=<value>
      Name of the environment that contains the cabinet. Required in silent mode.

  -p, --privilege=<option>
      (required) The permission to assign to the Role. ("modify" infers permission to create, read, update, and delete.
      "none" removes any permissions set for the role)
      <options: modify|read|none>

  -r, --role=<value>
      Name of the Role being assigned. Required in silent mode.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --enterprise=<value>
      Name of the enterprise in which the cabinet resides. (Required only if more than one exists).

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Sets permissions for a security Role on the given cabinet entity. (NOT additive: this command overwrites any existing
  permissions set for this role on the entity).

ALIASES
  $ codiac cab allow

EXAMPLES
  $ codiac cab allow --enteprise main --environment dev --cabinet myspike --role developer --privilege modify

  $ codiac cab allow -e prod -c green -r developer -p none

  $ codiac cab allow -e qa -c shasta -r productmanager -p read

codiac cab cluster attach​

Declares which cluster a cabinet is intended to run on. Records the association in Codiac metadata so that restore and deploy operations know where to target the cabinet. No infrastructure is created or modified.

USAGE
  $ codiac cab cluster attach [-e <value>] [-b <value>] [-n <value>] [-c <value>] [--take-defaults | [--silent | --echo
    | --to-script]]

FLAGS
  -b, --cabinet=<value>      Name of the cabinet to attach.
  -c, --cluster=<value>      Name of the cluster to attach the cabinet to.
  -e, --enterprise=<value>   The name of the enterprise in which the cabinet resides. NOTE: You can leave this blank if
                             there is only one.
  -n, --environment=<value>  Name of the environment the cabinet belongs to.
  --echo                     Echo interaction mode; renders the equivalent non-interactive cli command for future use
                             before final execution.
  --silent                   Non-Interactive mode; executes without any user interaction and fails on any missing or
                             invalid arguments.
  --take-defaults            Prevents prompting for confirmation on parameters that were passed in or were automatically
                             set to default values (Irrelevant in --silent mode).
  --to-script                Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                             execution.

DESCRIPTION
  Declares which cluster a cabinet is intended to run on. Records the association in Codiac metadata so that restore and
  deploy operations know where to target the cabinet. No infrastructure is created or modified.

ALIASES
  $ codiac cab cluster attach

EXAMPLES
  Attach a cabinet to a cluster interactively.

    $ codiac cab cluster attach

  Attach a specific cabinet to a cluster (prompts for missing values).

    $ codiac cab cluster attach --enterprise acme --cabinet api-gateway --environment prod --cluster prod-cluster-1

  Non-interactive (scripted) invocation — fails fast on any missing argument.

    $ codiac cab cluster attach --enterprise acme --cabinet api-gateway --environment prod --cluster prod-cluster-1 ^
      --silent

  Renders the equivalent silent command and then executes (useful for building scripts).

    $ codiac cab cluster attach --enterprise acme --cabinet api-gateway --environment prod --cluster prod-cluster-1 ^
      --echo

  Renders the equivalent silent command without executing (dry run).

    $ codiac cab cluster attach --enterprise acme --cabinet api-gateway --environment prod --cluster prod-cluster-1 ^
      --to-script

codiac cab contents​

Renders the list of asset versions that are currently deployed to the given cabinet.

USAGE
  $ codiac cab contents [-e <value>] [-c <value>] [--echo | --to-script | [--silent ]]

FLAGS
  -c, --cabinet=<value>     The name of the cabinet to inspect.
  -e, --enterprise=<value>  The name of the enterprise in which to create this asset. (defaults to the current
                            enterprise context)
  --echo                    Echo interaction mode; renders the equivalent non-interactive cli command for future use
                            before final execution.
  --silent                  Non-Interactive mode; executes without any user interaction and fails on any missing or
                            invalid arguments.
  --to-script               Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                            execution.

DESCRIPTION
  Renders the list of asset versions that are currently deployed to the given cabinet.

ALIASES
  $ codiac cab contents
  $ codiac cluster contents

EXAMPLES
  $ codiac cab contents

  $ codiac cab contents -c dev7

  $ codiac cab contents -e main -c my-spike

  use the `--silent` flag to run this command when there is no user at the console (ie: TTY, ie: in a pipeline)

    $ codiac cab contents -e main -c my-spike --silent

  Use the `--to-script` flag to create a script file that runs this command

    $ codiac cab contents -e main -c my-spike --to-script > show-contents.sh

codiac cab create [CABINET]​

Initializes a cabinet for a given enterprise and environment. Returns an error if the cabinet already exists.

USAGE
  $ codiac cab create [CABINET] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h] [--enterprise <value>] [-e <value>] [-c <value>] [--take-defaults | [--silent | --echo
    | --to-script]]

ARGUMENTS
  CABINET  The name of the cabinet to create

FLAGS
  -c, --cluster=<value>      (optional: defaults to the first cluster in the environment) The name of the cluster to use
                             for the cabinet.
  -e, --environment=<value>  (optional: defaults to that of the current project branch) The name of the environment this
                             cabinet will be grouped under.
  -h, --help                 Show CLI help.
  -v, --verbose              Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>               Fires this command with an argument list that was previously remembered using the
                             --rememberAs flag.
  --echo                     Echo interaction mode; renders the equivalent non-interactive cli command for future use
                             before final execution.
  --enterprise=<value>       (required only if more than one enterprise exists) The name of the enterprise under which
                             to create this cabinet.
  --remember                 Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>       Saves the given argument list so that it can be called by name.
  --silent                   Non-Interactive mode; executes without any user interaction and fails on any missing or
                             invalid arguments.
  --take-defaults            Setting this to true prevents prompting for confirmation on parameters that were passed in
                             or were automatically set to default values (Irrelevant in --silent mode).
  --to-script                Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                             execution.
  --unremember=<value>       Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                             were previously stored under the given name (use "--unRemember default" to clear default
                             argument list memorized with the --remember flag).
  --withoutdefaults          Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Initializes a cabinet for a given enterprise and environment. Returns an error if the cabinet already exists.

ALIASES
  $ codiac cab create
  $ codiac infrx cabinet create
  $ codiac infrx cab create

EXAMPLES
  Create a cabinet interatively.

    cod cabinet create

  Create a cabinet interatively and assemble a non-interactive command string.

    cod cabinet create --echo

  Assemble a non-interactive command string WITHOUT actually creating a cabinet (dry run).

    cod cabinet create --to-script

  Create a cabinet silently.

    cod cabinet create my-cab-name --enterprise main -e dev-environemt -c my-cluster --silent

codiac cab define [CABINET]​

Records the cabinet metadata without provisioning any k8s infrastructure. Use when the target cluster has no physical instance yet, or to stage a cabinet definition ahead of provisioning.

USAGE
  $ codiac cab define [CABINET] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h] [--enterprise <value>] [-e <value>] [-c <value>] [--take-defaults | [--silent | --echo
    | --to-script]]

ARGUMENTS
  CABINET  The name of the cabinet to define.

FLAGS
  -c, --cluster=<value>      The cluster to assign this cabinet to. Defaults to the only cluster in the environment when
                             there is exactly one.
  -e, --environment=<value>  The environment this cabinet belongs to.
  -h, --help                 Show CLI help.
  -v, --verbose              Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>               Fires this command with an argument list that was previously remembered using the
                             --rememberAs flag.
  --echo                     Renders the equivalent non-interactive command before executing.
  --enterprise=<value>       (required only if more than one enterprise exists) The enterprise under which to define the
                             cabinet.
  --remember                 Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>       Saves the given argument list so that it can be called by name.
  --silent                   Non-interactive mode; executes without prompts and fails on any missing or invalid
                             arguments.
  --take-defaults            Accepts default values without confirmation prompts (irrelevant in --silent mode).
  --to-script                Renders the equivalent non-interactive command without executing it.
  --unremember=<value>       Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                             were previously stored under the given name (use "--unRemember default" to clear default
                             argument list memorized with the --remember flag).
  --withoutdefaults          Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Records the cabinet metadata without provisioning any k8s infrastructure. Use when the target cluster has no physical
  instance yet, or to stage a cabinet definition ahead of provisioning.

ALIASES
  $ codiac cab define

EXAMPLES
  Define a cabinet interactively.

    $ codiac cab define

  Define a cabinet interactively and assemble a non-interactive command string.

    $ codiac cab define --echo

  Assemble a non-interactive command string without defining (dry run).

    $ codiac cab define --to-script

  Define a cabinet silently (scripted).

    $ codiac cab define my-cab --enterprise main --environment dev-environment --cluster my-cluster --silent

codiac cab destroy [CABINET]​

Tears down the k8s namespace for a cabinet without deleting the cabinet metadata record. The definition is preserved so the cabinet can be restored to the same or a different cluster later.

USAGE
  $ codiac cab destroy [CABINET] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h] [--enterprise <value>] [-e <value>] [-b <value>] [--take-defaults | [--silent | --echo
    | --to-script]]

ARGUMENTS
  CABINET  The name of the cabinet to destroy.

FLAGS
  -b, --cabinet=<value>      The name of the cabinet to destroy.
  -e, --environment=<value>  The environment the cabinet belongs to.
  -h, --help                 Show CLI help.
  -v, --verbose              Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>               Fires this command with an argument list that was previously remembered using the
                             --rememberAs flag.
  --echo                     Renders the equivalent non-interactive command before executing.
  --enterprise=<value>       The enterprise that owns the cabinet.
  --remember                 Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>       Saves the given argument list so that it can be called by name.
  --silent                   Non-interactive mode; fails on any missing or invalid arguments.
  --take-defaults            Accepts default values without confirmation prompts.
  --to-script                Renders the equivalent non-interactive command without executing it.
  --unremember=<value>       Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                             were previously stored under the given name (use "--unRemember default" to clear default
                             argument list memorized with the --remember flag).
  --withoutdefaults          Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Tears down the k8s namespace for a cabinet without deleting the cabinet metadata record. The definition is preserved
  so the cabinet can be restored to the same or a different cluster later.

ALIASES
  $ codiac cab destroy

EXAMPLES
  Destroy a cabinet interactively.

    $ codiac cab destroy

  Destroy a cabinet silently (scripted).

    $ codiac cab destroy my-cab --enterprise main --environment dev --silent

  Move a running cabinet to a different cluster.

    $ codiac cab destroy my-cab --enterprise main --environment dev --silent && cod cabinet detach my-cab ^
      --enterprise main --environment dev --silent && cod cabinet cluster attach my-cab --enterprise main ^
      --environment dev --cluster new-cluster --silent && cod cabinet restore --cabinet my-cab --enterprise main ^
      --environment dev --silent

codiac cab detach [CABINET]​

Clears the cluster assignment from a cabinet definition, making it available to re-attach to a different cluster. Does not touch any k8s infrastructure.

USAGE
  $ codiac cab detach [CABINET] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h] [--enterprise <value>] [-e <value>] [-b <value>] [--take-defaults | [--silent | --echo
    | --to-script]]

ARGUMENTS
  CABINET  The name of the cabinet to detach.

FLAGS
  -b, --cabinet=<value>      The name of the cabinet to detach.
  -e, --environment=<value>  The environment the cabinet belongs to.
  -h, --help                 Show CLI help.
  -v, --verbose              Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>               Fires this command with an argument list that was previously remembered using the
                             --rememberAs flag.
  --echo                     Renders the equivalent non-interactive command before executing.
  --enterprise=<value>       The enterprise that owns the cabinet.
  --remember                 Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>       Saves the given argument list so that it can be called by name.
  --silent                   Non-interactive mode; fails on any missing or invalid arguments.
  --take-defaults            Accepts default values without confirmation prompts.
  --to-script                Renders the equivalent non-interactive command without executing it.
  --unremember=<value>       Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                             were previously stored under the given name (use "--unRemember default" to clear default
                             argument list memorized with the --remember flag).
  --withoutdefaults          Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Clears the cluster assignment from a cabinet definition, making it available to re-attach to a different cluster. Does
  not touch any k8s infrastructure.

ALIASES
  $ codiac cab detach

EXAMPLES
  Detach a cabinet interactively.

    $ codiac cab detach

  Detach a cabinet silently (scripted).

    $ codiac cab detach my-cab --enterprise main --environment dev --silent

  Move a cabinet to a different cluster.

    $ codiac cab detach my-cab --enterprise main --environment dev --silent && cod cabinet cluster attach my-cab ^
      --enterprise main --environment dev --cluster new-cluster && cod cabinet restore --cabinet my-cab --enterprise ^
      main --environment dev

codiac cab forget [CABINET]​

Removes the cabinet metadata record from Codiac without touching any k8s infrastructure. The physical namespace (if any) remains on the cluster, unaware and unaffected.

USAGE
  $ codiac cab forget [CABINET] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h] [--enterprise <value>] [-e <value>] [-b <value>] [--take-defaults | [--silent | --echo
    | --to-script]]

ARGUMENTS
  CABINET  The name of the cabinet to forget.

FLAGS
  -b, --cabinet=<value>      The name of the cabinet to forget.
  -e, --environment=<value>  The environment the cabinet belongs to.
  -h, --help                 Show CLI help.
  -v, --verbose              Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>               Fires this command with an argument list that was previously remembered using the
                             --rememberAs flag.
  --echo                     Renders the equivalent non-interactive command before executing.
  --enterprise=<value>       The enterprise that owns the cabinet.
  --remember                 Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>       Saves the given argument list so that it can be called by name.
  --silent                   Non-interactive mode; fails on any missing or invalid arguments.
  --take-defaults            Accepts default values without confirmation prompts.
  --to-script                Renders the equivalent non-interactive command without executing it.
  --unremember=<value>       Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                             were previously stored under the given name (use "--unRemember default" to clear default
                             argument list memorized with the --remember flag).
  --withoutdefaults          Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Removes the cabinet metadata record from Codiac without touching any k8s infrastructure. The physical namespace (if
  any) remains on the cluster, unaware and unaffected.

ALIASES
  $ codiac cab forget

EXAMPLES
  Forget a cabinet interactively.

    $ codiac cab forget

  Forget a cabinet silently (scripted).

    $ codiac cab forget my-cab --enterprise main --environment dev --silent

  Renders the equivalent silent command without executing.

    $ codiac cab forget --to-script

codiac cab list​

Shows the list of cabinets and environment.

USAGE
  $ codiac cab list [-h] [-e <value>] [-o json|yaml|tree|text] [-q <value>] [--silent | --echo | --to-script]

FLAGS
  -e, --enterprise=<value>  The name of the enterprise in which to list cabinets (required only if more than one
                            enterprise exists).
  -h, --help                Show CLI help.
  -o, --output=<option>     Format in which to render the results (defaults to tree).
                            <options: json|yaml|tree|text>
  -q, --query=<value>       JMESPath expression to filter or reshape the results (see jmespath.org).
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Shows the list of cabinets and environment.

ALIASES
  $ codiac cab list
  $ codiac infrx cabinet list
  $ codiac infrx cab list

EXAMPLES
  List all cabinets for the current enterprise.

    $ codiac cab list

  List cabinets for a specific enterprise.

    $ codiac cab list -e myEnterprise

  List cabinet names only.

    $ codiac cab list -q '[].name'

  Export as YAML.

    $ codiac cab list -o yaml

  Non-interactive (scripted) invocation.

    $ codiac cab list -e myEnterprise --silent

codiac cab obliterate [CABINET]​

Hard-deletes an entire cabinet and everything in it; makes it as if the cabinet itself never existed.

USAGE
  $ codiac cab obliterate [CABINET] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h] [-c <value>] [-n <value>] [-e <value>] [-s | -x | -t] [-d]

ARGUMENTS
  CABINET  The name of the cabinet

FLAGS
  -c, --cabinet=<value>      REQUIRED: The name of the cabinet
  -d, --take-defaults        Take all defaults for prompts
  -e, --environment=<value>  REQUIRED: The name of the environment this cabinet will be grouped under.
  -h, --help                 Show CLI help.
  -n, --enterprise=<value>   REQUIRED: The name of the enterprise containing the cabinet.
  -s, --silent               Runs the command in silent mode. Requires --enterprise, --environment, and --cabinet flags.
  -t, --to-script            Prints the command that would be executed to the console and exits
  -v, --verbose              Renders additional logging levels (detail, trace, and debug) to the console output.
  -x, --echo                 Prints the command that would be executed to the console
  --as=<value>               Fires this command with an argument list that was previously remembered using the
                             --rememberAs flag.
  --remember                 Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>       Saves the given argument list so that it can be called by name.
  --unremember=<value>       Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                             were previously stored under the given name (use "--unRemember default" to clear default
                             argument list memorized with the --remember flag).
  --withoutdefaults          Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Hard-deletes an entire cabinet and everything in it; makes it as if the cabinet itself never existed.

ALIASES
  $ codiac cab obliterate
  $ codiac infrx cabinet obliterate
  $ codiac infrx cab obliterate

codiac cab restore​

Brings one or more cabinets back to a live state on their assigned cluster: records the cluster assignment, provisions the Kubernetes namespace, and deploys the enterprise version stamped on the cabinet (if any). Accepts either an explicit cabinet list or a cluster shorthand that targets all cabinets on the cluster at once.

USAGE
  $ codiac cab restore [-c <value>] [-b <value>] [-e <value>] [-n <value>] [--take-defaults | [--silent | --echo
    | --to-script]]

FLAGS
  -b, --cabinet=<value>...   Name of a cabinet to restore. Repeat for multiple. Mutually exclusive with --cluster.
  -c, --cluster=<value>      Restore all cabinets on this cluster (mutually exclusive with --cabinet).
  -e, --enterprise=<value>   Scope restore to this enterprise (only used with --cluster).
  -n, --environment=<value>  Environment of the cabinet (required when using --cabinet without --cluster).
  --echo                     Echo interaction mode; renders the equivalent non-interactive cli command for future use
                             before final execution.
  --silent                   Non-Interactive mode; executes without any user interaction and fails on any missing or
                             invalid arguments.
  --take-defaults            Prevents prompting for confirmation on parameters that were passed in or were automatically
                             set to default values (Irrelevant in --silent mode).
  --to-script                Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                             execution.

DESCRIPTION
  Brings one or more cabinets back to a live state on their assigned cluster: records the cluster assignment, provisions
  the Kubernetes namespace, and deploys the enterprise version stamped on the cabinet (if any). Accepts either an
  explicit cabinet list or a cluster shorthand that targets all cabinets on the cluster at once.

ALIASES
  $ codiac cab restore

EXAMPLES
  Restore all cabinets on a cluster interactively.

    $ codiac cab restore

  Restore all cabinets on a specific cluster (all enterprises).

    $ codiac cab restore --cluster prod-cluster-1

  Restore all cabinets on a cluster scoped to one enterprise.

    $ codiac cab restore --cluster prod-cluster-1 --enterprise acme

  Restore a single explicit cabinet.

    $ codiac cab restore --cabinet api-gateway --enterprise acme --environment prod

  Restore multiple explicit cabinets in one operation.

    $ codiac cab restore --cabinet api-gateway --cabinet auth-service --enterprise acme --environment prod

  Non-interactive (scripted) cluster restore — fails fast on any missing argument.

    $ codiac cab restore --cluster prod-cluster-1 --enterprise acme --silent

  Renders the equivalent silent command and then executes (useful for building scripts).

    $ codiac cab restore --cluster prod-cluster-1 --echo

  Renders the equivalent silent command without executing (dry run).

    $ codiac cab restore --cluster prod-cluster-1 --to-script

codiac cabinet allow​

Sets permissions for a security Role on the given cabinet entity. (NOT additive: this command overwrites any existing permissions set for this role on the entity).

USAGE
  $ codiac cabinet allow -p modify|read|none [--enterprise <value>] [-e <value>] [-c <value>] [-r <value>]
    [--take-defaults | [--silent | --echo | --to-script]]

FLAGS
  -c, --cabinet=<value>
      Name of the cabinet being protected. Required in silent mode.

  -e, --environment=<value>
      Name of the environment that contains the cabinet. Required in silent mode.

  -p, --privilege=<option>
      (required) The permission to assign to the Role. ("modify" infers permission to create, read, update, and delete.
      "none" removes any permissions set for the role)
      <options: modify|read|none>

  -r, --role=<value>
      Name of the Role being assigned. Required in silent mode.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --enterprise=<value>
      Name of the enterprise in which the cabinet resides. (Required only if more than one exists).

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Sets permissions for a security Role on the given cabinet entity. (NOT additive: this command overwrites any existing
  permissions set for this role on the entity).

ALIASES
  $ codiac cab allow

EXAMPLES
  $ codiac cabinet allow --enteprise main --environment dev --cabinet myspike --role developer --privilege modify

  $ codiac cabinet allow -e prod -c green -r developer -p none

  $ codiac cabinet allow -e qa -c shasta -r productmanager -p read

See code: dist/commands/cabinet/allow.ts

codiac cabinet cluster attach​

Declares which cluster a cabinet is intended to run on. Records the association in Codiac metadata so that restore and deploy operations know where to target the cabinet. No infrastructure is created or modified.

USAGE
  $ codiac cabinet cluster attach [-e <value>] [-b <value>] [-n <value>] [-c <value>] [--take-defaults | [--silent | --echo
    | --to-script]]

FLAGS
  -b, --cabinet=<value>      Name of the cabinet to attach.
  -c, --cluster=<value>      Name of the cluster to attach the cabinet to.
  -e, --enterprise=<value>   The name of the enterprise in which the cabinet resides. NOTE: You can leave this blank if
                             there is only one.
  -n, --environment=<value>  Name of the environment the cabinet belongs to.
  --echo                     Echo interaction mode; renders the equivalent non-interactive cli command for future use
                             before final execution.
  --silent                   Non-Interactive mode; executes without any user interaction and fails on any missing or
                             invalid arguments.
  --take-defaults            Prevents prompting for confirmation on parameters that were passed in or were automatically
                             set to default values (Irrelevant in --silent mode).
  --to-script                Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                             execution.

DESCRIPTION
  Declares which cluster a cabinet is intended to run on. Records the association in Codiac metadata so that restore and
  deploy operations know where to target the cabinet. No infrastructure is created or modified.

ALIASES
  $ codiac cab cluster attach

EXAMPLES
  Attach a cabinet to a cluster interactively.

    $ codiac cabinet cluster attach

  Attach a specific cabinet to a cluster (prompts for missing values).

    $ codiac cabinet cluster attach --enterprise acme --cabinet api-gateway --environment prod --cluster ^
      prod-cluster-1

  Non-interactive (scripted) invocation — fails fast on any missing argument.

    $ codiac cabinet cluster attach --enterprise acme --cabinet api-gateway --environment prod --cluster ^
      prod-cluster-1 --silent

  Renders the equivalent silent command and then executes (useful for building scripts).

    $ codiac cabinet cluster attach --enterprise acme --cabinet api-gateway --environment prod --cluster ^
      prod-cluster-1 --echo

  Renders the equivalent silent command without executing (dry run).

    $ codiac cabinet cluster attach --enterprise acme --cabinet api-gateway --environment prod --cluster ^
      prod-cluster-1 --to-script

See code: dist/commands/cabinet/cluster/attach.ts

codiac cabinet contents​

Renders the list of asset versions that are currently deployed to the given cabinet.

USAGE
  $ codiac cabinet contents [-e <value>] [-c <value>] [--echo | --to-script | [--silent ]]

FLAGS
  -c, --cabinet=<value>     The name of the cabinet to inspect.
  -e, --enterprise=<value>  The name of the enterprise in which to create this asset. (defaults to the current
                            enterprise context)
  --echo                    Echo interaction mode; renders the equivalent non-interactive cli command for future use
                            before final execution.
  --silent                  Non-Interactive mode; executes without any user interaction and fails on any missing or
                            invalid arguments.
  --to-script               Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                            execution.

DESCRIPTION
  Renders the list of asset versions that are currently deployed to the given cabinet.

ALIASES
  $ codiac cab contents
  $ codiac cluster contents

EXAMPLES
  $ codiac cabinet contents

  $ codiac cabinet contents -c dev7

  $ codiac cabinet contents -e main -c my-spike

  use the `--silent` flag to run this command when there is no user at the console (ie: TTY, ie: in a pipeline)

    $ codiac cabinet contents -e main -c my-spike --silent

  Use the `--to-script` flag to create a script file that runs this command

    $ codiac cabinet contents -e main -c my-spike --to-script > show-contents.sh

See code: dist/commands/cabinet/contents.ts

codiac cabinet create [CABINET]​

Initializes a cabinet for a given enterprise and environment. Returns an error if the cabinet already exists.

USAGE
  $ codiac cabinet create [CABINET] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h] [--enterprise <value>] [-e <value>] [-c <value>] [--take-defaults | [--silent | --echo
    | --to-script]]

ARGUMENTS
  CABINET  The name of the cabinet to create

FLAGS
  -c, --cluster=<value>      (optional: defaults to the first cluster in the environment) The name of the cluster to use
                             for the cabinet.
  -e, --environment=<value>  (optional: defaults to that of the current project branch) The name of the environment this
                             cabinet will be grouped under.
  -h, --help                 Show CLI help.
  -v, --verbose              Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>               Fires this command with an argument list that was previously remembered using the
                             --rememberAs flag.
  --echo                     Echo interaction mode; renders the equivalent non-interactive cli command for future use
                             before final execution.
  --enterprise=<value>       (required only if more than one enterprise exists) The name of the enterprise under which
                             to create this cabinet.
  --remember                 Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>       Saves the given argument list so that it can be called by name.
  --silent                   Non-Interactive mode; executes without any user interaction and fails on any missing or
                             invalid arguments.
  --take-defaults            Setting this to true prevents prompting for confirmation on parameters that were passed in
                             or were automatically set to default values (Irrelevant in --silent mode).
  --to-script                Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                             execution.
  --unremember=<value>       Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                             were previously stored under the given name (use "--unRemember default" to clear default
                             argument list memorized with the --remember flag).
  --withoutdefaults          Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Initializes a cabinet for a given enterprise and environment. Returns an error if the cabinet already exists.

ALIASES
  $ codiac cab create
  $ codiac infrx cabinet create
  $ codiac infrx cab create

EXAMPLES
  Create a cabinet interatively.

    cod cabinet create

  Create a cabinet interatively and assemble a non-interactive command string.

    cod cabinet create --echo

  Assemble a non-interactive command string WITHOUT actually creating a cabinet (dry run).

    cod cabinet create --to-script

  Create a cabinet silently.

    cod cabinet create my-cab-name --enterprise main -e dev-environemt -c my-cluster --silent

See code: dist/commands/cabinet/create.ts

codiac cabinet define [CABINET]​

Records the cabinet metadata without provisioning any k8s infrastructure. Use when the target cluster has no physical instance yet, or to stage a cabinet definition ahead of provisioning.

USAGE
  $ codiac cabinet define [CABINET] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h] [--enterprise <value>] [-e <value>] [-c <value>] [--take-defaults | [--silent | --echo
    | --to-script]]

ARGUMENTS
  CABINET  The name of the cabinet to define.

FLAGS
  -c, --cluster=<value>      The cluster to assign this cabinet to. Defaults to the only cluster in the environment when
                             there is exactly one.
  -e, --environment=<value>  The environment this cabinet belongs to.
  -h, --help                 Show CLI help.
  -v, --verbose              Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>               Fires this command with an argument list that was previously remembered using the
                             --rememberAs flag.
  --echo                     Renders the equivalent non-interactive command before executing.
  --enterprise=<value>       (required only if more than one enterprise exists) The enterprise under which to define the
                             cabinet.
  --remember                 Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>       Saves the given argument list so that it can be called by name.
  --silent                   Non-interactive mode; executes without prompts and fails on any missing or invalid
                             arguments.
  --take-defaults            Accepts default values without confirmation prompts (irrelevant in --silent mode).
  --to-script                Renders the equivalent non-interactive command without executing it.
  --unremember=<value>       Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                             were previously stored under the given name (use "--unRemember default" to clear default
                             argument list memorized with the --remember flag).
  --withoutdefaults          Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Records the cabinet metadata without provisioning any k8s infrastructure. Use when the target cluster has no physical
  instance yet, or to stage a cabinet definition ahead of provisioning.

ALIASES
  $ codiac cab define

EXAMPLES
  Define a cabinet interactively.

    $ codiac cabinet define

  Define a cabinet interactively and assemble a non-interactive command string.

    $ codiac cabinet define --echo

  Assemble a non-interactive command string without defining (dry run).

    $ codiac cabinet define --to-script

  Define a cabinet silently (scripted).

    $ codiac cabinet define my-cab --enterprise main --environment dev-environment --cluster my-cluster --silent

See code: dist/commands/cabinet/define.ts

codiac cabinet destroy [CABINET]​

Tears down the k8s namespace for a cabinet without deleting the cabinet metadata record. The definition is preserved so the cabinet can be restored to the same or a different cluster later.

USAGE
  $ codiac cabinet destroy [CABINET] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h] [--enterprise <value>] [-e <value>] [-b <value>] [--take-defaults | [--silent | --echo
    | --to-script]]

ARGUMENTS
  CABINET  The name of the cabinet to destroy.

FLAGS
  -b, --cabinet=<value>      The name of the cabinet to destroy.
  -e, --environment=<value>  The environment the cabinet belongs to.
  -h, --help                 Show CLI help.
  -v, --verbose              Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>               Fires this command with an argument list that was previously remembered using the
                             --rememberAs flag.
  --echo                     Renders the equivalent non-interactive command before executing.
  --enterprise=<value>       The enterprise that owns the cabinet.
  --remember                 Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>       Saves the given argument list so that it can be called by name.
  --silent                   Non-interactive mode; fails on any missing or invalid arguments.
  --take-defaults            Accepts default values without confirmation prompts.
  --to-script                Renders the equivalent non-interactive command without executing it.
  --unremember=<value>       Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                             were previously stored under the given name (use "--unRemember default" to clear default
                             argument list memorized with the --remember flag).
  --withoutdefaults          Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Tears down the k8s namespace for a cabinet without deleting the cabinet metadata record. The definition is preserved
  so the cabinet can be restored to the same or a different cluster later.

ALIASES
  $ codiac cab destroy

EXAMPLES
  Destroy a cabinet interactively.

    $ codiac cabinet destroy

  Destroy a cabinet silently (scripted).

    $ codiac cabinet destroy my-cab --enterprise main --environment dev --silent

  Move a running cabinet to a different cluster.

    $ codiac cabinet destroy my-cab --enterprise main --environment dev --silent && cod cabinet detach my-cab ^
      --enterprise main --environment dev --silent && cod cabinet cluster attach my-cab --enterprise main ^
      --environment dev --cluster new-cluster --silent && cod cabinet restore --cabinet my-cab --enterprise main ^
      --environment dev --silent

See code: dist/commands/cabinet/destroy.ts

codiac cabinet detach [CABINET]​

Clears the cluster assignment from a cabinet definition, making it available to re-attach to a different cluster. Does not touch any k8s infrastructure.

USAGE
  $ codiac cabinet detach [CABINET] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h] [--enterprise <value>] [-e <value>] [-b <value>] [--take-defaults | [--silent | --echo
    | --to-script]]

ARGUMENTS
  CABINET  The name of the cabinet to detach.

FLAGS
  -b, --cabinet=<value>      The name of the cabinet to detach.
  -e, --environment=<value>  The environment the cabinet belongs to.
  -h, --help                 Show CLI help.
  -v, --verbose              Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>               Fires this command with an argument list that was previously remembered using the
                             --rememberAs flag.
  --echo                     Renders the equivalent non-interactive command before executing.
  --enterprise=<value>       The enterprise that owns the cabinet.
  --remember                 Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>       Saves the given argument list so that it can be called by name.
  --silent                   Non-interactive mode; fails on any missing or invalid arguments.
  --take-defaults            Accepts default values without confirmation prompts.
  --to-script                Renders the equivalent non-interactive command without executing it.
  --unremember=<value>       Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                             were previously stored under the given name (use "--unRemember default" to clear default
                             argument list memorized with the --remember flag).
  --withoutdefaults          Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Clears the cluster assignment from a cabinet definition, making it available to re-attach to a different cluster. Does
  not touch any k8s infrastructure.

ALIASES
  $ codiac cab detach

EXAMPLES
  Detach a cabinet interactively.

    $ codiac cabinet detach

  Detach a cabinet silently (scripted).

    $ codiac cabinet detach my-cab --enterprise main --environment dev --silent

  Move a cabinet to a different cluster.

    $ codiac cabinet detach my-cab --enterprise main --environment dev --silent && cod cabinet cluster attach my-cab ^
      --enterprise main --environment dev --cluster new-cluster && cod cabinet restore --cabinet my-cab --enterprise ^
      main --environment dev

See code: dist/commands/cabinet/detach.ts

codiac cabinet forget [CABINET]​

Removes the cabinet metadata record from Codiac without touching any k8s infrastructure. The physical namespace (if any) remains on the cluster, unaware and unaffected.

USAGE
  $ codiac cabinet forget [CABINET] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h] [--enterprise <value>] [-e <value>] [-b <value>] [--take-defaults | [--silent | --echo
    | --to-script]]

ARGUMENTS
  CABINET  The name of the cabinet to forget.

FLAGS
  -b, --cabinet=<value>      The name of the cabinet to forget.
  -e, --environment=<value>  The environment the cabinet belongs to.
  -h, --help                 Show CLI help.
  -v, --verbose              Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>               Fires this command with an argument list that was previously remembered using the
                             --rememberAs flag.
  --echo                     Renders the equivalent non-interactive command before executing.
  --enterprise=<value>       The enterprise that owns the cabinet.
  --remember                 Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>       Saves the given argument list so that it can be called by name.
  --silent                   Non-interactive mode; fails on any missing or invalid arguments.
  --take-defaults            Accepts default values without confirmation prompts.
  --to-script                Renders the equivalent non-interactive command without executing it.
  --unremember=<value>       Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                             were previously stored under the given name (use "--unRemember default" to clear default
                             argument list memorized with the --remember flag).
  --withoutdefaults          Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Removes the cabinet metadata record from Codiac without touching any k8s infrastructure. The physical namespace (if
  any) remains on the cluster, unaware and unaffected.

ALIASES
  $ codiac cab forget

EXAMPLES
  Forget a cabinet interactively.

    $ codiac cabinet forget

  Forget a cabinet silently (scripted).

    $ codiac cabinet forget my-cab --enterprise main --environment dev --silent

  Renders the equivalent silent command without executing.

    $ codiac cabinet forget --to-script

See code: dist/commands/cabinet/forget.ts

codiac cabinet list​

Shows the list of cabinets and environment.

USAGE
  $ codiac cabinet list [-h] [-e <value>] [-o json|yaml|tree|text] [-q <value>] [--silent | --echo | --to-script]

FLAGS
  -e, --enterprise=<value>  The name of the enterprise in which to list cabinets (required only if more than one
                            enterprise exists).
  -h, --help                Show CLI help.
  -o, --output=<option>     Format in which to render the results (defaults to tree).
                            <options: json|yaml|tree|text>
  -q, --query=<value>       JMESPath expression to filter or reshape the results (see jmespath.org).
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Shows the list of cabinets and environment.

ALIASES
  $ codiac cab list
  $ codiac infrx cabinet list
  $ codiac infrx cab list

EXAMPLES
  List all cabinets for the current enterprise.

    $ codiac cabinet list

  List cabinets for a specific enterprise.

    $ codiac cabinet list -e myEnterprise

  List cabinet names only.

    $ codiac cabinet list -q '[].name'

  Export as YAML.

    $ codiac cabinet list -o yaml

  Non-interactive (scripted) invocation.

    $ codiac cabinet list -e myEnterprise --silent

See code: dist/commands/cabinet/list.ts

codiac cabinet obliterate [CABINET]​

Hard-deletes an entire cabinet and everything in it; makes it as if the cabinet itself never existed.

USAGE
  $ codiac cabinet obliterate [CABINET] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h] [-c <value>] [-n <value>] [-e <value>] [-s | -x | -t] [-d]

ARGUMENTS
  CABINET  The name of the cabinet

FLAGS
  -c, --cabinet=<value>      REQUIRED: The name of the cabinet
  -d, --take-defaults        Take all defaults for prompts
  -e, --environment=<value>  REQUIRED: The name of the environment this cabinet will be grouped under.
  -h, --help                 Show CLI help.
  -n, --enterprise=<value>   REQUIRED: The name of the enterprise containing the cabinet.
  -s, --silent               Runs the command in silent mode. Requires --enterprise, --environment, and --cabinet flags.
  -t, --to-script            Prints the command that would be executed to the console and exits
  -v, --verbose              Renders additional logging levels (detail, trace, and debug) to the console output.
  -x, --echo                 Prints the command that would be executed to the console
  --as=<value>               Fires this command with an argument list that was previously remembered using the
                             --rememberAs flag.
  --remember                 Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>       Saves the given argument list so that it can be called by name.
  --unremember=<value>       Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                             were previously stored under the given name (use "--unRemember default" to clear default
                             argument list memorized with the --remember flag).
  --withoutdefaults          Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Hard-deletes an entire cabinet and everything in it; makes it as if the cabinet itself never existed.

ALIASES
  $ codiac cab obliterate
  $ codiac infrx cabinet obliterate
  $ codiac infrx cab obliterate

See code: dist/commands/cabinet/obliterate.ts

codiac cabinet restore​

Brings one or more cabinets back to a live state on their assigned cluster: records the cluster assignment, provisions the Kubernetes namespace, and deploys the enterprise version stamped on the cabinet (if any). Accepts either an explicit cabinet list or a cluster shorthand that targets all cabinets on the cluster at once.

USAGE
  $ codiac cabinet restore [-c <value>] [-b <value>] [-e <value>] [-n <value>] [--take-defaults | [--silent | --echo
    | --to-script]]

FLAGS
  -b, --cabinet=<value>...   Name of a cabinet to restore. Repeat for multiple. Mutually exclusive with --cluster.
  -c, --cluster=<value>      Restore all cabinets on this cluster (mutually exclusive with --cabinet).
  -e, --enterprise=<value>   Scope restore to this enterprise (only used with --cluster).
  -n, --environment=<value>  Environment of the cabinet (required when using --cabinet without --cluster).
  --echo                     Echo interaction mode; renders the equivalent non-interactive cli command for future use
                             before final execution.
  --silent                   Non-Interactive mode; executes without any user interaction and fails on any missing or
                             invalid arguments.
  --take-defaults            Prevents prompting for confirmation on parameters that were passed in or were automatically
                             set to default values (Irrelevant in --silent mode).
  --to-script                Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                             execution.

DESCRIPTION
  Brings one or more cabinets back to a live state on their assigned cluster: records the cluster assignment, provisions
  the Kubernetes namespace, and deploys the enterprise version stamped on the cabinet (if any). Accepts either an
  explicit cabinet list or a cluster shorthand that targets all cabinets on the cluster at once.

ALIASES
  $ codiac cab restore

EXAMPLES
  Restore all cabinets on a cluster interactively.

    $ codiac cabinet restore

  Restore all cabinets on a specific cluster (all enterprises).

    $ codiac cabinet restore --cluster prod-cluster-1

  Restore all cabinets on a cluster scoped to one enterprise.

    $ codiac cabinet restore --cluster prod-cluster-1 --enterprise acme

  Restore a single explicit cabinet.

    $ codiac cabinet restore --cabinet api-gateway --enterprise acme --environment prod

  Restore multiple explicit cabinets in one operation.

    $ codiac cabinet restore --cabinet api-gateway --cabinet auth-service --enterprise acme --environment prod

  Non-interactive (scripted) cluster restore — fails fast on any missing argument.

    $ codiac cabinet restore --cluster prod-cluster-1 --enterprise acme --silent

  Renders the equivalent silent command and then executes (useful for building scripts).

    $ codiac cabinet restore --cluster prod-cluster-1 --echo

  Renders the equivalent silent command without executing (dry run).

    $ codiac cabinet restore --cluster prod-cluster-1 --to-script

See code: dist/commands/cabinet/restore.ts

codiac cfg add​

Adds a key value pair to the app config

USAGE
  $ codiac cfg add [-h] [-n <value>] [-a <value>] [-s | -e <value> | -c <value>] [--entire-file | --setting
    <value> | [-t
    annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onpredeploy|permit|probing | -f
    <value>]] [--value <value>] [--condition <value>] [--value-stdin ] [--take-defaults | [--silent | --echo |
    --to-script]]

FLAGS
  -a, --asset=<value>
      The name of the asset to which the settings belong.

  -c, --cabinet=<value>
      The name of the cabinet to which this value is to apply.

  -e, --enviro=<value>
      The name of the environment to which this value is to apply.

  -f, --file=<value>
      The path-name to the file to which the settings are written, relative to the root of the Codiac project.

  -h, --help
      Show CLI help.

  -n, --enterprise=<value>
      (required only when more than one enterprise exists) The name of the enterprise containing the asset.

  -s, --enterprise-scope
      Filters for settings scoped at the enterprise level.

  -t, --type=<option>
      Filters for the settings types that do not land in a config file (such as... env: OS environment variables,
      footprint: container footprint specs, helm: helm chart settings, label: container meta labels, annotation: container
      platform key-value pairs).
      <options: annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onpredeploy|permit|probing>

  --condition=<value>
      Jsonata Expression to determine whether to include this setting, applied against the built-in asset-version
      expression context (see https://jsonata.org for syntax).

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --entire-file
      Declares that the entire config doc content shall consist only of the value of this setting.  If the system
      encounters this argument while assembling configs, it will ignore any other settings applied to the given target
      file.

  --setting=<value>
      The config key (in dotpath/JSONPath), relative to the root of the config.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

  --value=<value>
      The actual concrete data to be applied as the setting value.

  --value-stdin
      (for type=file only) Reads the actual concrete data to be applied as the setting value from the stdin io stream (see
      the help for examples).

DESCRIPTION
  Adds a key value pair to the app config

ALIASES
  $ codiac config set
  $ codiac cfg add

EXAMPLES
  Apply a setting interactively

    cod config set

  Apply a setting interactively and assemble a non-interactive command string.

    cod config set --echo

  Assemble a non-interactive command string WITHOUT actually applying any settings (dry run).

    cod config set --to-script

  Set the value of an individual setting to the contents of a file on your local machine

    cat template.htm | cod config set -a api -c dev -f '/alert-settings.json' --setting 'email-body' --value-stdin

  Set the entire file content to the content of a file on your local machine

    cat way-too-much.xml | cod config set -a api -c dev -f '/datapoints.xml' --entire-file --value-stdin

  Set the entire file content to the value of a secret

    cod config set -a api -c dev -f '/some-managed-service.pem' --entire-file --value ^
      '#REF|azKeyVault|our-secret-store|some-managed-svc-cert'

codiac cfg delete [SETTING]​

Removes the given keys from the app config

USAGE
  $ codiac cfg delete [SETTING] [-n <value>] [-a <value>] [-f <value> | -t
    annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onpredeploy|permit|probing] [-s | -e
    <value> | -c <value>] [-s <value>] [--take-defaults | [--silent | --echo | --to-script]] [-h]

ARGUMENTS
  SETTING  (optional) Specific config key to remove. Omit to select from a list. Enter "all" to clear the entire config.

FLAGS
  -a, --asset=<value>
      The name of the asset to which the settings belong.

  -c, --cabinet=<value>
      Filters for settings scoped to the given cabinet name.

  -e, --enviro=<value>
      Filters for settings scoped to the given environment name.

  -f, --file=<value>
      The path-name to the config file holding the settings, relative to the root of the Codiac project.

  -h, --help
      Displays the help document for this command.

  -n, --enterprise=<value>
      (required only when more than one enterprise exists) The name of the enterprise containing the asset.

  -s, --enterprise-scope
      Filters for settings scoped at the enterprise level.

  -s, --setting=<value>...
      The config key (in dotpath/JSONPath), relative to the root of the config. eg: `database.name` or
      `database.connectionString`

  -t, --type=<option>
      Filters for the settings types that do not land in a config file (such as... env: OS environment variables,
      footprint: container footprint specs, helm: helm chart settings, label: container meta labels, annotation: container
      platform key-value pairs).
      <options: annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onpredeploy|permit|probing>

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Removes the given keys from the app config

ALIASES
  $ codiac cfg delete

codiac cfg preview [SETTING]​

Retrieves a pre-deploy preview of the ultimate configuration file contents for the given cabinet (with all inline variables and source references resolved).

USAGE
  $ codiac cfg preview [SETTING] [-h] [-e <value>] [-a <value>] [-c <value>] [-t
    annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onpredeploy|permit|probing | -f
    <value>] [-o pretty|json|yaml|auto] [-p] [--silent | --echo | --to-script]

ARGUMENTS
  SETTING  (optional) Name of a specific setting to view; omit to show all.

FLAGS
  -a, --asset=<value>       Name of the asset to view configs for (use ? to be prompted).
  -c, --cabinet=<value>     The name of the cabinet to assemble the configuration for.
  -e, --enterprise=<value>  The name of the enterprise that contains the asset (defaults to the current enterprise
                            context).
  -f, --file=<value>        The relative pathname of the config file to view, relative to the root of the codiac project
                            (defaults to app-config.json).
  -h, --help                Show CLI help.
  -o, --output=<option>     Format in which to render the config document (defaults to auto).
                            <options: pretty|json|yaml|auto>
  -p, --prompt              Forces a prompt to select from the existing settings.
  -t, --type=<option>       The type of settings to view (env: OS environment variables, footprint: container footprint
                            specs, helm: helm chart settings, label: container meta labels, annotation: container
                            platform key-value pairs).
                            <options: annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onpr
                            edeploy|permit|probing>
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Retrieves a pre-deploy preview of the ultimate configuration file contents for the given cabinet (with all inline
  variables and source references resolved).

ALIASES
  $ codiac config preview
  $ codiac cfg preview

EXAMPLES
  View config for the current asset interactively.

    $ codiac cfg preview

  View a specific cabinet's config in pretty format.

    $ codiac cfg preview -c dev2 -f settings.json -o pretty

  View a specific non-file config type.

    $ codiac cfg preview -c dev2 -a myapi -t footprint

  Non-interactive (scripted) invocation.

    $ codiac cfg preview -e myEnterprise -a myApi -c dev --silent

  Renders the equivalent silent command without executing.

    $ codiac cfg preview -e myEnterprise -a myApi -c dev --to-script

codiac cli​

Applies settings to the Codiac CLI itself (scoped to the local machine).

USAGE
  $ codiac cli [-h] [-s <value>]

FLAGS
  -h, --help            Show the help docs for this command.
  -s, --set=<value>...  A key=value expression for the setting to apply.  Leave this argument out of your call to get a
                        list of the available settings keys and their types.

DESCRIPTION
  Applies settings to the Codiac CLI itself (scoped to the local machine).

See code: dist/commands/cli.ts

codiac cluster agent configure [CLUSTER]​

Applies configuration settings to the Codiac agent on the given cluster. Use "overlay" mode (default) to merge settings on top of the existing configuration, or "replace" mode to overwrite the configuration entirely. Settings can be provided as a JSON or YAML string via --settings, piped in via stdin, or entered interactively as a single key-value pair.

USAGE
  $ codiac cluster agent configure [CLUSTER] [-m overlay|replace] [--settings <value>] [--take-defaults | [--silent | --echo
    | --to-script]]

ARGUMENTS
  CLUSTER  Name of the cluster in Codiac on which to configure the Codiac agent.  You can use `cod cluster list` to see
           available cluster names.

FLAGS
  -m, --mode=<option>  How to apply the provided settings: "overlay" (default) merges the settings on top of the
                       existing configuration; "replace" overwrites the configuration entirely.
                       <options: overlay|replace>
  --echo               Echo interaction mode; renders the equivalent non-interactive cli command for future use before
                       final execution.
  --settings=<value>   JSON or YAML string of settings to apply to the agent configuration.  Alternatively, pipe
                       settings content via stdin.
  --silent             Non-Interactive mode; executes without any user interaction and fails on any missing or invalid
                       arguments.
  --take-defaults      Prevents prompting for confirmation on parameters that were passed in or were automatically set
                       to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios where
                       the command needs to override invalid user input; such cases will always prompt for confirmation.
  --to-script          Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                       execution.

DESCRIPTION
  Applies configuration settings to the Codiac agent on the given cluster.  Use "overlay" mode (default) to merge
  settings on top of the existing configuration, or "replace" mode to overwrite the configuration entirely.  Settings
  can be provided as a JSON or YAML string via --settings, piped in via stdin, or entered interactively as a single
  key-value pair.

EXAMPLES
  Patch inline JSON settings into the existing agent configuration.

    $ codiac cluster agent configure my-cluster --settings '{"keel": {"image": {"repository": "my-repo", "tag": ^
      "latest", "pullPolicy": "Always"}}}'

  Replace the entire agent configuration with inline JSON settings.

    $ codiac cluster agent configure my-cluster --mode replace --settings '{"keel": {"image": {"repository": ^
      "my-repo", "tag": "latest", "pullPolicy": "Always"}}}'

  Pipe a YAML settings file into the command.

    cat mysettings.yaml | codiac cluster agent configure my-cluster

  Non-interactive (scripted) invocation.

    $ codiac cluster agent configure my-cluster --settings '{"keel": {"image": {"tag": "v1.2.3"}}}' --silent

  Renders the equivalent silent command and then executes.

    $ codiac cluster agent configure my-cluster --echo

  Renders the equivalent silent command without executing.

    $ codiac cluster agent configure my-cluster --to-script

See code: dist/commands/cluster/agent/configure.ts

codiac cluster agent install [CLUSTER]​

Installs the Codiac agent on the given cluster, enabling Codiac to manage workloads and configurations on the cluster.

USAGE
  $ codiac cluster agent install [CLUSTER] [--take-defaults | [--silent | --echo | --to-script]] [-v <value>]

ARGUMENTS
  CLUSTER  Name of the cluster in Codiac on which to install the Codiac agent.  You can use `cod cluster list` to see
           available cluster names.

FLAGS
  -v, --version=<value>  Version of the Codiac agent helm chart to install.  Omit to install the latest available
                         version.
  --echo                 Echo interaction mode; renders the equivalent non-interactive cli command for future use before
                         final execution.
  --silent               Non-Interactive mode; executes without any user interaction and fails on any missing or invalid
                         arguments.
  --take-defaults        Prevents prompting for confirmation on parameters that were passed in or were automatically set
                         to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios
                         where the command needs to override invalid user input; such cases will always prompt for
                         confirmation.
  --to-script            Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                         execution.

DESCRIPTION
  Installs the Codiac agent on the given cluster, enabling Codiac to manage workloads and configurations on the cluster.

EXAMPLES
  Install the Codiac agent on a cluster.

    $ codiac cluster agent install my-cluster

  Install a specific version of the Codiac agent.

    $ codiac cluster agent install my-cluster --version 1.2.3

  Non-interactive (scripted) invocation.

    $ codiac cluster agent install my-cluster --silent

  Renders the equivalent silent command and then executes.

    $ codiac cluster agent install my-cluster --echo

  Render the equivalent silent command without executing.

    $ codiac cluster agent install my-cluster --to-script

See code: dist/commands/cluster/agent/install.ts

codiac cluster agent uninstall [CLUSTER]​

Uninstalls the Codiac agent from the given cluster.

USAGE
  $ codiac cluster agent uninstall [CLUSTER] [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  CLUSTER  Name of the cluster in Codiac from which to uninstall the Codiac agent.  You can use `cod cluster list` to
           see available cluster names.

FLAGS
  --echo           Echo interaction mode; renders the equivalent non-interactive cli command for future use before final
                   execution.
  --silent         Non-Interactive mode; executes without any user interaction and fails on any missing or invalid
                   arguments.
  --take-defaults  Prevents prompting for confirmation on parameters that were passed in or were automatically set to
                   default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios where the
                   command needs to override invalid user input; such cases will always prompt for confirmation.
  --to-script      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Uninstalls the Codiac agent from the given cluster.

EXAMPLES
  Uninstall the Codiac agent from a cluster.

    $ codiac cluster agent uninstall my-cluster

  Non-interactive (scripted) invocation.

    $ codiac cluster agent uninstall my-cluster --silent

  Renders the equivalent silent command and then executes.

    $ codiac cluster agent uninstall my-cluster --echo

  Render the equivalent silent command without executing.

    $ codiac cluster agent uninstall my-cluster --to-script

See code: dist/commands/cluster/agent/uninstall.ts

codiac cluster bootstrap [NAME]​

Provisions a new cluster, installs the Codiac agent, and installs the default cluster stack in a single operation. This is the recommended path for standing up a new cluster. Use cod cluster provision, cod cluster agent install, and cod cluster stack install separately if you need control over individual steps.

USAGE
  $ codiac cluster bootstrap [NAME] [-h] [--provider azure|aws|localMachine] [-s <value>] [-g <value>] [-l <value>] [-n
    <value>] [-q <value>] [--k8sVersion <value>] [--nodesMin <value>] [--nodesMax <value>] [-k <value>] [--networkPlugin
    kubenet|azure] [-u <value>] [--identityUserId <value>] [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  NAME  Name of the cluster to provision.

FLAGS
  -g, --resourceGroup=<value>         (Azure only) The resource group to create for the cluster.
  -h, --help                          Show CLI help.
  -k, --subnet=<value>...             (Optional) Resource Id of the subnet in which to create the cluster.
  -l, --location=<value>              The short name of the regional data center in which the cluster is to reside.
  -n, --nodeSpec=<value>              The VM size to use for cluster nodes.
  -q, --nodeQty=<value>               [default: 2] Starting node count for the cluster.
  -s, --providerSubscription=<value>  The cloud provider subscription Id (Azure) or account Id (AWS) under which to
                                      create the cluster.
  -u, --identityUserName=<value>      (Optional) Name of the Service Principal or Managed Identity to execute as.
  --echo                              Renders the equivalent non-interactive command for future use before executing.
  --identityUserId=<value>            (Optional) Id of the Service Principal or Managed Identity to execute as.
  --k8sVersion=<value>                The version of Kubernetes to install on the cluster.
  --networkPlugin=<option>            (Optional) Network plugin for the cluster.
                                      <options: kubenet|azure>
  --nodesMax=<value>                  Maximum number of nodes for autoscaling.
  --nodesMin=<value>                  Minimum number of nodes for autoscaling.
  --provider=<option>                 Cloud service provider on which to provision the cluster.
                                      <options: azure|aws|localMachine>
  --silent                            Executes without any user interaction; fails on missing or invalid arguments.
  --take-defaults                     Prevents prompting for confirmation on parameters that were passed in or
                                      automatically set to default values.
  --to-script                         Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Provisions a new cluster, installs the Codiac agent, and installs the default cluster stack in a single operation.
  This is the recommended path for standing up a new cluster. Use `cod cluster provision`, `cod cluster agent install`,
  and `cod cluster stack install` separately if you need control over individual steps.

EXAMPLES
  Bootstrap a cluster interactively.

    $ codiac cluster bootstrap

  Bootstrap an Azure cluster non-interactively.

    $ codiac cluster bootstrap my-cluster --provider azure --providerSubscription <sub-id> --resourceGroup my-rg ^
      --location eastus --nodeSpec Standard_D4s_v3 --nodeQty 3 --k8sVersion 1.29.0 --silent

  Renders the equivalent silent command and then executes.

    $ codiac cluster bootstrap my-cluster --echo

  Renders the equivalent silent command without executing.

    $ codiac cluster bootstrap my-cluster --to-script

See code: dist/commands/cluster/bootstrap.ts

codiac cluster capture​

Creates a new record in Codiac for a cluster that already physically exists in a cloud subscription. You will need credentials for the cloud service provider subscription you are drawing the cluster from. Use cod csp login to capture your credentials. Use cod cluster forget ---running to undo this operation.

USAGE
  $ codiac cluster capture [-h] [-t <value>] [-g <value>] [--echo | --to-script | [--silent -n <value> -p azure|aws
    -s <value> -l <value>]]

FLAGS
  -g, --azResourceGroup=<value>       (required for Azure) The Azure resource group in which to find the cluster.
  -h, --help                          Show CLI help.
  -l, --location=<value>              The short name of the regional data center in which the cliuster resides.
  -n, --name=<value>                  Name of the cluster to capture
  -p, --provider=<option>             Cloud service provider on which to find the cluster
                                      <options: azure|aws>
  -s, --providerSubscription=<value>  The cloud provider subscription Id under which to find the cluster (eg:
                                      SubscriptionId for azure, AccountId for aws).
  -t, --providerTenantId=<value>      (in silent mode, either this or providerSubscription is required if you have more
                                      than one tenant profile on a given cloud provider) The Id of the cloud provider
                                      tenant under which to authenticate.
  --echo                              Echo interaction mode; renders the equivalent non-interactive cli command for
                                      future use before final execution.
  --silent                            Non-Interactive mode; executes without any user interaction and fails on any
                                      missing or invalid arguments.
  --to-script                         Toscript interaction mode; renders the equivalent non-interactive cli command
                                      WITHOUT any execution.

DESCRIPTION
  Creates a new record in Codiac for a cluster that already physically exists in a cloud subscription.      You will
  need credentials for the cloud service provider subscription you are drawing the cluster from.      Use `cod csp
  login` to capture your credentials.      Use `cod cluster forget ---running` to undo this operation.

ALIASES
  $ codiac cluster capture

EXAMPLES
  Capture a cluster interatively.

    cod cluster capture

  Capture an Azure cluster silently.

    cod cluster capture -n my-cluster -p azure -s abcd123-xyzpdq-5678-pdq345 -l eastus -g our-dev-stuff

  Capture an AWS cluster silently.

    cod cluster capture -n my-cluster -p aws -s 123456789012 -l us-east-1

codiac cluster connect [CLUSTER]​

Downloads the kube config context for the current user on the given cluster, writes it to the local machine kube config file, and sets it as the current default context. NOTE: Codiac keeps its own cache of the cluster connection credentials; this command is purely to facilitate the use of other software on the local machine that the user may want to point to clusters in Codiac.

USAGE
  $ codiac cluster connect [CLUSTER] [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  CLUSTER  Name of the cluster in Codiac.  You can use `cod cluster list` to see the names of your codiac clusters.

FLAGS
  --echo           Echo interaction mode; renders the equivalent non-interactive cli command for future use before final
                   execution.
  --silent         Non-Interactive mode; executes without any user interaction and fails on any missing or invalid
                   arguments.
  --take-defaults  Setting this to true prevents prompting for confirmation on parameters that were passed in or were
                   automatically set to default values (Irrelevant in --silent mode).  This behavior does NOT apply to
                   scenarios that the command needs to override invalid user input; such cases will always prompt for
                   confirmation.  eg: when no argument was provided for file or type, and only one exists, the system
                   will render the autoselected file unless this flag is set.
  --to-script      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Downloads the kube config context for the current user on the given cluster, writes it to the local machine kube
  config file, and sets it as the current default context.  NOTE: Codiac keeps its own cache of the cluster connection
  credentials; this command is purely to facilitate the use of other software on the local machine that the user may
  want to point to clusters in Codiac.

EXAMPLES
  $ codiac cluster connect my-fav-cluster

See code: dist/commands/cluster/connect.ts

codiac cluster contents​

Renders the list of asset versions that are currently deployed to the given cabinet.

USAGE
  $ codiac cluster contents [-e <value>] [-c <value>] [--echo | --to-script | [--silent ]]

FLAGS
  -c, --cabinet=<value>     The name of the cabinet to inspect.
  -e, --enterprise=<value>  The name of the enterprise in which to create this asset. (defaults to the current
                            enterprise context)
  --echo                    Echo interaction mode; renders the equivalent non-interactive cli command for future use
                            before final execution.
  --silent                  Non-Interactive mode; executes without any user interaction and fails on any missing or
                            invalid arguments.
  --to-script               Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                            execution.

DESCRIPTION
  Renders the list of asset versions that are currently deployed to the given cabinet.

ALIASES
  $ codiac cab contents
  $ codiac cluster contents

EXAMPLES
  $ codiac cluster contents

  $ codiac cluster contents -c dev7

  $ codiac cluster contents -e main -c my-spike

  use the `--silent` flag to run this command when there is no user at the console (ie: TTY, ie: in a pipeline)

    $ codiac cluster contents -e main -c my-spike --silent

  Use the `--to-script` flag to create a script file that runs this command

    $ codiac cluster contents -e main -c my-spike --to-script > show-contents.sh

codiac cluster create [NAME]​

Provisions the physical cluster

USAGE
  $ codiac cluster create [NAME] [-h] [--provider azure|aws|localMachine] [-s <value>] [-g <value>] [-l <value>] [-q
    <value>] [--k8sVersion <value>] [-k <value>] [--networkPlugin kubenet|azure] [-n <value>] [-u <value>]
    [--identityUserId <value>] [--nodesMin <value>] [--nodesMax <value>] [--init] [--take-defaults | [--silent | --echo
    | --to-script]]

ARGUMENTS
  NAME  Proposed name of the cluster

FLAGS
  -g, --resourceGroup=<value>         (Required in silent mode) The Azure resource group to create for the cluster.
  -h, --help                          Show CLI help.
  -k, --subnet=<value>...             OPTIONAL: The resource id of the subnet in which the cluster is to be created.
  -l, --location=<value>              (Required in silent mode) The short name of the azure data center in which the
                                      cluster is to reside.
  -n, --nodeSpec=<value>              The identifier for the type of VM to use for nodes in the cluster.
  -q, --nodeQty=<value>               [default: 2] (Required in silent mode) The starting node count with which to
                                      create the cluster.
  -s, --providerSubscription=<value>  (Required in silent mode) The Azure subscription Id under which to create the
                                      cluster.
  -u, --identityUserName=<value>      OPTIONAL. Name of Svc Principal or Managed Identity to execute as.
  --echo                              Echo interaction mode; renders the equivalent non-interactive cli command for
                                      future use before final execution.
  --identityUserId=<value>            OPTIONAL. ID of Svc Principal or Managed Identity to execute as.
  --[no-]init                         Automatically initialize cluster after creation (use --no-init to skip).
  --k8sVersion=<value>                (Required in silent mode) The version of Kubernetes to install on the cluster.
  --networkPlugin=<option>            OPTIONAL: The network plugin for the cluster (kubenet, azure). Defaults to
                                      kubenet.
                                      <options: kubenet|azure>
  --nodesMax=<value>                  OPTIONAL. The maximum number of nodes to maintain in the cluster.
  --nodesMin=<value>                  OPTIONAL. The minimum number of nodes to maintain in the cluster.
  --provider=<option>                 (Required in silent mode) Cloud service provider on which to provision the cluster
                                      <options: azure|aws|localMachine>
  --silent                            Non-Interactive mode; executes without any user interaction and fails on any
                                      missing or invalid arguments.
  --take-defaults                     Setting this to true prevents prompting for confirmation on parameters that were
                                      passed in or were automatically set to default values (Irrelevant in --silent
                                      mode).
  --to-script                         Toscript interaction mode; renders the equivalent non-interactive cli command
                                      WITHOUT any execution.

DESCRIPTION
  Provisions the physical cluster

ALIASES
  $ codiac cluster provision
  $ codiac cluster create

EXAMPLES
  Create a cluster interatively.

    cod cluster create my-cluster

  Create a cluster interatively and assemble a non-interactive command string.

    cod cluster create my-cluster --echo

  Assemble a non-interactive command string WITHOUT actually creating a cluster (dry run).

    cod cluster create my-cluster --to-script

  Create a cluster silently.

    cod cluster create my-cluster --provider azure --providerSubscription 12345678-1234-1234-1234-123456789012 ^
      --resourceGroup my-rg --location eastus --nodeSpec Standard_DS2_v2 --nodeQty 2 --silent

  Create a cluster silently with all available options (NOTE: you can generate this command using --to-script)

    cod cluster create my-comprehensive-cluster --provider azure --providerSubscription ^
      12345678-1234-1234-1234-123456789012 --resourceGroup my-resource-group --location eastus2 --nodeSpec ^
      Standard_D2s_v3 --nodeQty 3 --k8sVersion 1.21.2 --networkPlugin azure --nodesMin 2 --nodesMax 5 --owner ^
      my-tenant-code --subnet /subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/my-vnet-rg/providers/ ^
      Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet --identityUserName my-service-principal ^
      --identityUserId 87654321-4321-4321-4321-210987654321 --identityUserPassword mySecurePassword123! --silent

FLAG DESCRIPTIONS
  --[no-]init  Automatically initialize cluster after creation (use --no-init to skip).

    By default, the cluster creation command automatically runs `init-cluster`. Use this flag to skip the initialization
    step and leave the cluster in a non-initialized state. Not applicable when invoked as `cluster:provision` —
    initialization is always skipped in that mode.

codiac cluster credentials-set [NAME]​

Registers connection credentials for a self-managed cluster (provider: other). Supply a kubeconfig file via --file or pipe it via stdin. When the file contains multiple contexts, specify which one to use with --context. If there is only one context, it is ingested automatically.

USAGE
  $ codiac cluster credentials-set [NAME] [-f <value>] [-x <value>] [--take-defaults | [--silent | --echo |
  --to-script]]

ARGUMENTS
  NAME  Name of the cluster to register credentials for.

FLAGS
  -f, --file=<value>     Path to a kubeconfig file. Mutually exclusive with stdin.
  -x, --context=<value>  Name of the context to extract from a multi-context kubeconfig. If omitted and exactly one
                         context references a cluster matching the cluster name argument, that context is selected
                         automatically. Required only when the match is ambiguous.
  --echo                 Renders the equivalent non-interactive command before executing.
  --silent               Non-interactive mode; executes without user interaction and fails on missing or invalid
                         arguments.
  --take-defaults        Prevents prompting for confirmation on parameters already provided.
  --to-script            Renders the equivalent non-interactive command without executing.

DESCRIPTION
  Registers connection credentials for a self-managed cluster (provider: other). Supply a kubeconfig file via --file or
  pipe it via stdin. When the file contains multiple contexts, specify which one to use with --context. If there is only
  one context, it is ingested automatically.

ALIASES
  $ codiac cluster credentials-set

EXAMPLES
  Register credentials from a file (single-context kubeconfig).

    $ codiac cluster credentials-set my-cluster --file ~/.kube/my-cluster.yaml

  Multi-context kubeconfig — auto-selected because one context references a cluster named my-cluster.

    $ codiac cluster credentials-set my-cluster --file ~/.kube/config

  Multi-context kubeconfig — explicit context when auto-selection is ambiguous.

    $ codiac cluster credentials-set my-cluster --file ~/.kube/config --context my-cluster-admin

  Pipe a kubeconfig in via stdin.

    cat ~/.kube/my-cluster.yaml | codiac cluster credentials-set my-cluster

  Non-interactive (scripted) invocation.

    $ codiac cluster credentials-set my-cluster --file ~/.kube/my-cluster.yaml --silent

codiac cluster define [NAME]​

Creates or updates a cluster metadata record (ClusterDef) without provisioning any physical infrastructure. Use this to register a cluster definition before running cod noc cluster restore, or to update metadata on a cluster that has no live instance. If the cluster already has a running instance, destroy it first (cod cluster destroy <name>), then redefine.

USAGE
  $ codiac cluster define [NAME] [-h] [--provider azure|aws|localMachine|other] [-s <value>] [-g <value>] [-l
    <value>] [-n <value>] [-q <value>] [--k8sVersion <value>] [--nodesMin <value>] [--nodesMax <value>] [-k <value>]
    [--networkPlugin kubenet|azure] [-u <value>] [--identityUserId <value>] [--take-defaults | [--silent | --echo |
    --to-script]]

ARGUMENTS
  NAME  Name of the cluster to define or update.

FLAGS
  -g, --resourceGroup=<value>         (Azure only, required) The resource group associated with the cluster.
  -h, --help                          Show CLI help.
  -k, --subnet=<value>...             (Optional) Resource Id of the subnet in which the cluster was or will be created.
  -l, --location=<value>              The short name of the regional data center where the cluster resides.
  -n, --nodeSpec=<value>              The VM size used for cluster nodes.
  -q, --nodeQty=<value>               [default: 2] Starting node count recorded in the cluster definition.
  -s, --providerSubscription=<value>  The cloud provider subscription Id (Azure) or account Id (AWS) for the cluster.
  -u, --identityUserName=<value>      (Optional) Name of the Service Principal or Managed Identity the cluster executes
                                      as.
  --echo                              Renders the equivalent non-interactive command for future use before executing.
  --identityUserId=<value>            (Optional) Id of the Service Principal or Managed Identity the cluster executes
                                      as.
  --k8sVersion=<value>                The version of Kubernetes the cluster runs.
  --networkPlugin=<option>            (Optional) Network plugin for the cluster.
                                      <options: kubenet|azure>
  --nodesMax=<value>                  Maximum number of nodes for autoscaling.
  --nodesMin=<value>                  Minimum number of nodes for autoscaling.
  --provider=<option>                 Cloud service provider on which the cluster resides or will reside.
                                      <options: azure|aws|localMachine|other>
  --silent                            Executes without any user interaction; fails on missing or invalid arguments.
  --take-defaults                     Prevents prompting for confirmation on parameters that were passed in or
                                      automatically set to default values.
  --to-script                         Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Creates or updates a cluster metadata record (ClusterDef) without provisioning any physical infrastructure. Use this
  to register a cluster definition before running `cod noc cluster restore`, or to update metadata on a cluster that has
  no live instance. If the cluster already has a running instance, destroy it first (`cod cluster destroy <name>`), then
  redefine.

ALIASES
  $ codiac cluster define

EXAMPLES
  Define a cluster interactively.

    $ codiac cluster define

  Define an Azure cluster non-interactively.

    $ codiac cluster define my-cluster --provider azure --providerSubscription <sub-id> --resourceGroup my-rg ^
      --location eastus --nodeSpec Standard_D4s_v3 --nodeQty 3 --k8sVersion 1.29.0 --silent

  Renders the equivalent silent command and then executes.

    $ codiac cluster define my-cluster --echo

  Renders the equivalent silent command without executing.

    $ codiac cluster define my-cluster --to-script

codiac cluster deinit​

Deinitialization of the cluster (uninstalls the ingress controller and tls cert manager services)

USAGE
  $ codiac cluster deinit [-h] [-n <value>] [-p artifactHub|aws|azure|dockerHub|localMachine|other] [--silent |
    --echo | --to-script]

FLAGS
  -h, --help               Show CLI help.
  -n, --name=<value>       Name of the cluster to deinitialize.
  -p, --provider=<option>  Code for the cloud service provider.
                           <options: artifactHub|aws|azure|dockerHub|localMachine|other>
  --echo                   Renders the equivalent non-interactive command for future use before executing.
  --silent                 Executes without any user interaction; fails on missing or invalid arguments.
  --to-script              Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Deinitialization of the cluster (uninstalls the ingress controller and tls cert manager services)

ALIASES
  $ codiac cluster deinit

EXAMPLES
  Deinitialize a cluster interactively.

    $ codiac cluster deinit

  Non-interactive invocation.

    $ codiac cluster deinit -n my-cluster --silent

  Renders the equivalent silent command without executing.

    $ codiac cluster deinit -n my-cluster --to-script

codiac cluster destroy [NAME]​

Kills the physical cluster, but not the Codiac cluster definition record

USAGE
  $ codiac cluster destroy [NAME] [-h] [-p artifactHub|aws|azure|dockerHub|localMachine|other] [-i] [-a] [-l] [-s |
    -e | -t] [-d]

ARGUMENTS
  NAME  Name of cluster to destroy

FLAGS
  -a, --partials           OPTIONAL: Include clusters that were never fully created.
  -d, --take-defaults      Takes all defaults for prompts.
  -e, --echo               Prints the command that would be executed, but does not execute it.
  -h, --help               Show CLI help.
  -i, --deleteIdentity     OPTIONAL: Ensures that identity security account for the cluster shall also be deleted after
                           the cluster itself is destroyed.
  -l, --local              OPTIONAL: Include only clusters that reside locally on this machine.
  -p, --provider=<option>  REQUIRED: Code for the cloud service provider.
                           <options: artifactHub|aws|azure|dockerHub|localMachine|other>
  -s, --silent             Runs the command in silent mode. Requires --name and --provider flags.
  -t, --to-script          Prints the command that would be executed and exits.

DESCRIPTION
  Kills the physical cluster, but not the Codiac cluster definition record

ALIASES
  $ codiac cluster destroy

codiac cluster forget​

Permanently removes the record of a cluster. This command does NOT affect any infrastructure; it simply removes the cluster from the Codiac consciousness. You must remove all cabinets and environments in a cluster before forgetting it.

USAGE
  $ codiac cluster forget [-r] [--forget-cabinets] [-y -n <value> -p
    artifactHub|aws|azure|dockerHub|localMachine|other]

FLAGS
  -n, --name=<value>       Name of the cluster.
  -p, --provider=<option>  Code for the cloud service provider.
                           <options: artifactHub|aws|azure|dockerHub|localMachine|other>
  -r, --running            Include clusters that still have a running instance.
  -y, --silent             (Optional: defaults to false) Prevents confirmations of user-values. Required: ["name",
                           "provider"]
  --forget-cabinets        Permanently delete cabinet records instead of just orphaning them (clearing the cluster
                           assignment).

DESCRIPTION
  Permanently removes the record of a cluster.  This command does NOT affect any infrastructure; it simply removes the
  cluster from the Codiac consciousness. You must remove all cabinets and environments in a cluster before forgetting
  it.

ALIASES
  $ codiac cluster forget

EXAMPLES
  Forget a cluster using interactive prompts:

    $ codiac cluster forget

  Forget an aws cluster:

    $ codiac cluster forget --provider aws --name my-cluster

  Forget an azure cluster:

    $ codiac cluster forget --provider azure --name my-other-cluster

  Forget an azure cluster in silent mode:

    $ codiac cluster forget --provider azure --name my-other-cluster --silent

  Forget a cluster that is not destroyed yet:

    $ codiac cluster forget --running

codiac cluster grant​

(AWS Only) Provides cluster access to the given user.

USAGE
  $ codiac cluster grant [-h] [-c <value>] [-u <value>] [--silent | --echo | --to-script]

FLAGS
  -c, --cluster=<value>  Name of the cluster to grant access on.
  -h, --help             Show CLI help.
  -u, --user=<value>     AWS username (as email) to add.
  --echo                 Renders the equivalent non-interactive command for future use before executing.
  --silent               Executes without any user interaction; fails on missing or invalid arguments.
  --to-script            Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  (AWS Only) Provides cluster access to the given user.

ALIASES
  $ codiac cluster grant

EXAMPLES
  Grant cluster access interactively.

    $ codiac cluster grant

  Non-interactive invocation.

    $ codiac cluster grant -c my-cluster -u user@example.com --silent

  Renders the equivalent silent command without executing.

    $ codiac cluster grant -c my-cluster -u user@example.com --to-script

codiac cluster init​

Post-create initialization for the cluster (installs the ingress controller service)

USAGE
  $ codiac cluster init [-h] [-n <value>] [-p artifactHub|aws|azure|dockerHub|localMachine|other] [--adjust]
    [--silent | --echo | --to-script]

FLAGS
  -h, --help               Show CLI help.
  -n, --name=<value>       Name of the cluster to initialize.
  -p, --provider=<option>  Code for the cloud service provider.
                           <options: artifactHub|aws|azure|dockerHub|localMachine|other>
  --adjust                 Invokes interactive user-interface to make changes to the initialization specs even when
                           specs already exist.
  --echo                   Renders the equivalent non-interactive command for future use before executing.
  --silent                 Executes without any user interaction; fails on missing or invalid arguments.
  --to-script              Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Post-create initialization for the cluster (installs the ingress controller service)

ALIASES
  $ codiac cluster init

EXAMPLES
  Initialize a cluster interactively.

    $ codiac cluster init

  Adjust ingress spec on an already-initialized cluster.

    $ codiac cluster init --adjust

  Non-interactive invocation.

    $ codiac cluster init -n my-cluster --silent

  Renders the equivalent silent command without executing.

    $ codiac cluster init -n my-cluster --to-script

codiac cluster install [CLUSTER]​

Deploys a given asset version to a cluster cabinet, using the async deployment pipeline.

USAGE
  $ codiac cluster install [CLUSTER] [-h] [-e <value>] [-u <value> -a <value>] [--wait] [--silent | --echo |
    --to-script]

ARGUMENTS
  CLUSTER  Name of the cluster to deploy to.

FLAGS
  -a, --asset=<value>       Name of the asset to deploy.
  -e, --enterprise=<value>  Code name of the infrastructure enterprise to target.
  -h, --help                Displays the help document for this command.
  -u, --version=<value>     Version of the asset to deploy.
  --echo                    Echo interaction mode; renders the equivalent non-interactive cli command for future use
                            before final execution.
  --silent                  Non-Interactive mode; executes without any user interaction and fails on any missing or
                            invalid arguments.
  --to-script               Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                            execution.
  --wait                    Wait for all chart/asset startup to complete before returning. When omitted, returns
                            immediately without blocking on chart readiness.

DESCRIPTION
  Deploys a given asset version to a cluster cabinet, using the async deployment pipeline.

EXAMPLES
  Deploy an asset to a cluster.

    $ codiac cluster install my-cluster -a my-chart -u 1.2.3

  Deploy and wait for chart startup to complete.

    $ codiac cluster install my-cluster -a my-chart -u 1.2.3 --wait

  Non-interactive (scripted) invocation.

    $ codiac cluster install my-cluster -a my-chart -u 1.2.3 --silent

See code: dist/commands/cluster/install.ts

codiac cluster journal [CLUSTER]​

Shows the setup journal for the given cluster. The journal outlines the individual components that were created in the CSP subscription (Cloud Service Provider) comprising the cluster.

USAGE
  $ codiac cluster journal [CLUSTER] [-o json|yaml|pretty] [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  CLUSTER  Name of the cluster in Codiac.  You can use `cod cluster list` to see the names of your codiac clusters.

FLAGS
  -o, --output=<option>  [default: pretty] format in which to render the data.
                         <options: json|yaml|pretty>
  --echo                 Echo interaction mode; renders the equivalent non-interactive cli command for future use before
                         final execution.
  --silent               Non-Interactive mode; executes without any user interaction and fails on any missing or invalid
                         arguments.
  --take-defaults        Setting this to true prevents prompting for confirmation on parameters that were passed in or
                         were automatically set to default values (Irrelevant in --silent mode).  This behavior does NOT
                         apply to scenarios that the command needs to override invalid user input; such cases will
                         always prompt for confirmation.  eg: when no argument was provided for file or type, and only
                         one exists, the system will render the autoselected file unless this flag is set.
  --to-script            Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                         execution.

DESCRIPTION
  Shows the setup journal for the given cluster.  The journal outlines the individual components that were created in
  the CSP subscription (Cloud Service Provider) comprising the cluster.

ALIASES
  $ codiac cluster journal

EXAMPLES
  $ codiac cluster journal

  $ codiac cluster journal --echo

  $ codiac cluster journal dev-west-aws-02

  $ codiac cluster journal -o yaml dev-west-aws-02

  $ codiac cluster journal -o yaml --silent dev-west-aws-02

  $ codiac cluster journal -o yaml --silent dev-west-aws-02 > myfiles/journal.yaml

codiac cluster list​

Shows the list of clusters.

USAGE
  $ codiac cluster list [-h] [-e <value>] [-o text|tree|json|yaml|tsv|csv] [-q <value>] [--silent | --echo |
    --to-script]

FLAGS
  -e, --enterpriseCode=<value>  Code name of the enterprise to target.
  -h, --help                    Show CLI help.
  -o, --output=<option>         Format in which to render the results.
                                <options: text|tree|json|yaml|tsv|csv>
  -q, --query=<value>           JMESPath expression to filter or reshape the results (see jmespath.org).
  --echo                        Renders the equivalent non-interactive command for future use before executing.
  --silent                      Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                   Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Shows the list of clusters.

ALIASES
  $ codiac cluster list

EXAMPLES
  Simple listing.

    $ codiac cluster list

  List of cluster names only.

    $ codiac cluster list -q '[].name'

  Multi-property projection.

    $ codiac cluster list -q '[].{ name: name, loc: locationName }'

  Filter by name.

    $ codiac cluster list -q "[?name == 'my-cluster-on-aws']"

  Show name and location, sorted by location.

    $ codiac cluster list -q "[].{ name: name, loc: locationName } | sort_by(@, &loc)"

  Export as YAML.

    $ codiac cluster list -o yaml

  Non-interactive invocation.

    $ codiac cluster list -e myEnterprise --silent

  Renders the equivalent silent command without executing.

    $ codiac cluster list -e myEnterprise --to-script

codiac cluster provision [NAME]​

Provisions the physical cluster

USAGE
  $ codiac cluster provision [NAME] [-h] [--provider azure|aws|localMachine] [-s <value>] [-g <value>] [-l <value>] [-q
    <value>] [--k8sVersion <value>] [-k <value>] [--networkPlugin kubenet|azure] [-n <value>] [-u <value>]
    [--identityUserId <value>] [--nodesMin <value>] [--nodesMax <value>] [--init] [--take-defaults | [--silent | --echo
    | --to-script]]

ARGUMENTS
  NAME  Proposed name of the cluster

FLAGS
  -g, --resourceGroup=<value>         (Required in silent mode) The Azure resource group to create for the cluster.
  -h, --help                          Show CLI help.
  -k, --subnet=<value>...             OPTIONAL: The resource id of the subnet in which the cluster is to be created.
  -l, --location=<value>              (Required in silent mode) The short name of the azure data center in which the
                                      cluster is to reside.
  -n, --nodeSpec=<value>              The identifier for the type of VM to use for nodes in the cluster.
  -q, --nodeQty=<value>               [default: 2] (Required in silent mode) The starting node count with which to
                                      create the cluster.
  -s, --providerSubscription=<value>  (Required in silent mode) The Azure subscription Id under which to create the
                                      cluster.
  -u, --identityUserName=<value>      OPTIONAL. Name of Svc Principal or Managed Identity to execute as.
  --echo                              Echo interaction mode; renders the equivalent non-interactive cli command for
                                      future use before final execution.
  --identityUserId=<value>            OPTIONAL. ID of Svc Principal or Managed Identity to execute as.
  --[no-]init                         Automatically initialize cluster after creation (use --no-init to skip).
  --k8sVersion=<value>                (Required in silent mode) The version of Kubernetes to install on the cluster.
  --networkPlugin=<option>            OPTIONAL: The network plugin for the cluster (kubenet, azure). Defaults to
                                      kubenet.
                                      <options: kubenet|azure>
  --nodesMax=<value>                  OPTIONAL. The maximum number of nodes to maintain in the cluster.
  --nodesMin=<value>                  OPTIONAL. The minimum number of nodes to maintain in the cluster.
  --provider=<option>                 (Required in silent mode) Cloud service provider on which to provision the cluster
                                      <options: azure|aws|localMachine>
  --silent                            Non-Interactive mode; executes without any user interaction and fails on any
                                      missing or invalid arguments.
  --take-defaults                     Setting this to true prevents prompting for confirmation on parameters that were
                                      passed in or were automatically set to default values (Irrelevant in --silent
                                      mode).
  --to-script                         Toscript interaction mode; renders the equivalent non-interactive cli command
                                      WITHOUT any execution.

DESCRIPTION
  Provisions the physical cluster

ALIASES
  $ codiac cluster provision
  $ codiac cluster create

EXAMPLES
  Create a cluster interatively.

    cod cluster create my-cluster

  Create a cluster interatively and assemble a non-interactive command string.

    cod cluster create my-cluster --echo

  Assemble a non-interactive command string WITHOUT actually creating a cluster (dry run).

    cod cluster create my-cluster --to-script

  Create a cluster silently.

    cod cluster create my-cluster --provider azure --providerSubscription 12345678-1234-1234-1234-123456789012 ^
      --resourceGroup my-rg --location eastus --nodeSpec Standard_DS2_v2 --nodeQty 2 --silent

  Create a cluster silently with all available options (NOTE: you can generate this command using --to-script)

    cod cluster create my-comprehensive-cluster --provider azure --providerSubscription ^
      12345678-1234-1234-1234-123456789012 --resourceGroup my-resource-group --location eastus2 --nodeSpec ^
      Standard_D2s_v3 --nodeQty 3 --k8sVersion 1.21.2 --networkPlugin azure --nodesMin 2 --nodesMax 5 --owner ^
      my-tenant-code --subnet /subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/my-vnet-rg/providers/ ^
      Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet --identityUserName my-service-principal ^
      --identityUserId 87654321-4321-4321-4321-210987654321 --identityUserPassword mySecurePassword123! --silent

FLAG DESCRIPTIONS
  --[no-]init  Automatically initialize cluster after creation (use --no-init to skip).

    By default, the cluster creation command automatically runs `init-cluster`. Use this flag to skip the initialization
    step and leave the cluster in a non-initialized state. Not applicable when invoked as `cluster:provision` —
    initialization is always skipped in that mode.

codiac cluster recreate [NAME]​

Provisions the physical cluster using the existing ClusterDef record (with any changes provided by the caller).

USAGE
  $ codiac cluster recreate [NAME] [-h] [-p <value>] [-s <value>] [-g <value>] [-l <value>] [-k <value>] [-v <value>]
    [-w -n <value> -q <value>] [--identityName <value>] [--silent | --echo | --to-script]

ARGUMENTS
  NAME  Name of an existing cluster to re-create.

FLAGS
  -g, --resourceGroup=<value>         The Azure resource group to create for the cluster.
  -h, --help                          Show CLI help.
  -k, --subnet=<value>                The resource id of the subnet in which the cluster is to be created.
  -l, --location=<value>              The short name of the azure data center in which the cluster is to reside.
  -n, --nodeSpec=<value>              The identifier for the type of VM to use for nodes in the cluster.
  -p, --owner=<value>                 Tenant code of the private owner of the cluster.
  -q, --nodeQty=<value>               The starting node count with which to create the cluster.
  -s, --providerSubscription=<value>  The Azure subscription Id under which to create the cluster.
  -v, --k8sVersion=<value>            The Kubernetes version for the new cluster. This must be a supported version from
                                      the cloud provider.
  -w, --windowsSupport                Add a windows nodepool.
  --echo                              Renders the equivalent non-interactive command for future use before executing.
  --identityName=<value>              Name of an existing service principal to use for the cluster identity.
  --silent                            Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                         Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Provisions the physical cluster using the existing ClusterDef record (with any changes provided by the caller).

ALIASES
  $ codiac cluster recreate

EXAMPLES
  Re-create a cluster interactively.

    $ codiac cluster recreate

  Re-create a specific cluster.

    $ codiac cluster recreate my-cluster --silent

  Renders the equivalent silent command without executing.

    $ codiac cluster recreate my-cluster --to-script

codiac cluster restore [NAME]​

Restores a cluster to fully operational state from its existing ClusterDef: provisions cloud infrastructure, installs the Codiac agent, installs infrx stacks, and restores all SDLC cabinets. Pass --no-provision to re-run bootstrap only on an already-provisioned cluster.

USAGE
  $ codiac cluster restore [NAME] [--no-provision] [--no-agent] [--no-infrx] [--no-cabinets] [-e <value>] [--silent |
    --echo | --to-script]

ARGUMENTS
  NAME  Name of the cluster to restore.

FLAGS
  -e, --enterprise=<value>  Scope cabinet restore to a specific enterprise. When omitted, all enterprises are restored.
  --echo                    Echo interaction mode; renders the equivalent non-interactive command before executing.
  --no-agent                Skip Codiac agent installation. Also skips infrx and cabinet restore.
  --no-cabinets             Skip SDLC cabinet restore. Provision, agent, and infrx still run.
  --no-infrx                Skip infrx stack installation. Also skips cabinet restore.
  --no-provision            Skip cloud infrastructure provisioning. The cluster must already have a live instance. Use
                            this to re-run bootstrap on an existing cluster.
  --silent                  Non-interactive mode; executes without any user interaction and fails on any missing or
                            invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing.

DESCRIPTION
  Restores a cluster to fully operational state from its existing ClusterDef: provisions cloud infrastructure, installs
  the Codiac agent, installs infrx stacks, and restores all SDLC cabinets. Pass --no-provision to re-run bootstrap only
  on an already-provisioned cluster.

ALIASES
  $ codiac cluster restore

EXAMPLES
  Full restore interactively.

    $ codiac cluster restore

  Full restore of a specific cluster.

    $ codiac cluster restore prod-cluster-1 --silent

  Re-run bootstrap only (cluster already provisioned).

    $ codiac cluster restore prod-cluster-1 --no-provision --silent

  Provision and agent only (skip infrx and cabinets).

    $ codiac cluster restore prod-cluster-1 --no-infrx --no-cabinets --silent

  Restore scoped to one enterprise.

    $ codiac cluster restore prod-cluster-1 --enterprise acme --silent

  Render the equivalent silent command without executing.

    $ codiac cluster restore prod-cluster-1 --to-script

codiac cluster stack capture [NAME]​

Fetches, creates, and configures each component of the built-in cluster stack. This command only has to be run once for any given cluster stack. NOTE: running this command will load the given cluster stack into your infrx enterprise and overwrite any existing assets that match by name and any matching settings at the enterprise level. This command does not delete any existing settings. NOTE: This command DOES NOT directly modify any clusters. It only loads asset and config records into Codiac for the infrx enterprise.

USAGE
  $ codiac cluster stack capture [NAME] [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  NAME  (optional, defaults to the Codiac builtin stack) Name of the cluster stack. Versions are selected later at
        tagging time and cluster install time.

FLAGS
  --echo           Echo interaction mode; renders the equivalent non-interactive cli command for future use before final
                   execution.
  --silent         Non-Interactive mode; executes without any user interaction and fails on any missing or invalid
                   arguments.
  --take-defaults  Setting this to true prevents prompting for confirmation on parameters that were passed in or were
                   automatically set to default values (Irrelevant in --silent mode).  This behavior does NOT apply to
                   scenarios that the command needs to override invalid user input; such cases will always prompt for
                   confirmation.  eg: when no argument was provided for file or type, and only one exists, the system
                   will render the autoselected file unless this flag is set.
  --to-script      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Fetches, creates, and configures each component of the built-in cluster stack.  This command only has to be run once
  for any given cluster stack.  NOTE: running this command will load the given cluster stack into your infrx enterprise
  and overwrite any existing assets that match by name and any matching settings at the enterprise level.  This command
  does not delete any existing settings.  NOTE:  This command DOES NOT directly modify any clusters.  It only loads
  asset and config records into Codiac for the infrx enterprise.

EXAMPLES
  $ codiac cluster stack capture my-fav-cluster

See code: dist/commands/cluster/stack/capture.ts

codiac cluster stack install [CLUSTER]​

Installs the cluster stack on the given cluster, deploying all infrastructure workloads defined in the stack snapshot.

USAGE
  $ codiac cluster stack install [CLUSTER] [-h] [-e <value>] [-v <value>] [--wait] [--silent | --echo | --to-script]

ARGUMENTS
  CLUSTER  Name of the cluster on which to install the stack.

FLAGS
  -e, --enterprise=<value>  Code name of the infrastructure enterprise to target.
  -h, --help                Displays the help document for this command.
  -v, --version=<value>     Version of the cluster stack snapshot to install. Omit to install the default-tagged
                            version.
  --echo                    Echo interaction mode; renders the equivalent non-interactive cli command for future use
                            before final execution.
  --silent                  Non-Interactive mode; executes without any user interaction and fails on any missing or
                            invalid arguments.
  --to-script               Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                            execution.
  --wait                    Wait for all helm chart startups to complete before returning. When omitted, helm installs
                            return immediately without blocking on chart readiness.

DESCRIPTION
  Installs the cluster stack on the given cluster, deploying all infrastructure workloads defined in the stack snapshot.

EXAMPLES
  Install the default-tagged cluster stack version.

    $ codiac cluster stack install my-cluster

  Install a specific cluster stack version.

    $ codiac cluster stack install my-cluster --version 5CJRH7XB

  Non-interactive (scripted) invocation.

    $ codiac cluster stack install my-cluster --silent

  Renders the equivalent silent command and then executes.

    $ codiac cluster stack install my-cluster --echo

  Render the equivalent silent command without executing.

    $ codiac cluster stack install my-cluster --to-script

See code: dist/commands/cluster/stack/install.ts

codiac cluster stack list​

Shows the list of snapshots (enterprise version configs) in a given enterprise.

USAGE
  $ codiac cluster stack list [-h] [-e <value>] [-o json|yaml|tree|text] [-q <value>] [--silent | --echo | --to-script]

FLAGS
  -e, --enterprise=<value>  The name of the enterprise containing the snapshots (defaults to the current enterprise
                            context).
  -h, --help                Show CLI help.
  -o, --output=<option>     Format in which to render the results (defaults to tree).
                            <options: json|yaml|tree|text>
  -q, --query=<value>       JMESPath expression to filter or reshape the results (see jmespath.org).
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Shows the list of snapshots (enterprise version configs) in a given enterprise.

ALIASES
  $ codiac cluster stack list

EXAMPLES
  List all snapshots for the current enterprise.

    $ codiac cluster stack list

  List snapshots for a specific enterprise.

    $ codiac cluster stack list -e myEnterprise

  List snapshot versions only.

    $ codiac cluster stack list -q '[].version'

  Export as YAML.

    $ codiac cluster stack list -o yaml

  Non-interactive (scripted) invocation.

    $ codiac cluster stack list -e myEnterprise --silent

codiac cluster start [CLUSTER]​

For local machine clusters only. (Idempotent) Ensures that the specified local machine cluster is running and not inactive. Clusters can consume significant local resources, since they cannot be scaled like they can in the cloud, so this command and cluster stop together enable a user to determine which a clusters are actually running or not at any given time.

USAGE
  $ codiac cluster start [CLUSTER] [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  CLUSTER  Name of the LOCAL cluster in Codiac (Optional: required only if you have more than one cluster for the
           current organization on this machine).  You can use `cod cluster list` to see the names of your codiac
           clusters.

FLAGS
  --echo           Echo interaction mode; renders the equivalent non-interactive cli command for future use before final
                   execution.
  --silent         Non-Interactive mode; executes without any user interaction and fails on any missing or invalid
                   arguments.
  --take-defaults  Setting this to true prevents prompting for confirmation on parameters that were passed in or were
                   automatically set to default values (Irrelevant in --silent mode).  This behavior does NOT apply to
                   scenarios that the command needs to override invalid user input; such cases will always prompt for
                   confirmation.  eg: when no argument was provided for file or type, and only one exists, the system
                   will render the autoselected file unless this flag is set.
  --to-script      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  For local machine clusters only.  (Idempotent) Ensures that the specified local machine cluster is running and not
  inactive.  Clusters can consume significant local resources, since they cannot be scaled like they can in the cloud,
  so this command and `cluster stop` together enable a user to determine which a clusters are actually running or not at
  any given time.

EXAMPLES
  $ codiac cluster start my-fav-cluster

See code: dist/commands/cluster/start.ts

codiac cluster stop [CLUSTER]​

For local machine clusters only. (Idempotent) Ensures that the specified local machine cluster is running and not inactive. Clusters can consume significant local resources, since they cannot be scaled like they can in the cloud, so this command and cluster stop together enable a user to determine which a clusters are actually running or not at any given time.

USAGE
  $ codiac cluster stop [CLUSTER] [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  CLUSTER  Name of the LOCAL cluster in Codiac (Optional: required only if you have more than one cluster for the
           current organization on this machine).  You can use `cod cluster list` to see the names of your codiac
           clusters.

FLAGS
  --echo           Echo interaction mode; renders the equivalent non-interactive cli command for future use before final
                   execution.
  --silent         Non-Interactive mode; executes without any user interaction and fails on any missing or invalid
                   arguments.
  --take-defaults  Setting this to true prevents prompting for confirmation on parameters that were passed in or were
                   automatically set to default values (Irrelevant in --silent mode).  This behavior does NOT apply to
                   scenarios that the command needs to override invalid user input; such cases will always prompt for
                   confirmation.  eg: when no argument was provided for file or type, and only one exists, the system
                   will render the autoselected file unless this flag is set.
  --to-script      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  For local machine clusters only.  (Idempotent) Ensures that the specified local machine cluster is running and not
  inactive.  Clusters can consume significant local resources, since they cannot be scaled like they can in the cloud,
  so this command and `cluster stop` together enable a user to determine which a clusters are actually running or not at
  any given time.

EXAMPLES
  $ codiac cluster start my-fav-cluster

See code: dist/commands/cluster/stop.ts

codiac cluster uninstall​

UN-deploys a given asset from a given cabinet. Defaults to removing only the pod deployments and leaving the service in place; set the --scorch argument to remove the service.

USAGE
  $ codiac cluster uninstall [-h] [-e <value>] [-c <value>] [-a <value>] [-v <value>] [-s] [--silent | --echo |
    --to-script]

FLAGS
  -a, --asset=<value>       Search string for the name of the asset to destroy (use ? to be prompted).
  -c, --cabinet=<value>     Name of the cabinet from which the asset is to be removed.
  -e, --enterprise=<value>  Code (name) of the enterprise to work with (optional: required only when asset name is not
                            unique across enterprises).
  -h, --help                Show CLI help.
  -s, --scorch              Destroys the service too, instead of just the deployment and pods.
  -v, --version=<value>     Search string for the version of the asset to destroy (use ? to be prompted).
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  UN-deploys a given asset from a given cabinet.  Defaults to removing only the pod deployments and leaving the service
  in place; set the --scorch argument to remove the service.

ALIASES
  $ codiac cluster uninstall

EXAMPLES
  Undeploy interactively.

    $ codiac cluster uninstall

  Undeploy a specific asset from a specific cabinet.

    $ codiac cluster uninstall -e myEnterprise -a myApi -c dev --silent

  Renders the equivalent silent command without executing.

    $ codiac cluster uninstall -e myEnterprise -a myApi -c dev --to-script

codiac commit [MESSAGE]​

Commits the currently staged changes on the current branch of the main project and on any sourced dependencies.

USAGE
  $ codiac commit [MESSAGE] [-h]

ARGUMENTS
  MESSAGE  The description to include in this particular commit.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Commits the currently staged changes on the current branch of the main project and on any sourced dependencies.

See code: dist/commands/commit.ts

codiac config add​

Adds a key value pair to the app config

USAGE
  $ codiac config add [-h] [-n <value>] [-a <value>] [-s | -e <value> | -c <value>] [--entire-file | --setting
    <value> | [-t
    annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onpredeploy|permit|probing | -f
    <value>]] [--value <value>] [--condition <value>] [--value-stdin ] [--take-defaults | [--silent | --echo |
    --to-script]]

FLAGS
  -a, --asset=<value>
      The name of the asset to which the settings belong.

  -c, --cabinet=<value>
      The name of the cabinet to which this value is to apply.

  -e, --enviro=<value>
      The name of the environment to which this value is to apply.

  -f, --file=<value>
      The path-name to the file to which the settings are written, relative to the root of the Codiac project.

  -h, --help
      Show CLI help.

  -n, --enterprise=<value>
      (required only when more than one enterprise exists) The name of the enterprise containing the asset.

  -s, --enterprise-scope
      Filters for settings scoped at the enterprise level.

  -t, --type=<option>
      Filters for the settings types that do not land in a config file (such as... env: OS environment variables,
      footprint: container footprint specs, helm: helm chart settings, label: container meta labels, annotation: container
      platform key-value pairs).
      <options: annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onpredeploy|permit|probing>

  --condition=<value>
      Jsonata Expression to determine whether to include this setting, applied against the built-in asset-version
      expression context (see https://jsonata.org for syntax).

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --entire-file
      Declares that the entire config doc content shall consist only of the value of this setting.  If the system
      encounters this argument while assembling configs, it will ignore any other settings applied to the given target
      file.

  --setting=<value>
      The config key (in dotpath/JSONPath), relative to the root of the config.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

  --value=<value>
      The actual concrete data to be applied as the setting value.

  --value-stdin
      (for type=file only) Reads the actual concrete data to be applied as the setting value from the stdin io stream (see
      the help for examples).

DESCRIPTION
  Adds a key value pair to the app config

ALIASES
  $ codiac config set
  $ codiac cfg add

EXAMPLES
  Apply a setting interactively

    cod config set

  Apply a setting interactively and assemble a non-interactive command string.

    cod config set --echo

  Assemble a non-interactive command string WITHOUT actually applying any settings (dry run).

    cod config set --to-script

  Set the value of an individual setting to the contents of a file on your local machine

    cat template.htm | cod config set -a api -c dev -f '/alert-settings.json' --setting 'email-body' --value-stdin

  Set the entire file content to the content of a file on your local machine

    cat way-too-much.xml | cod config set -a api -c dev -f '/datapoints.xml' --entire-file --value-stdin

  Set the entire file content to the value of a secret

    cod config set -a api -c dev -f '/some-managed-service.pem' --entire-file --value ^
      '#REF|azKeyVault|our-secret-store|some-managed-svc-cert'

See code: dist/commands/config/add.ts

codiac config delete [SETTING]​

Removes the given keys from the app config

USAGE
  $ codiac config delete [SETTING] [-n <value>] [-a <value>] [-f <value> | -t
    annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onpredeploy|permit|probing] [-s | -e
    <value> | -c <value>] [-s <value>] [--take-defaults | [--silent | --echo | --to-script]] [-h]

ARGUMENTS
  SETTING  (optional) Specific config key to remove. Omit to select from a list. Enter "all" to clear the entire config.

FLAGS
  -a, --asset=<value>
      The name of the asset to which the settings belong.

  -c, --cabinet=<value>
      Filters for settings scoped to the given cabinet name.

  -e, --enviro=<value>
      Filters for settings scoped to the given environment name.

  -f, --file=<value>
      The path-name to the config file holding the settings, relative to the root of the Codiac project.

  -h, --help
      Displays the help document for this command.

  -n, --enterprise=<value>
      (required only when more than one enterprise exists) The name of the enterprise containing the asset.

  -s, --enterprise-scope
      Filters for settings scoped at the enterprise level.

  -s, --setting=<value>...
      The config key (in dotpath/JSONPath), relative to the root of the config. eg: `database.name` or
      `database.connectionString`

  -t, --type=<option>
      Filters for the settings types that do not land in a config file (such as... env: OS environment variables,
      footprint: container footprint specs, helm: helm chart settings, label: container meta labels, annotation: container
      platform key-value pairs).
      <options: annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onpredeploy|permit|probing>

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Removes the given keys from the app config

ALIASES
  $ codiac cfg delete

See code: dist/commands/config/delete.ts

codiac config deploy​

Deploys a given asset config to a given cabinet.

USAGE
  $ codiac config deploy [-h] [-e <value>] [-c <value>] [-a <value>] [-v <value>] [--silent | --echo | --to-script]

FLAGS
  -a, --asset=<value>           Name of the asset to deploy configs for (use ? to be prompted).
  -c, --cabinetName=<value>     Target cabinet name to deploy configs to.
  -e, --enterpriseCode=<value>  Code name of the enterprise to target.
  -h, --help                    Show CLI help.
  -v, --version=<value>         Version of the asset to deploy configs for.
  --echo                        Renders the equivalent non-interactive command for future use before executing.
  --silent                      Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                   Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Deploys a given asset config to a given cabinet.

EXAMPLES
  Deploy configs interactively.

    $ codiac config deploy

  Deploy configs for a specific asset.

    $ codiac config deploy -e myEnterprise -a myApi -c dev

  Non-interactive (scripted) invocation.

    $ codiac config deploy -e myEnterprise -a myApi -c dev --silent

  Renders the equivalent silent command without executing.

    $ codiac config deploy -e myEnterprise -a myApi -c dev --to-script

See code: dist/commands/config/deploy.ts

codiac config import​

Imports a local config file, overlaying its settings into the Codiac config store.

USAGE
  $ codiac config import [-h] [-n <value> | -e <value> | -c <value>] [-a <value>] [-s <value>] [-f <value>]
    [--silent | --echo | --to-script]

FLAGS
  -a, --asset=<value>         Name of the asset for which to import the config (use ? to be prompted).
  -c, --cabinet=<value>       The name of the cabinet scope to which this import applies.
  -e, --environment=<value>   The name of the environment scope to which this import applies.
  -f, --runtime-path=<value>  The pathname relative to the app root to assume in the container (optional; defaults to
                              the source filename).
  -h, --help                  Show CLI help.
  -n, --enterprise=<value>    The name of the enterprise scope to which this import applies.
  -s, --sourceFile=<value>    The local path of the file to import (absolute, or relative to the current working
                              directory).
  --echo                      Renders the equivalent non-interactive command for future use before executing.
  --silent                    Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                 Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Imports a local config file, overlaying its settings into the Codiac config store.

ALIASES
  $ codiac cfg add

EXAMPLES
  Import a config file interactively.

    $ codiac config import

  Import a specific file at enterprise scope.

    $ codiac config import -a myApi -s ./dist/app-config.json -n myEnterprise

  Import at cabinet scope.

    $ codiac config import -a myApi -s ./dist/app-config.json -c dev

  Non-interactive (scripted) invocation.

    $ codiac config import -a myApi -s ./dist/app-config.json -n myEnterprise --silent

  Renders the equivalent silent command without executing.

    $ codiac config import -a myApi -s ./dist/app-config.json -n myEnterprise --to-script

See code: dist/commands/config/import.ts

codiac config preview [SETTING]​

Retrieves a pre-deploy preview of the ultimate configuration file contents for the given cabinet (with all inline variables and source references resolved).

USAGE
  $ codiac config preview [SETTING] [-h] [-e <value>] [-a <value>] [-c <value>] [-t
    annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onpredeploy|permit|probing | -f
    <value>] [-o pretty|json|yaml|auto] [-p] [--silent | --echo | --to-script]

ARGUMENTS
  SETTING  (optional) Name of a specific setting to view; omit to show all.

FLAGS
  -a, --asset=<value>       Name of the asset to view configs for (use ? to be prompted).
  -c, --cabinet=<value>     The name of the cabinet to assemble the configuration for.
  -e, --enterprise=<value>  The name of the enterprise that contains the asset (defaults to the current enterprise
                            context).
  -f, --file=<value>        The relative pathname of the config file to view, relative to the root of the codiac project
                            (defaults to app-config.json).
  -h, --help                Show CLI help.
  -o, --output=<option>     Format in which to render the config document (defaults to auto).
                            <options: pretty|json|yaml|auto>
  -p, --prompt              Forces a prompt to select from the existing settings.
  -t, --type=<option>       The type of settings to view (env: OS environment variables, footprint: container footprint
                            specs, helm: helm chart settings, label: container meta labels, annotation: container
                            platform key-value pairs).
                            <options: annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onpr
                            edeploy|permit|probing>
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Retrieves a pre-deploy preview of the ultimate configuration file contents for the given cabinet (with all inline
  variables and source references resolved).

ALIASES
  $ codiac config preview
  $ codiac cfg preview

EXAMPLES
  View config for the current asset interactively.

    $ codiac config preview

  View a specific cabinet's config in pretty format.

    $ codiac config preview -c dev2 -f settings.json -o pretty

  View a specific non-file config type.

    $ codiac config preview -c dev2 -a myapi -t footprint

  Non-interactive (scripted) invocation.

    $ codiac config preview -e myEnterprise -a myApi -c dev --silent

  Renders the equivalent silent command without executing.

    $ codiac config preview -e myEnterprise -a myApi -c dev --to-script

codiac config set​

Adds a key value pair to the app config

USAGE
  $ codiac config set [-h] [-n <value>] [-a <value>] [-s | -e <value> | -c <value>] [--entire-file | --setting
    <value> | [-t
    annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onpredeploy|permit|probing | -f
    <value>]] [--value <value>] [--condition <value>] [--value-stdin ] [--take-defaults | [--silent | --echo |
    --to-script]]

FLAGS
  -a, --asset=<value>
      The name of the asset to which the settings belong.

  -c, --cabinet=<value>
      The name of the cabinet to which this value is to apply.

  -e, --enviro=<value>
      The name of the environment to which this value is to apply.

  -f, --file=<value>
      The path-name to the file to which the settings are written, relative to the root of the Codiac project.

  -h, --help
      Show CLI help.

  -n, --enterprise=<value>
      (required only when more than one enterprise exists) The name of the enterprise containing the asset.

  -s, --enterprise-scope
      Filters for settings scoped at the enterprise level.

  -t, --type=<option>
      Filters for the settings types that do not land in a config file (such as... env: OS environment variables,
      footprint: container footprint specs, helm: helm chart settings, label: container meta labels, annotation: container
      platform key-value pairs).
      <options: annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onpredeploy|permit|probing>

  --condition=<value>
      Jsonata Expression to determine whether to include this setting, applied against the built-in asset-version
      expression context (see https://jsonata.org for syntax).

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --entire-file
      Declares that the entire config doc content shall consist only of the value of this setting.  If the system
      encounters this argument while assembling configs, it will ignore any other settings applied to the given target
      file.

  --setting=<value>
      The config key (in dotpath/JSONPath), relative to the root of the config.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

  --value=<value>
      The actual concrete data to be applied as the setting value.

  --value-stdin
      (for type=file only) Reads the actual concrete data to be applied as the setting value from the stdin io stream (see
      the help for examples).

DESCRIPTION
  Adds a key value pair to the app config

ALIASES
  $ codiac config set
  $ codiac cfg add

EXAMPLES
  Apply a setting interactively

    cod config set

  Apply a setting interactively and assemble a non-interactive command string.

    cod config set --echo

  Assemble a non-interactive command string WITHOUT actually applying any settings (dry run).

    cod config set --to-script

  Set the value of an individual setting to the contents of a file on your local machine

    cat template.htm | cod config set -a api -c dev -f '/alert-settings.json' --setting 'email-body' --value-stdin

  Set the entire file content to the content of a file on your local machine

    cat way-too-much.xml | cod config set -a api -c dev -f '/datapoints.xml' --entire-file --value-stdin

  Set the entire file content to the value of a secret

    cod config set -a api -c dev -f '/some-managed-service.pem' --entire-file --value ^
      '#REF|azKeyVault|our-secret-store|some-managed-svc-cert'

codiac config settings get​

Shows the list of clusters.

USAGE
  $ codiac config settings get [-n <value>] [-a <value>] [-f <value> | -t
    annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onpredeploy|permit|probing] [-s | -e
    <value> | -c <value>] [--setting <value>] [--value <value>] [-o text|tree|json|yaml] [--take-defaults | [--silent |
    --echo | --to-script]] [-h]

FLAGS
  -a, --asset=<value>
      The name of the asset to which the settings belong.

  -c, --cabinet=<value>
      Filters for settings scoped to the given cabinet name.

  -e, --enviro=<value>
      Filters for settings scoped to the given environment name.

  -f, --file=<value>
      The path-name to the file to which the settings belong, relative to the root of the container image.

  -h, --help
      Displays the help document for this command.

  -n, --enterprise=<value>
      (required only when more than one enterprise exists) The name of the enterprise containing the asset.

  -o, --output=<option>
      [default: json] format in which to render the data.
      <options: text|tree|json|yaml>

  -s, --enterprise-scope
      Filters for settings scoped at the enterprise level.

  -t, --type=<option>
      Filters for the settings types that do not land in a config file (such as... env: OS environment variables,
      footprint: container footprint specs, helm: helm chart settings, label: container meta labels, annotation: container
      platform key-value pairs).
      <options: annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onpredeploy|permit|probing>

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --setting=<value>
      Glob for settings names. Filters for individual settings with matching names.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

  --value=<value>
      Glob for settings values. Filters for individual settings with matching values.

DESCRIPTION
  Shows the list of clusters.

See code: dist/commands/config/settings/get.ts

codiac config view [SETTING]​

Retrieves a pre-deploy preview of the ultimate configuration file contents for the given cabinet (with all inline variables and source references resolved).

USAGE
  $ codiac config view [SETTING] [-h] [-e <value>] [-a <value>] [-c <value>] [-t
    annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onpredeploy|permit|probing | -f
    <value>] [-o pretty|json|yaml|auto] [-p] [--silent | --echo | --to-script]

ARGUMENTS
  SETTING  (optional) Name of a specific setting to view; omit to show all.

FLAGS
  -a, --asset=<value>       Name of the asset to view configs for (use ? to be prompted).
  -c, --cabinet=<value>     The name of the cabinet to assemble the configuration for.
  -e, --enterprise=<value>  The name of the enterprise that contains the asset (defaults to the current enterprise
                            context).
  -f, --file=<value>        The relative pathname of the config file to view, relative to the root of the codiac project
                            (defaults to app-config.json).
  -h, --help                Show CLI help.
  -o, --output=<option>     Format in which to render the config document (defaults to auto).
                            <options: pretty|json|yaml|auto>
  -p, --prompt              Forces a prompt to select from the existing settings.
  -t, --type=<option>       The type of settings to view (env: OS environment variables, footprint: container footprint
                            specs, helm: helm chart settings, label: container meta labels, annotation: container
                            platform key-value pairs).
                            <options: annotation|env|footprint|filestore|helm|k8spatch|label|namespace|onpostdeploy|onpr
                            edeploy|permit|probing>
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Retrieves a pre-deploy preview of the ultimate configuration file contents for the given cabinet (with all inline
  variables and source references resolved).

ALIASES
  $ codiac config preview
  $ codiac cfg preview

EXAMPLES
  View config for the current asset interactively.

    $ codiac config view

  View a specific cabinet's config in pretty format.

    $ codiac config view -c dev2 -f settings.json -o pretty

  View a specific non-file config type.

    $ codiac config view -c dev2 -a myapi -t footprint

  Non-interactive (scripted) invocation.

    $ codiac config view -e myEnterprise -a myApi -c dev --silent

  Renders the equivalent silent command without executing.

    $ codiac config view -e myEnterprise -a myApi -c dev --to-script

See code: dist/commands/config/view.ts

codiac csp creds list​

Retrieves the list of Cloud Service Provider credentials for the current user.

USAGE
  $ codiac csp creds list [-p artifactHub|aws|azure|dockerHub|localMachine|other] [-s <value>] [-t <value>] [-o
    json|yaml|auto] [--take-defaults | [--silent | --echo | --to-script]]

FLAGS
  -o, --output=<option>
      [default: auto] format in which to render the data.
      <options: json|yaml|auto>

  -p, --provider=<option>
      Code indicating the Cloud Service Provider (CSP) to search on
      <options: artifactHub|aws|azure|dockerHub|localMachine|other>

  -s, --subscriptionId=<value>
      The Id of the cloud provider subscription to filter on.

  -t, --cspTenantId=<value>
      The Id of the cloud provider tenant to filter on.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Retrieves the list of Cloud Service Provider credentials for the current user.

EXAMPLES
  $ codiac csp creds list

See code: dist/commands/csp/creds/list.ts

codiac csp login [PROVIDER]​

Authenticates with the given Cloud Service Provider (CSP), eg: aws, azure, docker. Use this command both to validate credentials and to declare the csp user account for subsequent commands involving that provider.

USAGE
  $ codiac csp login [PROVIDER] [-u <value>] [-p <value> | --clientSecret] [--aws-session-token <value>] [-s
    <value>] [-t <value>] [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  PROVIDER  (artifactHub|aws|azure|dockerHub|localMachine|other) Code indicating the Cloud Service Provider (CSP) being
            authenticated with.

FLAGS
  -p, --password=<value>
      (must be provided via stdin using --silent) The password at the given cloud provider.

  -s, --subscriptionId=<value>
      (in silent mode, either this or tenantId is required if you have more than one tenant profile on a given cloud
      provider) The Id of the cloud provider subscription under which to authenticate.

  -t, --tenantId=<value>
      (in silent mode, either this or subscriptionId is required if you have more than one tenant profile on a given cloud
      provider) The Id of the cloud provider tenant under which to authenticate.

  -u, --user=<value>
      The username at the given cloud provider.

  --aws-session-token=<value>
      (for AWS only) The session token parameter for use when authenticating with a short-term AWS access key credentials.

  --clientSecret
      (must be provided interactively or via stdin using --silent) Invokes the OAuth Client Credentials Flow. Used to
      authenticate when no user is present, such as an internal service or in a devops pipeline.  Note: This is a secret
      that must be created when Codiac gets registered as a trusted application in your cloud service provider
      subscription (eg: in azure, this is an app registration in Azure AD).

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Authenticates with the given Cloud Service Provider (CSP), eg: aws, azure, docker.  Use this command both to validate
  credentials and to declare the csp user account for subsequent commands involving that provider.

EXAMPLES
  cod csp login

  cod csp login docker

  cat mypassword.txt | cod csp login -u me@mydomain.com --silent docker

  cat theclientsecret.txt | cod csp login --clientSecret --silent azure

  cat theclientsecret.txt | cod csp login --clientSecret --tenantId xy12pd34-a828-43d7-89c9-e52dg3cc2a7a --silent azure

  cat theclientsecret.txt | cod csp login --clientSecret --tenantId xy12pd34-a828-43d7-89c9-e52dg3cc2a7a -u abacab99-b1c2-45tu-m240gaddrac --silent azure

  cod csp login --clientSecret --tenantId xy12pd34-a828-43d7-89c9-e52dg3cc2a7a -u abacab99-b1c2-45tu-m240gaddrac azure

  cod csp login -u ASIAZ3XYZPDQ123 -p $(cat my-aws-secret-key.txt) aws

  cod csp login -u ASIAZ3XYZPDQ123 -p $(cat my-aws-secret-key.txt) --aws-session-token $(cat my-aws-sesh.txt) aws

See code: dist/commands/csp/login.ts

codiac csp logout [PROVIDER]​

Closes session with the given Cloud Service Provider (CSP), eg: aws, azure, docker. Use this command to clear the local cache for your security account at that provider.

USAGE
  $ codiac csp logout [PROVIDER] [-h] [-s <value>] [-t <value>] [--silent | --echo | --to-script]

ARGUMENTS
  PROVIDER  (artifactHub|aws|azure|dockerHub) Code indicating the Cloud Service Provider (CSP) being logged out of.

FLAGS
  -h, --help                    Show CLI help.
  -s, --subscriptionId=<value>  (in silent mode, either this or tenantId is required if you have more than one tenant
                                profile on a given cloud provider) The Id of the cloud provider subscription under which
                                to logout.
  -t, --tenantId=<value>        (in silent mode, either this or subscriptionId is required if you have more than one
                                tenant profile on a given cloud provider) The Id of the cloud provider tenant under
                                which to logout.
  --echo                        Renders the equivalent non-interactive command for future use before executing.
  --silent                      Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                   Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Closes session with the given Cloud Service Provider (CSP), eg: aws, azure, docker.  Use this command to clear the
  local cache for your security account at that provider.

EXAMPLES
  Log out interactively.

    $ codiac csp logout

  Log out of a specific provider.

    $ codiac csp logout docker

  Non-interactive invocation.

    $ codiac csp logout --silent azure

  Renders the equivalent silent command without executing.

    $ codiac csp logout azure --to-script

See code: dist/commands/csp/logout.ts

codiac dep [NAME]​

Installs a package into current project.

USAGE
  $ codiac dep [NAME] [-h] [-v <value>]

ARGUMENTS
  NAME  The official unique name of the package to install.

FLAGS
  -h, --help             Show CLI help.
  -v, --version=<value>  version of the package to install

DESCRIPTION
  Installs a package into current project.

See code: dist/commands/dep.ts

codiac dep create [URL]​

Sources a new dependency into the project from an existing repo url, initializes it with the package repository, and publishes the initial version if it is not already. If the package repository is already initialized, the latest package version is used.

USAGE
  $ codiac dep create [URL] -n <value> [-h] [-v <value>]

ARGUMENTS
  URL  The official clone url for the repository.

FLAGS
  -h, --help             Show CLI help.
  -n, --pkgName=<value>  (required) Package name including any scope prefix (eg: @codiac.io/)
  -v, --version=<value>  Version to apply to the dependency package if it has not yet been initialized.

DESCRIPTION
  Sources a new dependency into the project from an existing repo url, initializes it with the package repository, and
  publishes the initial version if it is not already.  If the package repository is already initialized, the latest
  package version is used.

See code: dist/commands/dep/create.ts

codiac dep install​

installs any missing dependency packages into the local project folder.

USAGE
  $ codiac dep install [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  installs any missing dependency packages into the local project folder.

See code: dist/commands/dep/install.ts

codiac dep list​

Shows the dependencies for the project.

USAGE
  $ codiac dep list [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Shows the dependencies for the project.

See code: dist/commands/dep/list.ts

codiac dep remove [NAME]​

Removes a dependency from the project.

USAGE
  $ codiac dep remove [NAME] [-h] [-d]

ARGUMENTS
  NAME  The official unique name of the dependency package.

FLAGS
  -d, --discard  If the dependency to remove is sourced into the project, setting this flag discards all uncommitted
                 changes (staged and unstaged) before removing it.  Again, uncomitted changes are LOST when this flag is
                 set.
  -h, --help     Show CLI help.

DESCRIPTION
  Removes a dependency from the project.

See code: dist/commands/dep/remove.ts

codiac dep source [NAME]​

Loads the source code for the given dependency

USAGE
  $ codiac dep source [NAME] [-h] [-d <value>]

ARGUMENTS
  NAME  The official unique name of the dependency package.

FLAGS
  -d, --distSubPath=<value>  Subfolder path, relative to the root of the submodule,  to the folder from which the
                             package is created,  aka: the build output folder or 'dist' folder (eg: bin, dist, or lib,
                             ...etc).  This folder is used as the target folder for npm link.
  -h, --help                 Show CLI help.

DESCRIPTION
  Loads the source code for the given dependency

ALIASES
  $ codiac dep src

See code: dist/commands/dep/source.ts

codiac dep src [NAME]​

Loads the source code for the given dependency

USAGE
  $ codiac dep src [NAME] [-h] [-d <value>]

ARGUMENTS
  NAME  The official unique name of the dependency package.

FLAGS
  -d, --distSubPath=<value>  Subfolder path, relative to the root of the submodule,  to the folder from which the
                             package is created,  aka: the build output folder or 'dist' folder (eg: bin, dist, or lib,
                             ...etc).  This folder is used as the target folder for npm link.
  -h, --help                 Show CLI help.

DESCRIPTION
  Loads the source code for the given dependency

ALIASES
  $ codiac dep src

codiac dep syncup DEPENDENCY​

Publishes the dependency in its current state and upgrades to it in the main project.

USAGE
  $ codiac dep syncup DEPENDENCY [-h]

ARGUMENTS
  DEPENDENCY  The package name of the dependency to sync up into the main project

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Publishes the dependency in its current state and upgrades to it in the main project.

See code: dist/commands/dep/syncup.ts

codiac dep unsource [NAME]​

Exits source mode for the given dependency by physically removing its source code folder from the project, and points the project dependency back to the package version it previously depended on.

USAGE
  $ codiac dep unsource [NAME] [-h] [-d] [-c]

ARGUMENTS
  NAME  The official unique name of the dependency package.

FLAGS
  -c, --comment  The commit message for any outstanding changes.
  -d, --discard  Discards all uncommitted changes (staged and unstaged) before unsourcing, and goes back to the
                 previously installed version of the dependency.  Again, uncomitted changes are LOST when this flag is
                 set.
  -h, --help     Show CLI help.

DESCRIPTION
  Exits source mode for the given dependency by physically removing its source code folder from the project, and points
  the project dependency back to the package version it previously depended on.

ALIASES
  $ codiac dep unsrc

See code: dist/commands/dep/unsource.ts

codiac dep unsrc [NAME]​

Exits source mode for the given dependency by physically removing its source code folder from the project, and points the project dependency back to the package version it previously depended on.

USAGE
  $ codiac dep unsrc [NAME] [-h] [-d] [-c]

ARGUMENTS
  NAME  The official unique name of the dependency package.

FLAGS
  -c, --comment  The commit message for any outstanding changes.
  -d, --discard  Discards all uncommitted changes (staged and unstaged) before unsourcing, and goes back to the
                 previously installed version of the dependency.  Again, uncomitted changes are LOST when this flag is
                 set.
  -h, --help     Show CLI help.

DESCRIPTION
  Exits source mode for the given dependency by physically removing its source code folder from the project, and points
  the project dependency back to the package version it previously depended on.

ALIASES
  $ codiac dep unsrc

codiac dep upgrade [DEPENDENCY]​

describe the command here

USAGE
  $ codiac dep upgrade [DEPENDENCY] [-h] [-v <value>]

ARGUMENTS
  DEPENDENCY  The dependency to upgrade

FLAGS
  -h, --help             Show CLI help.
  -v, --version=<value>  version of the package to install

DESCRIPTION
  describe the command here

See code: dist/commands/dep/upgrade.ts

codiac deploy​

Deploys a given asset to a given cabinet. Defaults to current version.

USAGE
  $ codiac deploy [-h] [-e <value>] [-m any|all|none [-t <value> | -c <value>]] [-a <value>] [-u <value>]
    [-w <value>] [-n <value>] [-p <value>] [--silent | --echo | --to-script]

FLAGS
  -a, --asset=<value>             Name of the asset to deploy (use ? or ?? to be prompted).
  -c, --cabinetName=<value>       Target cabinet name to deploy to.
  -e, --enterpriseCode=<value>    Code name of the enterprise to target.
  -h, --help                      Show CLI help.
  -m, --tagMatch=<option>         Logic for matching the given tags when selecting cabinets (defaults to any).
                                  <options: any|all|none>
  -n, --providerUserName=<value>  Cloud provider username for silent/scripted authentication.
  -p, --providerPassword=<value>  Cloud provider password for silent/scripted authentication.
  -t, --tag=<value>...            Cabinet tags to select the target cabinet (alternative to --cabinetName).
  -u, --version=<value>           Version of the asset to deploy (use ? or ?? to be prompted).
  -w, --tagAsset=<value>...       Tags to apply to the selected asset version.
  --echo                          Renders the equivalent non-interactive command for future use before executing.
  --silent                        Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                     Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Deploys a given asset to a given cabinet. Defaults to current version.

EXAMPLES
  Deploy interactively.

    $ codiac deploy

  Deploy a specific asset version to a cabinet.

    $ codiac deploy -e myEnterprise -a myApi -u 1.2.3 -c dev

  Deploy to a cabinet selected by tag.

    $ codiac deploy -e myEnterprise -a myApi -u 1.2.3 -t staging

  Non-interactive (scripted) invocation.

    $ codiac deploy -e myEnterprise -a myApi -u 1.2.3 -c dev --silent

  Renders the equivalent silent command without executing.

    $ codiac deploy -e myEnterprise -a myApi -u 1.2.3 -c dev --to-script

See code: dist/commands/deploy.ts

codiac domain map [DOMAIN]​

Declares a strategy for mapping assets to ingress routes for a domain name.

USAGE
  $ codiac domain map [DOMAIN] [-h] [-n <value>] [-e <value> | -v <value>] [-c <value> | ] [--private] [--silent
    | --echo | --to-script]

ARGUMENTS
  DOMAIN  The domain name to route (eg: "my-company.com").

FLAGS
  -c, --cabinet=<value>      The name of the cabinet on which to apply this naming strategy. Must be qualified by also
                             setting enterprise if cabinet names are not unique.
  -e, --enterprise=<value>   The name of the enterprise on which to apply this naming strategy. Leave blank if there is
                             only one.
  -h, --help                 Show CLI help.
  -n, --naming=<value>       The host naming strategy to apply.
  -v, --environment=<value>  The name of the environment on which to apply this naming strategy. Must be qualified by
                             also setting enterprise if there are more than one.
  --echo                     Renders the equivalent non-interactive command for future use before executing.
  --private                  Declares that this domain mapping is for internal use and not available from the internet.
  --silent                   Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Declares a strategy for mapping assets to ingress routes for a domain name.

ALIASES
  $ codiac domain map

EXAMPLES
  Map a domain interactively.

    $ codiac domain map my-company.com

  Map an enterprise-level domain.

    $ codiac domain map my-company.com -e myEnterprise -n subdomain_dot_cabinet --silent

  Renders the equivalent silent command without executing.

    $ codiac domain map my-company.com -e myEnterprise --to-script

codiac ent allow onenvs​

Sets permissions for a security Role to be applied to any new environments created within the given enterprise. Only modifies default permissions on FUTURE for new environments; DOES NOT modify permissions on any existing environments. (NOT additive: this command overwrites any existing new-environment permissions set for this role).

USAGE
  $ codiac ent allow onenvs -p modify|read|none [--enterprise <value>] [-r <value>] [--take-defaults | [--silent |
    --echo | --to-script]]

FLAGS
  -p, --privilege=<option>
      (required) The permission to assign to the Role. ("modify" infers permission to create, read, update, and delete.
      "none" removes any permissions set for the role)
      <options: modify|read|none>

  -r, --role=<value>
      Name of the Role being assigned. Required in silent mode.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --enterprise=<value>
      Name of the Enterprise containing the environemnt. (Required only if more than one exists).

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Sets permissions for a security Role to be applied to any new environments created within the given enterprise.  Only
  modifies default permissions on FUTURE for new environments; DOES NOT modify permissions on any existing environments.
  (NOT additive: this command overwrites any existing new-environment permissions set for this role).

ALIASES
  $ codiac ent allow onenvs

EXAMPLES
  $ codiac ent allow onenvs --enterprise main --role developer --privilege modify

  $ codiac ent allow onenvs -r developer -p none

  $ codiac ent allow onenvs --enterprise dyno -r productmanager -p read

codiac ent list​

Shows the list of enterprises.

USAGE
  $ codiac ent list [-h] [-o text|tree|json|yaml] [-q <value>] [--silent | --echo | --to-script]

FLAGS
  -h, --help             Show CLI help.
  -o, --output=<option>  Format in which to render the results.
                         <options: text|tree|json|yaml>
  -q, --query=<value>    JMESPath expression to filter or reshape the results (see jmespath.org).
  --echo                 Renders the equivalent non-interactive command for future use before executing.
  --silent               Executes without any user interaction; fails on missing or invalid arguments.
  --to-script            Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Shows the list of enterprises.

ALIASES
  $ codiac ent list

EXAMPLES
  Simple listing.

    $ codiac ent list

  List of enterprise names only.

    $ codiac ent list -q '[].name'

  Multi-property projection.

    $ codiac ent list -q '[].{ name: name }'

  Filter by name.

    $ codiac ent list -q "[?name == 'myEnterprise']"

  Export as YAML.

    $ codiac ent list -o yaml

  Non-interactive invocation.

    $ codiac ent list --silent

  Renders the equivalent silent command without executing.

    $ codiac ent list --to-script

codiac enterprise allow​

Sets permissions for a security Role on the given enterprise entity. (NOT additive: this command overwrites any existing permissions set for this role on the entity).

USAGE
  $ codiac enterprise allow -p modify|read|none [-e <value>] [-r <value>] [--take-defaults | [--silent | --echo |
    --to-script]]

FLAGS
  -e, --enterprise=<value>
      Name of the Enterprise being protected. Required in silent mode.

  -p, --privilege=<option>
      (required) The permission to assign to the Role. ("modify" infers permission to create, read, update, and delete.
      "none" removes any permissions set for the role)
      <options: modify|read|none>

  -r, --role=<value>
      Name of the Role being assigned. Required in silent mode.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Sets permissions for a security Role on the given enterprise entity. (NOT additive: this command overwrites any
  existing permissions set for this role on the entity).

EXAMPLES
  $ codiac enterprise allow -r deployer -p modify

  $ codiac enterprise allow -r deployer -p none

See code: dist/commands/enterprise/allow.ts

codiac enterprise allow onEnvironments​

Sets permissions for a security Role to be applied to any new environments created within the given enterprise. Only modifies default permissions on FUTURE for new environments; DOES NOT modify permissions on any existing environments. (NOT additive: this command overwrites any existing new-environment permissions set for this role).

USAGE
  $ codiac enterprise allow onEnvironments -p modify|read|none [--enterprise <value>] [-r <value>] [--take-defaults | [--silent |
    --echo | --to-script]]

FLAGS
  -p, --privilege=<option>
      (required) The permission to assign to the Role. ("modify" infers permission to create, read, update, and delete.
      "none" removes any permissions set for the role)
      <options: modify|read|none>

  -r, --role=<value>
      Name of the Role being assigned. Required in silent mode.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --enterprise=<value>
      Name of the Enterprise containing the environemnt. (Required only if more than one exists).

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Sets permissions for a security Role to be applied to any new environments created within the given enterprise.  Only
  modifies default permissions on FUTURE for new environments; DOES NOT modify permissions on any existing environments.
  (NOT additive: this command overwrites any existing new-environment permissions set for this role).

ALIASES
  $ codiac ent allow onenvs

EXAMPLES
  $ codiac enterprise allow onEnvironments --enterprise main --role developer --privilege modify

  $ codiac enterprise allow onEnvironments -r developer -p none

  $ codiac enterprise allow onEnvironments --enterprise dyno -r productmanager -p read

See code: dist/commands/enterprise/allow/onEnvironments.ts

codiac enterprise create [CODE]​

Creates a new enterprise under the current tenant.

USAGE
  $ codiac enterprise create [CODE] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h] [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  CODE  The unique human-readable identitifer to use for the enterprise (must be alphanunmeric with no spaces).

FLAGS
  -h, --help            Show CLI help.
  -v, --verbose         Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>          Fires this command with an argument list that was previously remembered using the --rememberAs
                        flag.
  --echo                Echo interaction mode; renders the equivalent non-interactive cli command for future use before
                        final execution.
  --remember            Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>  Saves the given argument list so that it can be called by name.
  --silent              Non-Interactive mode; executes without any user interaction and fails on any missing or invalid
                        arguments.
  --take-defaults       Setting this to true prevents prompting for confirmation on parameters that were passed in or
                        were automatically set to default values (Irrelevant in --silent mode).
  --to-script           Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                        execution.
  --unremember=<value>  Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that were
                        previously stored under the given name (use "--unRemember default" to clear default argument
                        list memorized with the --remember flag).
  --withoutdefaults     Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Creates a new enterprise under the current tenant.

EXAMPLES
  Create enterprise interactivley.

    cod enterprise create

  Create enterprise interactivley with enterprise name.

    cod enterprise create my-enterprise-code

  Create enterprise silently.

    cod enterprise create my-enterprise-code --silent

See code: dist/commands/enterprise/create.ts

codiac enterprise list​

Shows the list of enterprises.

USAGE
  $ codiac enterprise list [-h] [-o text|tree|json|yaml] [-q <value>] [--silent | --echo | --to-script]

FLAGS
  -h, --help             Show CLI help.
  -o, --output=<option>  Format in which to render the results.
                         <options: text|tree|json|yaml>
  -q, --query=<value>    JMESPath expression to filter or reshape the results (see jmespath.org).
  --echo                 Renders the equivalent non-interactive command for future use before executing.
  --silent               Executes without any user interaction; fails on missing or invalid arguments.
  --to-script            Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Shows the list of enterprises.

ALIASES
  $ codiac ent list

EXAMPLES
  Simple listing.

    $ codiac enterprise list

  List of enterprise names only.

    $ codiac enterprise list -q '[].name'

  Multi-property projection.

    $ codiac enterprise list -q '[].{ name: name }'

  Filter by name.

    $ codiac enterprise list -q "[?name == 'myEnterprise']"

  Export as YAML.

    $ codiac enterprise list -o yaml

  Non-interactive invocation.

    $ codiac enterprise list --silent

  Renders the equivalent silent command without executing.

    $ codiac enterprise list --to-script

See code: dist/commands/enterprise/list.ts

codiac env add [SETTING]​

Adds a key-value pair to the app config at a given scope (enterprise, environment, or cabinet).

USAGE
  $ codiac env add [SETTING] [-h] [-s <value>] [-v <value>] [-n <value> | -e <value> | -c <value>] [--silent
    | --echo | --to-script]

ARGUMENTS
  SETTING  The name of the environment variable to add.

FLAGS
  -c, --cabinet=<value>      The name of the cabinet scope to which this value is to apply.
  -e, --environment=<value>  The name of the environment scope to which this value is to apply.
  -h, --help                 Show CLI help.
  -n, --enterprise=<value>   The name of the enterprise scope to which this value is to apply.
  -s, --setting=<value>      The name of the environment variable to add.
  -v, --value=<value>        The data to be applied as the setting value.
  --echo                     Renders the equivalent non-interactive command for future use before executing.
  --silent                   Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Adds a key-value pair to the app config at a given scope (enterprise, environment, or cabinet).

EXAMPLES
  Add a setting interactively.

    $ codiac env add

  Add a setting at enterprise scope.

    $ codiac env add -s MY_VAR -v myValue -n myEnterprise --silent

  Add a setting at environment scope.

    $ codiac env add -s MY_VAR -v myValue -e production --silent

  Add a setting at cabinet scope.

    $ codiac env add -s MY_VAR -v myValue -c dev --silent

  Renders the equivalent silent command without executing.

    $ codiac env add -s MY_VAR -v myValue -n myEnterprise --to-script

See code: dist/commands/env/add.ts

codiac enviro allow​

Sets permissions for a security Role on the given environment entity. (NOT additive: this command overwrites any existing permissions set for this role on the entity).

USAGE
  $ codiac enviro allow -p modify|read|none [--enterprise <value>] [-e <value>] [-r <value>] [--take-defaults |
    [--silent | --echo | --to-script]]

FLAGS
  -e, --environment=<value>
      Name of the Environment being protected. Required in silent mode.

  -p, --privilege=<option>
      (required) The permission to assign to the Role. ("modify" infers permission to create, read, update, and delete.
      "none" removes any permissions set for the role)
      <options: modify|read|none>

  -r, --role=<value>
      Name of the Role being assigned. Required in silent mode.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --enterprise=<value>
      Name of the Enterprise containing the environemnt. (Required only if more than one exists).

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Sets permissions for a security Role on the given environment entity. (NOT additive: this command overwrites any
  existing permissions set for this role on the entity).

ALIASES
  $ codiac enviro allow

EXAMPLES
  $ codiac enviro allow --enteprise main --environment dev --role developer --privilege modify

  $ codiac enviro allow -e prod -r developer -p none

  $ codiac enviro allow -e qa -r productmanager -p read

codiac enviro allow oncabs​

Sets permissions for a security Role to be applied to any new cabinets created within the given environment. Only modifies default permissions on FUTURE for new cabinets; DOES NOT modify permissions on any existing cabinets. (NOT additive: this command overwrites any existing new-cabinet permissions set for this role).

USAGE
  $ codiac enviro allow oncabs -p modify|read|none [--enterprise <value>] [-e <value>] [-r <value>] [--take-defaults |
    [--silent | --echo | --to-script]]

FLAGS
  -e, --environment=<value>
      Name of the Environment whose new cabinets are to be protected. Required in silent mode.

  -p, --privilege=<option>
      (required) The permission to assign to the Role. ("modify" infers permission to create, read, update, and delete.
      "none" removes any permissions set for the role)
      <options: modify|read|none>

  -r, --role=<value>
      Name of the Role being assigned. Required in silent mode.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --enterprise=<value>
      Name of the Enterprise containing the environemnt. (Required only if more than one exists).

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Sets permissions for a security Role to be applied to any new cabinets created within the given environment.  Only
  modifies default permissions on FUTURE for new cabinets; DOES NOT modify permissions on any existing cabinets. (NOT
  additive: this command overwrites any existing new-cabinet permissions set for this role).

ALIASES
  $ codiac enviro allow oncabs

EXAMPLES
  $ codiac enviro allow oncabs --enterprise main --environment dev --role developer --privilege modify

  $ codiac enviro allow oncabs -e prod -r developer -p none

  $ codiac enviro allow oncabs -e qa -r productmanager -p read

codiac enviro cluster attach​

Includes the given cluster within the given environment. DOES NOT modify any infrastructure; only creates an association within Codiac.

USAGE
  $ codiac enviro cluster attach [-e <value>] [-n <value>] [-c <value>] [--take-defaults | [--silent | --echo |
    --to-script]]

FLAGS
  -c, --cluster=<value>
      Name of the cluster.

  -e, --enterprise=<value>
      The name of the enterprise in which the environment resides. NOTE: You can leave this blank if there is only one.

  -n, --environment=<value>
      Name of the environment being modified.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Includes the given cluster within the given environment.  DOES NOT modify any infrastructure; only creates an
  association within Codiac.

ALIASES
  $ codiac enviro cluster attach
  $ codiac infrx environment cluster attach
  $ codiac infrx enviro cluster attach

codiac enviro cluster detach​

Removes the linkage between the given environment and the given cluster. DOES NOT delete any infrastructure; only the association within Codiac.

USAGE
  $ codiac enviro cluster detach [-e <value>] [-n <value>] [-c <value>] [--take-defaults | [--silent | --echo |
    --to-script]]

FLAGS
  -c, --cluster=<value>
      Name of the cluster.

  -e, --enterprise=<value>
      The name of the enterprise in which the environment resides. NOTE: You can leave this blank if there is only one.

  -n, --environment=<value>
      Name of the environment being modified.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Removes the linkage between the given environment and the given cluster.  DOES NOT delete any infrastructure; only the
  association within Codiac.

ALIASES
  $ codiac enviro cluster detach
  $ codiac infrx environment cluster detach
  $ codiac infrx enviro cluster detach

codiac enviro create [NAME]​

Create a new environment for a given enterprise. Returns an error if the environment already exists.

USAGE
  $ codiac enviro create [NAME] [-c <value>] [-e <value>] [--as <value>] [--remember] [--rememberAs <value>]
    [--unremember <value>] [--withoutdefaults] [-v] [-h] [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  NAME  The name of the environment to create

FLAGS
  -c, --cluster=<value>...  (Required in silent mode) The cluster/s the environment will include.
  -e, --enterprise=<value>  (required only if more than one enterprise exists) The enterprise in which to create the
                            environment.
  -h, --help                Show CLI help.
  -v, --verbose             Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>              Fires this command with an argument list that was previously remembered using the
                            --rememberAs flag.
  --echo                    Echo interaction mode; renders the equivalent non-interactive cli command for future use
                            before final execution.
  --remember                Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>      Saves the given argument list so that it can be called by name.
  --silent                  Non-Interactive mode; executes without any user interaction and fails on any missing or
                            invalid arguments.
  --take-defaults           Setting this to true prevents prompting for confirmation on parameters that were passed in
                            or were automatically set to default values (Irrelevant in --silent mode).
  --to-script               Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                            execution.
  --unremember=<value>      Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                            were previously stored under the given name (use "--unRemember default" to clear default
                            argument list memorized with the --remember flag).
  --withoutdefaults         Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Create a new environment for a given enterprise. Returns an error if the environment already exists.

ALIASES
  $ codiac enviro create
  $ codiac infrx environment create
  $ codiac infrx enviro create

EXAMPLES
  Create a cabinet interativley.

    cod environment create

  Create a cabinet with cluster selected.

    cod environment create dev --cluster my-cluster-1

  Create a cabinet with multiple clusters selected.

    cod environment create dev --cluster my-cluster-1 --cluster my-cluster-2

  Create a cabinet silently.

    cod environment create dev --enterprise main --cluster my-cluster-1 --cluster my-cluster-2 --silent

codiac enviro delete [NAME]​

Deletes an existing environment from a given enterprise. Returns an error if the environment does not exist.

USAGE
  $ codiac enviro delete [NAME] [-e <value>] [--as <value>] [--remember] [--rememberAs <value>] [--unremember
    <value>] [--withoutdefaults] [-v] [-h] [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  NAME  The name of the environment to delete.

FLAGS
  -e, --enterprise=<value>  Code name of the enterprise from which to delete the environment.
  -h, --help                Show CLI help.
  -v, --verbose             Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>              Fires this command with an argument list that was previously remembered using the
                            --rememberAs flag.
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --remember                Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>      Saves the given argument list so that it can be called by name.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --take-defaults           Accepts default values without prompting for confirmation. (Irrelevant in --silent mode).
  --to-script               Renders the equivalent non-interactive command without executing it.
  --unremember=<value>      Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                            were previously stored under the given name (use "--unRemember default" to clear default
                            argument list memorized with the --remember flag).
  --withoutdefaults         Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Deletes an existing environment from a given enterprise. Returns an error if the environment does not exist.

ALIASES
  $ codiac enviro delete
  $ codiac infrx environment delete
  $ codiac infrx enviro delete

EXAMPLES
  Delete an environment interactively.

    $ codiac enviro delete

  Delete a named environment interactively.

    $ codiac enviro delete dev

  Delete an environment non-interactively.

    $ codiac enviro delete dev --enterprise main --silent

  Renders the equivalent silent command and then executes.

    $ codiac enviro delete dev --enterprise main --echo

  Renders the equivalent silent command without executing.

    $ codiac enviro delete dev --enterprise main --to-script

codiac enviro list​

Shows the list of environments.

USAGE
  $ codiac enviro list [-h] [-e <value>] [-o json|yaml|tree|text] [-q <value>] [--silent | --echo | --to-script]

FLAGS
  -e, --enterprise=<value>  The name of the enterprise to which the environments belong (defaults to the current
                            enterprise context).
  -h, --help                Show CLI help.
  -o, --output=<option>     Format in which to render the results (defaults to tree).
                            <options: json|yaml|tree|text>
  -q, --query=<value>       JMESPath expression to filter or reshape the results (see jmespath.org).
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Shows the list of environments.

ALIASES
  $ codiac enviro list
  $ codiac infrx environment list
  $ codiac infrx enviro list

EXAMPLES
  List all environments for the current enterprise.

    $ codiac enviro list

  List environments for a specific enterprise.

    $ codiac enviro list -e myEnterprise

  List environment names only.

    $ codiac enviro list -q '[].name'

  Export as YAML.

    $ codiac enviro list -o yaml

  Non-interactive (scripted) invocation.

    $ codiac enviro list -e myEnterprise --silent

codiac environment allow​

Sets permissions for a security Role on the given environment entity. (NOT additive: this command overwrites any existing permissions set for this role on the entity).

USAGE
  $ codiac environment allow -p modify|read|none [--enterprise <value>] [-e <value>] [-r <value>] [--take-defaults |
    [--silent | --echo | --to-script]]

FLAGS
  -e, --environment=<value>
      Name of the Environment being protected. Required in silent mode.

  -p, --privilege=<option>
      (required) The permission to assign to the Role. ("modify" infers permission to create, read, update, and delete.
      "none" removes any permissions set for the role)
      <options: modify|read|none>

  -r, --role=<value>
      Name of the Role being assigned. Required in silent mode.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --enterprise=<value>
      Name of the Enterprise containing the environemnt. (Required only if more than one exists).

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Sets permissions for a security Role on the given environment entity. (NOT additive: this command overwrites any
  existing permissions set for this role on the entity).

ALIASES
  $ codiac enviro allow

EXAMPLES
  $ codiac environment allow --enteprise main --environment dev --role developer --privilege modify

  $ codiac environment allow -e prod -r developer -p none

  $ codiac environment allow -e qa -r productmanager -p read

See code: dist/commands/environment/allow.ts

codiac environment allow onCabinets​

Sets permissions for a security Role to be applied to any new cabinets created within the given environment. Only modifies default permissions on FUTURE for new cabinets; DOES NOT modify permissions on any existing cabinets. (NOT additive: this command overwrites any existing new-cabinet permissions set for this role).

USAGE
  $ codiac environment allow onCabinets -p modify|read|none [--enterprise <value>] [-e <value>] [-r <value>] [--take-defaults |
    [--silent | --echo | --to-script]]

FLAGS
  -e, --environment=<value>
      Name of the Environment whose new cabinets are to be protected. Required in silent mode.

  -p, --privilege=<option>
      (required) The permission to assign to the Role. ("modify" infers permission to create, read, update, and delete.
      "none" removes any permissions set for the role)
      <options: modify|read|none>

  -r, --role=<value>
      Name of the Role being assigned. Required in silent mode.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --enterprise=<value>
      Name of the Enterprise containing the environemnt. (Required only if more than one exists).

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Sets permissions for a security Role to be applied to any new cabinets created within the given environment.  Only
  modifies default permissions on FUTURE for new cabinets; DOES NOT modify permissions on any existing cabinets. (NOT
  additive: this command overwrites any existing new-cabinet permissions set for this role).

ALIASES
  $ codiac enviro allow oncabs

EXAMPLES
  $ codiac environment allow onCabinets --enterprise main --environment dev --role developer --privilege modify

  $ codiac environment allow onCabinets -e prod -r developer -p none

  $ codiac environment allow onCabinets -e qa -r productmanager -p read

See code: dist/commands/environment/allow/onCabinets.ts

codiac environment cluster attach​

Includes the given cluster within the given environment. DOES NOT modify any infrastructure; only creates an association within Codiac.

USAGE
  $ codiac environment cluster attach [-e <value>] [-n <value>] [-c <value>] [--take-defaults | [--silent | --echo |
    --to-script]]

FLAGS
  -c, --cluster=<value>
      Name of the cluster.

  -e, --enterprise=<value>
      The name of the enterprise in which the environment resides. NOTE: You can leave this blank if there is only one.

  -n, --environment=<value>
      Name of the environment being modified.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Includes the given cluster within the given environment.  DOES NOT modify any infrastructure; only creates an
  association within Codiac.

ALIASES
  $ codiac enviro cluster attach
  $ codiac infrx environment cluster attach
  $ codiac infrx enviro cluster attach

See code: dist/commands/environment/cluster/attach.ts

codiac environment cluster detach​

Removes the linkage between the given environment and the given cluster. DOES NOT delete any infrastructure; only the association within Codiac.

USAGE
  $ codiac environment cluster detach [-e <value>] [-n <value>] [-c <value>] [--take-defaults | [--silent | --echo |
    --to-script]]

FLAGS
  -c, --cluster=<value>
      Name of the cluster.

  -e, --enterprise=<value>
      The name of the enterprise in which the environment resides. NOTE: You can leave this blank if there is only one.

  -n, --environment=<value>
      Name of the environment being modified.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Removes the linkage between the given environment and the given cluster.  DOES NOT delete any infrastructure; only the
  association within Codiac.

ALIASES
  $ codiac enviro cluster detach
  $ codiac infrx environment cluster detach
  $ codiac infrx enviro cluster detach

See code: dist/commands/environment/cluster/detach.ts

codiac environment create [NAME]​

Create a new environment for a given enterprise. Returns an error if the environment already exists.

USAGE
  $ codiac environment create [NAME] [-c <value>] [-e <value>] [--as <value>] [--remember] [--rememberAs <value>]
    [--unremember <value>] [--withoutdefaults] [-v] [-h] [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  NAME  The name of the environment to create

FLAGS
  -c, --cluster=<value>...  (Required in silent mode) The cluster/s the environment will include.
  -e, --enterprise=<value>  (required only if more than one enterprise exists) The enterprise in which to create the
                            environment.
  -h, --help                Show CLI help.
  -v, --verbose             Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>              Fires this command with an argument list that was previously remembered using the
                            --rememberAs flag.
  --echo                    Echo interaction mode; renders the equivalent non-interactive cli command for future use
                            before final execution.
  --remember                Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>      Saves the given argument list so that it can be called by name.
  --silent                  Non-Interactive mode; executes without any user interaction and fails on any missing or
                            invalid arguments.
  --take-defaults           Setting this to true prevents prompting for confirmation on parameters that were passed in
                            or were automatically set to default values (Irrelevant in --silent mode).
  --to-script               Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                            execution.
  --unremember=<value>      Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                            were previously stored under the given name (use "--unRemember default" to clear default
                            argument list memorized with the --remember flag).
  --withoutdefaults         Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Create a new environment for a given enterprise. Returns an error if the environment already exists.

ALIASES
  $ codiac enviro create
  $ codiac infrx environment create
  $ codiac infrx enviro create

EXAMPLES
  Create a cabinet interativley.

    cod environment create

  Create a cabinet with cluster selected.

    cod environment create dev --cluster my-cluster-1

  Create a cabinet with multiple clusters selected.

    cod environment create dev --cluster my-cluster-1 --cluster my-cluster-2

  Create a cabinet silently.

    cod environment create dev --enterprise main --cluster my-cluster-1 --cluster my-cluster-2 --silent

See code: dist/commands/environment/create.ts

codiac environment delete [NAME]​

Deletes an existing environment from a given enterprise. Returns an error if the environment does not exist.

USAGE
  $ codiac environment delete [NAME] [-e <value>] [--as <value>] [--remember] [--rememberAs <value>] [--unremember
    <value>] [--withoutdefaults] [-v] [-h] [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  NAME  The name of the environment to delete.

FLAGS
  -e, --enterprise=<value>  Code name of the enterprise from which to delete the environment.
  -h, --help                Show CLI help.
  -v, --verbose             Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>              Fires this command with an argument list that was previously remembered using the
                            --rememberAs flag.
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --remember                Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>      Saves the given argument list so that it can be called by name.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --take-defaults           Accepts default values without prompting for confirmation. (Irrelevant in --silent mode).
  --to-script               Renders the equivalent non-interactive command without executing it.
  --unremember=<value>      Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                            were previously stored under the given name (use "--unRemember default" to clear default
                            argument list memorized with the --remember flag).
  --withoutdefaults         Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Deletes an existing environment from a given enterprise. Returns an error if the environment does not exist.

ALIASES
  $ codiac enviro delete
  $ codiac infrx environment delete
  $ codiac infrx enviro delete

EXAMPLES
  Delete an environment interactively.

    $ codiac environment delete

  Delete a named environment interactively.

    $ codiac environment delete dev

  Delete an environment non-interactively.

    $ codiac environment delete dev --enterprise main --silent

  Renders the equivalent silent command and then executes.

    $ codiac environment delete dev --enterprise main --echo

  Renders the equivalent silent command without executing.

    $ codiac environment delete dev --enterprise main --to-script

See code: dist/commands/environment/delete.ts

codiac environment list​

Shows the list of environments.

USAGE
  $ codiac environment list [-h] [-e <value>] [-o json|yaml|tree|text] [-q <value>] [--silent | --echo | --to-script]

FLAGS
  -e, --enterprise=<value>  The name of the enterprise to which the environments belong (defaults to the current
                            enterprise context).
  -h, --help                Show CLI help.
  -o, --output=<option>     Format in which to render the results (defaults to tree).
                            <options: json|yaml|tree|text>
  -q, --query=<value>       JMESPath expression to filter or reshape the results (see jmespath.org).
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Shows the list of environments.

ALIASES
  $ codiac enviro list
  $ codiac infrx environment list
  $ codiac infrx enviro list

EXAMPLES
  List all environments for the current enterprise.

    $ codiac environment list

  List environments for a specific enterprise.

    $ codiac environment list -e myEnterprise

  List environment names only.

    $ codiac environment list -q '[].name'

  Export as YAML.

    $ codiac environment list -o yaml

  Non-interactive (scripted) invocation.

    $ codiac environment list -e myEnterprise --silent

See code: dist/commands/environment/list.ts

codiac fileshare capture​

Creates a reference point in the given enterprise for an existing filestore instance in a cloud provider subscription.

USAGE
  $ codiac fileshare capture [-h] [--provider azure] [--resourceGroup <value>] [--echo | --to-script | [--silent -e
    <value> -n <value> --providerSubscriptionId <value> --storageAccount <value> --shareName <value>]] [--take-defaults
    | ]

FLAGS
  -e, --enterprise=<value>          The name of the enterprise in which to create this filestore. (defaults to the
                                    current enterprise context)
  -h, --help                        Show CLI help.
  -n, --name=<value>                The name by which to identify this fileshare definition within the enterprise
                                    (Optional: defaults to the shareName).
  --echo                            Echo interaction mode; renders the equivalent non-interactive cli command for future
                                    use before final execution.
  --provider=<option>               The cloud provider under which the file storage account resides.
                                    <options: azure>
  --providerSubscriptionId=<value>  The identifier of the cloud provider subscription under which the file storage
                                    account resides.
  --resourceGroup=<value>           The name of the Azure resource group under which the instance is to be created
                                    (Azure-specific).
  --shareName=<value>               The name of the fileshare to connect to within the file storage account.
  --silent                          Non-Interactive mode; executes without any user interaction and fails on any missing
                                    or invalid arguments.
  --storageAccount=<value>          The name within the cloud provider of the file storage account within which the
                                    share resides.
  --take-defaults                   Setting this to true prevents prompting for confirmation on parameters that were
                                    passed in or were automatically set to default values (Irrelevant in --silent mode).
  --to-script                       Toscript interaction mode; renders the equivalent non-interactive cli command
                                    WITHOUT any execution.

DESCRIPTION
  Creates a reference point in the given enterprise for an existing filestore instance in a cloud provider subscription.

ALIASES
  $ codiac fileshare capture

codiac filestore capture​

Creates a reference point in the given enterprise for an existing filestore instance in a cloud provider subscription.

USAGE
  $ codiac filestore capture [-h] [--provider azure] [--resourceGroup <value>] [--echo | --to-script | [--silent -e
    <value> -n <value> --providerSubscriptionId <value> --storageAccount <value> --shareName <value>]] [--take-defaults
    | ]

FLAGS
  -e, --enterprise=<value>          The name of the enterprise in which to create this filestore. (defaults to the
                                    current enterprise context)
  -h, --help                        Show CLI help.
  -n, --name=<value>                The name by which to identify this fileshare definition within the enterprise
                                    (Optional: defaults to the shareName).
  --echo                            Echo interaction mode; renders the equivalent non-interactive cli command for future
                                    use before final execution.
  --provider=<option>               The cloud provider under which the file storage account resides.
                                    <options: azure>
  --providerSubscriptionId=<value>  The identifier of the cloud provider subscription under which the file storage
                                    account resides.
  --resourceGroup=<value>           The name of the Azure resource group under which the instance is to be created
                                    (Azure-specific).
  --shareName=<value>               The name of the fileshare to connect to within the file storage account.
  --silent                          Non-Interactive mode; executes without any user interaction and fails on any missing
                                    or invalid arguments.
  --storageAccount=<value>          The name within the cloud provider of the file storage account within which the
                                    share resides.
  --take-defaults                   Setting this to true prevents prompting for confirmation on parameters that were
                                    passed in or were automatically set to default values (Irrelevant in --silent mode).
  --to-script                       Toscript interaction mode; renders the equivalent non-interactive cli command
                                    WITHOUT any execution.

DESCRIPTION
  Creates a reference point in the given enterprise for an existing filestore instance in a cloud provider subscription.

ALIASES
  $ codiac fileshare capture

See code: dist/commands/filestore/capture.ts

codiac filestore forget​

Un-captures an existing filestore instance. Does NOT delete the physical filestore infrastructure itself; only the reference to it in Codiac.

USAGE
  $ codiac filestore forget [-e <value>] [-n <value> | --id <value>] [--take-defaults | [--silent | --echo |
    --to-script]]

FLAGS
  -e, --enterprise=<value>
      The name of the enterprise in which this filestore reference exists. NOTE: You can leave this blank if there is only
      one.

  -n, --name=<value>
      The name of the filestore reference.  NOTE: This is NOT necessarily the name of the physical filestore entity; just
      the name given to the reference itself.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --id=<value>
      The system id of the filestore reference itself. You can enter this parameter instead of the other filestore
      descriptors.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Un-captures an existing filestore instance.  Does NOT delete the physical filestore infrastructure itself; only the
  reference to it in Codiac.

EXAMPLES
  $ codiac filestore forget

See code: dist/commands/filestore/forget.ts

codiac filestore list​

Retrieves the list of existing file stores captured for a given enterprise.

USAGE
  $ codiac filestore list [-e <value>] [-t
    AwsEbs|AwsEfs|AwsS3Bucket|AzureBlobStorage|AzureDisk|AzureFileStorage|HostMachineFolder] [-o json|yaml|auto]
    [--take-defaults | [--silent | --echo | --to-script]]

FLAGS
  -e, --enterprise=<value>
      (optional if there is only one) The enterprise in which the filestores are defined.

  -o, --output=<option>
      [default: auto] format in which to render the data.
      <options: json|yaml|auto>

  -t, --type=<option>
      Filter on the filestore technology.
      <options: AwsEbs|AwsEfs|AwsS3Bucket|AzureBlobStorage|AzureDisk|AzureFileStorage|HostMachineFolder>

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Retrieves the list of existing file stores captured for a given enterprise.

EXAMPLES
  $ codiac filestore list

See code: dist/commands/filestore/list.ts

codiac help [COMMANDS]​

Display help for codiac.

USAGE
  $ codiac 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 codiac.

See code: @oclif/plugin-help

codiac host delete​

Removes a host naming strategy mapping. ie: UN-maps a domain strategy that was previously assigned to a given scope (eg: enterprise, environment, or cabinet.

USAGE
  $ codiac host delete [-e <value>] [-d <value> | --id <value>] [-n
    cab_dot_cluster_dot_domain_slash_service|cab_dot_cluster_dot_enterprise_dot_domain_slash_service|cab_dot_domain_slas
    h_service|domain_slash_service|globally_shared_domain_slash_service|service_dot_domain|shared_ingress_ip|svc_dot_cab
    _dot_domain | ] [-s |  | -v <value> | -c <value>] [--take-defaults | [--silent | --echo | --to-script]]

FLAGS
  -c, --cabinet=<value>
      The name of the cabinet on which to apply this naming strategy.  Must be qualified by also setting enterprise.
      NOTE: You can leave this blank if there is only one. If cabinet names are not unique, use the --enterprise/-e
      argument to fully qualify the cabinet name.

  -d, --domain=<value>
      domain name to remove (without any wildcards), eg: `yoursite.com`

  -e, --enterprise=<value>
      The name of the enterprise on which to apply this naming strategy. NOTE: You can leave this blank if there is only
      one.

  -n, --naming=<option>
      The host naming strategy to apply.
      <options: cab_dot_cluster_dot_domain_slash_service|cab_dot_cluster_dot_enterprise_dot_domain_slash_service|cab_dot_d
      omain_slash_service|domain_slash_service|globally_shared_domain_slash_service|service_dot_domain|shared_ingress_ip|s
      vc_dot_cab_dot_domain>

  -s, --enterprise-scope
      Applies the naming strategy at the enterprise level.

  -v, --environment=<value>
      The name of the environment on which to apply this naming strategy. Must be qualified by also setting enterprise.
      NOTE: You can leave this blank if there is only one.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --id=<value>
      The system id of the domain mapping itself. You can enter this parameter instead of the other domain mapping
      descriptors.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Removes a host naming strategy mapping.  ie: UN-maps a domain strategy that was previously assigned to a given scope
  (eg: enterprise, environment, or cabinet.

EXAMPLES
  $ codiac host delete

See code: dist/commands/host/delete.ts

codiac host list [DOMAIN]​

Retrieves the list of host mapping strategies defined on a given enterprise.

USAGE
  $ codiac host list [DOMAIN] [-e <value>] [-o json|yaml|auto] [--take-defaults | [--silent | --echo |
    --to-script]]

ARGUMENTS
  DOMAIN  domain name to filter on (without any wildcards), eg: `yoursite.com`

FLAGS
  -e, --enterprise=<value>
      (optional if there is only one) The enterprise in which the domains have been mapped.

  -o, --output=<option>
      [default: auto] format in which to render the data.
      <options: json|yaml|auto>

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Retrieves the list of host mapping strategies defined on a given enterprise.

EXAMPLES
  $ codiac host list

See code: dist/commands/host/list.ts

codiac host map [DOMAIN]​

Declares a strategy for mapping assets to ingress routes for a domain name.

USAGE
  $ codiac host map [DOMAIN] [-h] [-n <value>] [-e <value> | -v <value>] [-c <value> | ] [--private] [--silent
    | --echo | --to-script]

ARGUMENTS
  DOMAIN  The domain name to route (eg: "my-company.com").

FLAGS
  -c, --cabinet=<value>      The name of the cabinet on which to apply this naming strategy. Must be qualified by also
                             setting enterprise if cabinet names are not unique.
  -e, --enterprise=<value>   The name of the enterprise on which to apply this naming strategy. Leave blank if there is
                             only one.
  -h, --help                 Show CLI help.
  -n, --naming=<value>       The host naming strategy to apply.
  -v, --environment=<value>  The name of the environment on which to apply this naming strategy. Must be qualified by
                             also setting enterprise if there are more than one.
  --echo                     Renders the equivalent non-interactive command for future use before executing.
  --private                  Declares that this domain mapping is for internal use and not available from the internet.
  --silent                   Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Declares a strategy for mapping assets to ingress routes for a domain name.

ALIASES
  $ codiac domain map

EXAMPLES
  Map a domain interactively.

    $ codiac host map my-company.com

  Map an enterprise-level domain.

    $ codiac host map my-company.com -e myEnterprise -n subdomain_dot_cabinet --silent

  Renders the equivalent silent command without executing.

    $ codiac host map my-company.com -e myEnterprise --to-script

See code: dist/commands/host/map.ts

codiac host view [DOMAIN]​

Retrieves the overall map of domain routes for the given enterprise, resulting from the current host mapping strategies, environments, and assets.

USAGE
  $ codiac host view [DOMAIN] [-e <value>] [-o json|yaml|pretty] [--take-defaults | [--silent | --echo |
    --to-script]]

ARGUMENTS
  DOMAIN  domain name to filter on (without any wildcards), eg: `yoursite.com`

FLAGS
  -e, --enterprise=<value>
      (optional if there is only one) The enterprise in which the domains have been mapped.

  -o, --output=<option>
      [default: pretty] format in which to render the data.
      <options: json|yaml|pretty>

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Retrieves the overall map of domain routes for the given enterprise, resulting from the current host mapping
  strategies, environments, and assets.

EXAMPLES
  $ codiac host view

See code: dist/commands/host/view.ts

codiac identify [TOKENNAME]​

Stores an identity token for the current user, for use with a component tool (such as npm). This command acts as an upsert.

USAGE
  $ codiac identify [TOKENNAME] -t <value> [-h] [-p npm|azart|other] [-s <value>] [-r <value>] [-g <value> -e
    <value> -f <value>]

ARGUMENTS
  TOKENNAME  (optional) Conventional name (token_for_[provider]_[scope]) for the tokenized identity.  This name will
             also be used for the build environment variable carrying the token.

FLAGS
  -e, --email=<value>         (Azure Artifacts [aka: azart] only) The email address for this identity.  Npm requires for
                              this, but never uses it.
  -f, --feed=<value>          (Azure Artifacts [aka: azart] only) The human readable identifier for the package feed
  -g, --organization=<value>  (Azure Artifacts [aka: azart] only) Human readable identifier for the organization account
                              with the provider.
  -h, --help                  Renders the help document for this command.
  -p, --provider=<option>     [default: npm] The source of the token.
                              <options: npm|azart|other>
  -r, --registryUrl=<value>   The component tool that issued and can consume the token.
  -s, --scope=<value>         The subdivision within the registry for which this token is honored.
  -t, --token=<value>         (required) The actual raw token string itself issued by the provider

DESCRIPTION
  Stores an identity token for the current user, for use with a component tool (such as npm).  This command acts as an
  upsert.

ALIASES
  $ codiac identify
  $ codiac token

codiac identity [TOKENNAME]​

Stores an identity token for the current user, for use with a component tool (such as npm). This command acts as an upsert.

USAGE
  $ codiac identity [TOKENNAME] -t <value> [-h] [-p npm|azart|other] [-s <value>] [-r <value>] [-g <value> -e
    <value> -f <value>]

ARGUMENTS
  TOKENNAME  (optional) Conventional name (token_for_[provider]_[scope]) for the tokenized identity.  This name will
             also be used for the build environment variable carrying the token.

FLAGS
  -e, --email=<value>         (Azure Artifacts [aka: azart] only) The email address for this identity.  Npm requires for
                              this, but never uses it.
  -f, --feed=<value>          (Azure Artifacts [aka: azart] only) The human readable identifier for the package feed
  -g, --organization=<value>  (Azure Artifacts [aka: azart] only) Human readable identifier for the organization account
                              with the provider.
  -h, --help                  Renders the help document for this command.
  -p, --provider=<option>     [default: npm] The source of the token.
                              <options: npm|azart|other>
  -r, --registryUrl=<value>   The component tool that issued and can consume the token.
  -s, --scope=<value>         The subdivision within the registry for which this token is honored.
  -t, --token=<value>         (required) The actual raw token string itself issued by the provider

DESCRIPTION
  Stores an identity token for the current user, for use with a component tool (such as npm).  This command acts as an
  upsert.

ALIASES
  $ codiac identify
  $ codiac token

See code: dist/commands/identity.ts

codiac identity delete [NAME]​

Removes an identity token from storage for the current user.

USAGE
  $ codiac identity delete [NAME] [-h]

ARGUMENTS
  NAME  The name of the token to delete.  Use the 'identity:list' command to view the currently stored tokens.

FLAGS
  -h, --help  Displays the help document for this command.

DESCRIPTION
  Removes an identity token from storage for the current user.

ALIASES
  $ codiac identity remove
  $ codiac token delete
  $ codiac token remove

See code: dist/commands/identity/delete.ts

codiac identity list​

Lists out the identity tokens currently stored for the current user.

USAGE
  $ codiac identity list [-h] [-o table|extended|json|csv]

FLAGS
  -h, --help             Displays the help document for this command.
  -o, --output=<option>  [default: table] Format for the response data.
                         <options: table|extended|json|csv>

DESCRIPTION
  Lists out the identity tokens currently stored for the current user.

ALIASES
  $ codiac token list

See code: dist/commands/identity/list.ts

codiac identity remove [NAME]​

Removes an identity token from storage for the current user.

USAGE
  $ codiac identity remove [NAME] [-h]

ARGUMENTS
  NAME  The name of the token to delete.  Use the 'identity:list' command to view the currently stored tokens.

FLAGS
  -h, --help  Displays the help document for this command.

DESCRIPTION
  Removes an identity token from storage for the current user.

ALIASES
  $ codiac identity remove
  $ codiac token delete
  $ codiac token remove

codiac image [IMAGENAME]​

Configures a container image to be built and published by the project.

USAGE
  $ codiac image [IMAGENAME] [-h] [-p <value>] [-f <value>] [-r <value>] [-i <value>] [-e <value>] [-u
    <value>] [-s <value>] [-b <value>] [--silent | --echo | --to-script]

ARGUMENTS
  IMAGENAME  Image name including scope prefix, eg: "your-company/your-image".

FLAGS
  -b, --buildParams=<value>...  Additional freeform arguments to apply to the Docker build command (as: arg=val, eg: -b
                                "--size=12" -b "--color=blue").
  -e, --environment=<value>     (Optional) Declaration that this registry shall be the target when publishing to the
                                given environment.
  -f, --sourceFile=<value>      Path and filename of the image definition file, relative to the project root (eg:
                                "./Dockerfile"). If omitted, the build will use an in-memory image definition
                                auto-generated at build time.
  -h, --help                    Show CLI help.
  -i, --infoUrl=<value>         (Optional) Address on the registry website or portal of the human-readable web page for
                                the image.
  -p, --port=<value>            Recommended port number to assign, in the toybox template, to an Asset defined by this
                                image.
  -r, --registryUrl=<value>     [default: https://index.docker.io/v1] (Optional, defaults to Docker Hub) Address of the
                                container registry to which the image will be published (without protocol prefix), eg:
                                "yourimages.azurecr.io".
  -s, --password=<value>        (Optional) Password credential for the given registry. WARNING: these credentials will
                                be stored in the codiac config file in this project.
  -u, --username=<value>        (Optional) Login credential for the given registry. WARNING: these credentials will be
                                stored in the codiac config file in this project.
  --echo                        Renders the equivalent non-interactive command for future use before executing.
  --silent                      Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                   Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Configures a container image to be built and published by the project.

ALIASES
  $ codiac image
  $ codiac image add
  $ codiac img
  $ codiac img add

EXAMPLES
  Configure an image interactively.

    $ codiac image

  Configure a named image.

    $ codiac image your-company/your-image

  Renders the equivalent silent command without executing.

    $ codiac image your-company/your-image --to-script

codiac image add [IMAGENAME]​

Configures a container image to be built and published by the project.

USAGE
  $ codiac image add [IMAGENAME] [-h] [-p <value>] [-f <value>] [-r <value>] [-i <value>] [-e <value>] [-u
    <value>] [-s <value>] [-b <value>] [--silent | --echo | --to-script]

ARGUMENTS
  IMAGENAME  Image name including scope prefix, eg: "your-company/your-image".

FLAGS
  -b, --buildParams=<value>...  Additional freeform arguments to apply to the Docker build command (as: arg=val, eg: -b
                                "--size=12" -b "--color=blue").
  -e, --environment=<value>     (Optional) Declaration that this registry shall be the target when publishing to the
                                given environment.
  -f, --sourceFile=<value>      Path and filename of the image definition file, relative to the project root (eg:
                                "./Dockerfile"). If omitted, the build will use an in-memory image definition
                                auto-generated at build time.
  -h, --help                    Show CLI help.
  -i, --infoUrl=<value>         (Optional) Address on the registry website or portal of the human-readable web page for
                                the image.
  -p, --port=<value>            Recommended port number to assign, in the toybox template, to an Asset defined by this
                                image.
  -r, --registryUrl=<value>     [default: https://index.docker.io/v1] (Optional, defaults to Docker Hub) Address of the
                                container registry to which the image will be published (without protocol prefix), eg:
                                "yourimages.azurecr.io".
  -s, --password=<value>        (Optional) Password credential for the given registry. WARNING: these credentials will
                                be stored in the codiac config file in this project.
  -u, --username=<value>        (Optional) Login credential for the given registry. WARNING: these credentials will be
                                stored in the codiac config file in this project.
  --echo                        Renders the equivalent non-interactive command for future use before executing.
  --silent                      Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                   Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Configures a container image to be built and published by the project.

ALIASES
  $ codiac image
  $ codiac image add
  $ codiac img
  $ codiac img add

EXAMPLES
  Configure an image interactively.

    $ codiac image add

  Configure a named image.

    $ codiac image add your-company/your-image

  Renders the equivalent silent command without executing.

    $ codiac image add your-company/your-image --to-script

codiac image delete IMAGENAME​

Deletes the given image export from the configuration.

USAGE
  $ codiac image delete IMAGENAME [-h]

ARGUMENTS
  IMAGENAME  image name including, scope prefix. eg:  "your-company/your-image"

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Deletes the given image export from the configuration.

ALIASES
  $ codiac image remove
  $ codiac img remove
  $ codiac image delete
  $ codiac img delete

codiac image list​

Renders the list of container images that are configured as project exports.

USAGE
  $ codiac image list [-h] [-o table|extended|json|csv]

FLAGS
  -h, --help             Show CLI help.
  -o, --output=<option>  [default: table] Format for the response data.
                         <options: table|extended|json|csv>

DESCRIPTION
  Renders the list of container images that are configured as project exports.

ALIASES
  $ codiac image list
  $ codiac img list

codiac image patch IMAGENAME​

Applies the given values to an existing image export configuration. Both registryUrl and environment act as filters to limit the operation. That is, an upsert of registry targets is performed for the given image, based on the given registryUrl and/or environment.

USAGE
  $ codiac image patch IMAGENAME [-h] [-s <value>] [-u <value>]

ARGUMENTS
  IMAGENAME  image name including, scope prefix. eg:  "your-company/your-image"

FLAGS
  -h, --help           Show CLI help.
  -s, --set=<value>    Space-delimited list of key-value pairs tp apply with json-path on the left and the desired value
                       on the right.  (eg:  --set .targets.default.registryUrl=mystuff.azurecr.io)
  -u, --unset=<value>  Space-delimited list of properties to clear, in json-path format.  (eg:  --unset
                       .targets.default)

DESCRIPTION
  Applies the given values to an existing image export configuration.  Both registryUrl and environment act as filters
  to limit the operation.  That is, an upsert of registry targets is performed for the given image, based on the given
  registryUrl and/or environment.

ALIASES
  $ codiac image patch
  $ codiac img patch

codiac image remove IMAGENAME​

Deletes the given image export from the configuration.

USAGE
  $ codiac image remove IMAGENAME [-h]

ARGUMENTS
  IMAGENAME  image name including, scope prefix. eg:  "your-company/your-image"

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Deletes the given image export from the configuration.

ALIASES
  $ codiac image remove
  $ codiac img remove
  $ codiac image delete
  $ codiac img delete

codiac image version bump NAME​

Output the local version a given image. useful for ci/cd automation.

USAGE
  $ codiac image version bump NAME [-h] [--version <value>] [-M] [-m] [-p] [-r] [-i <value>]

ARGUMENTS
  NAME  Image name (as it appears in the codiac.json)

FLAGS
  -M, --major          Increments the version by one Major version number (using Major.Minor.Patch).
  -h, --help           Show CLI help.
  -i, --preid=<value>  Sets the prereleaseId and resets the prerelease number (or increments it if the same preid is
                       already set) (using Major.Minor.Patch-PreId.PreRelease).  NOTE:  Increments the Patch version
                       number when appending.
  -m, --minor          Increments the version by one Minor version number (using Major.Minor.Patch).
  -p, --patch          Increments the version by one Patch version number (using Major.Minor.Patch).
  -r, --prerelease     (default for this command) Increments the prerelease number (using Major.Minor.Patch-PreRelease).
                       NOTE:  Increments the Patch version number when appending.
  --version=<value>    Overwrites the full version for the build (using Major.Minor.Patch).

DESCRIPTION
  Output the local version a given image. useful for ci/cd automation.

ALIASES
  $ codiac image version bump
  $ codiac img version bump

codiac image version get NAME​

Output the local version a given image. useful for ci/cd automation.

USAGE
  $ codiac image version get NAME [-h] [-o stdOut|json]

ARGUMENTS
  NAME  Image name

FLAGS
  -h, --help             Show CLI help.
  -o, --output=<option>  [default: stdOut] Format for the response data.
                         <options: stdOut|json>

DESCRIPTION
  Output the local version a given image. useful for ci/cd automation.

ALIASES
  $ codiac image version get
  $ codiac img version get

codiac imageRegistry capture​

Saves a reference to an existing container registry.

USAGE
  $ codiac imageRegistry capture [-h] [-u <value>] [-p artifactHub|aws|azure|dockerHub|localMachine|other] [-n <value>] [-s
    <value>] [-l <value>] [--silent | --echo | --to-script]

FLAGS
  -h, --help                    Show CLI help.
  -l, --location=<value>        The data center in which the registry resides (use the code name, eg: in Aws use
                                'us-east-1', NOT 'Virginia, US').
  -n, --name=<value>            The resource name of the container registry within the cloud provider subscription.
  -p, --provider=<option>       The cloud provider hosting the container registry.
                                <options: artifactHub|aws|azure|dockerHub|localMachine|other>
  -s, --subscriptionId=<value>  The id of the cloud provider account in which the registry resides.
  -u, --url=<value>             The container registry url.
  --echo                        Renders the equivalent non-interactive command for future use before executing.
  --silent                      Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                   Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Saves a reference to an existing container registry.

See code: dist/commands/imageRegistry/capture.ts

codiac imageRegistry forget​

Removes the reference to the given container registry for the tenant. Does NOT delete the registry itself.

USAGE
  $ codiac imageRegistry forget [-h] [-r <value>] [--silent | --echo | --to-script]

FLAGS
  -h, --help              Show CLI help.
  -r, --registry=<value>  The container registry to forget.
  --echo                  Renders the equivalent non-interactive command for future use before executing.
  --silent                Executes without any user interaction; fails on missing or invalid arguments.
  --to-script             Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Removes the reference to the given container registry for the tenant.  Does NOT delete the registry itself.

See code: dist/commands/imageRegistry/forget.ts

codiac imageRegistry list​

Retrieves all existing references to the container registries storing the published versions of asset images.

USAGE
  $ codiac imageRegistry list [-o json|yaml|text] [--take-defaults | [--silent | --echo | --to-script]]

FLAGS
  -o, --output=<option>  [default: text] format in which to render the data.
                         <options: json|yaml|text>
  --echo                 Echo interaction mode; renders the equivalent non-interactive cli command for future use before
                         final execution.
  --silent               Non-Interactive mode; executes without any user interaction and fails on any missing or invalid
                         arguments.
  --take-defaults        Setting this to true prevents prompting for confirmation on parameters that were passed in or
                         were automatically set to default values (Irrelevant in --silent mode).  This behavior does NOT
                         apply to scenarios that the command needs to override invalid user input; such cases will
                         always prompt for confirmation.  eg: when no argument was provided for file or type, and only
                         one exists, the system will render the autoselected file unless this flag is set.
  --to-script            Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                         execution.

DESCRIPTION
  Retrieves all existing references to the container registries storing the published versions of asset images.

EXAMPLES
  Simple text output

    $ codiac imageRegistry list

  Output as json:

    $ codiac imageRegistry list -o json

  Pipe to a yaml file:

    $ codiac imageRegistry list -o yaml > registries.yaml

See code: dist/commands/imageRegistry/list.ts

codiac imageRegistry pullSecret set​

Upserts the primary and secondary pull secret references for the given container registry.

USAGE
  $ codiac imageRegistry pullSecret set [-h] [-r <value> | ] [-f primary|secondary] [--scope everywhere|unmatchingSubx] [-t
    awsKeyVault|azBlob|azKeyVault|etcd|mongoCollection|mongoDocument] [-s <value>] [-n <value>] [--silent | --echo |
    --to-script]

FLAGS
  -f, --item=<option>       [default: primary] Applies the command to either the primary (default) or secondary secret
                            for the image registry.
                            <options: primary|secondary>
  -h, --help                Show CLI help.
  -n, --name=<value>        The name of the secret within the secret store.
  -r, --registry=<value>    The container registry in which the image exists (defaults to docker hub).
  -s, --storeName=<value>   The name of the secret store containing the actual pull secrets.
  -t, --storeType=<option>  The type of secret store containing the actual pull secrets.
                            <options: awsKeyVault|azBlob|azKeyVault|etcd|mongoCollection|mongoDocument>
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --scope=<option>          Applicability of the pullsecret. Allows for other authorization methods when the cluster and
                            image registry are in the same subscription.
                            <options: everywhere|unmatchingSubx>
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Upserts the primary and secondary pull secret references for the given container registry.

ALIASES
  $ codiac pullsecret

See code: dist/commands/imageRegistry/pullSecret/set.ts

codiac imageRegistry pullSecret unset​

Removes the primary or secondary pull secret reference for the given container registry.

USAGE
  $ codiac imageRegistry pullSecret unset [-h] [-r <value> | ] [-f primary|secondary] [--silent | --echo | --to-script]

FLAGS
  -f, --item=<option>     [default: primary] Applies the command to either the primary (default) or secondary secret for
                          the image registry.
                          <options: primary|secondary>
  -h, --help              Show CLI help.
  -r, --registry=<value>  The container registry in which the image exists (defaults to docker hub).
  --echo                  Renders the equivalent non-interactive command for future use before executing.
  --silent                Executes without any user interaction; fails on missing or invalid arguments.
  --to-script             Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Removes the primary or secondary pull secret reference for the given container registry.

ALIASES
  $ codiac pullsecret unset

See code: dist/commands/imageRegistry/pullSecret/unset.ts

codiac images add [IMAGENAME]​

Configures a container image to be built and published by the project.

USAGE
  $ codiac images add [IMAGENAME] [-h] [-p <value>] [-f <value>] [-r <value>] [-i <value>] [-e <value>] [-u
    <value>] [-s <value>] [-b <value>] [--silent | --echo | --to-script]

ARGUMENTS
  IMAGENAME  Image name including scope prefix, eg: "your-company/your-image".

FLAGS
  -b, --buildParams=<value>...  Additional freeform arguments to apply to the Docker build command (as: arg=val, eg: -b
                                "--size=12" -b "--color=blue").
  -e, --environment=<value>     (Optional) Declaration that this registry shall be the target when publishing to the
                                given environment.
  -f, --sourceFile=<value>      Path and filename of the image definition file, relative to the project root (eg:
                                "./Dockerfile"). If omitted, the build will use an in-memory image definition
                                auto-generated at build time.
  -h, --help                    Show CLI help.
  -i, --infoUrl=<value>         (Optional) Address on the registry website or portal of the human-readable web page for
                                the image.
  -p, --port=<value>            Recommended port number to assign, in the toybox template, to an Asset defined by this
                                image.
  -r, --registryUrl=<value>     [default: https://index.docker.io/v1] (Optional, defaults to Docker Hub) Address of the
                                container registry to which the image will be published (without protocol prefix), eg:
                                "yourimages.azurecr.io".
  -s, --password=<value>        (Optional) Password credential for the given registry. WARNING: these credentials will
                                be stored in the codiac config file in this project.
  -u, --username=<value>        (Optional) Login credential for the given registry. WARNING: these credentials will be
                                stored in the codiac config file in this project.
  --echo                        Renders the equivalent non-interactive command for future use before executing.
  --silent                      Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                   Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Configures a container image to be built and published by the project.

ALIASES
  $ codiac image
  $ codiac image add
  $ codiac img
  $ codiac img add

EXAMPLES
  Configure an image interactively.

    $ codiac images add

  Configure a named image.

    $ codiac images add your-company/your-image

  Renders the equivalent silent command without executing.

    $ codiac images add your-company/your-image --to-script

See code: dist/commands/images/add.ts

codiac images list​

Renders the list of container images that are configured as project exports.

USAGE
  $ codiac images list [-h] [-o table|extended|json|csv]

FLAGS
  -h, --help             Show CLI help.
  -o, --output=<option>  [default: table] Format for the response data.
                         <options: table|extended|json|csv>

DESCRIPTION
  Renders the list of container images that are configured as project exports.

ALIASES
  $ codiac image list
  $ codiac img list

See code: dist/commands/images/list.ts

codiac images patch IMAGENAME​

Applies the given values to an existing image export configuration. Both registryUrl and environment act as filters to limit the operation. That is, an upsert of registry targets is performed for the given image, based on the given registryUrl and/or environment.

USAGE
  $ codiac images patch IMAGENAME [-h] [-s <value>] [-u <value>]

ARGUMENTS
  IMAGENAME  image name including, scope prefix. eg:  "your-company/your-image"

FLAGS
  -h, --help           Show CLI help.
  -s, --set=<value>    Space-delimited list of key-value pairs tp apply with json-path on the left and the desired value
                       on the right.  (eg:  --set .targets.default.registryUrl=mystuff.azurecr.io)
  -u, --unset=<value>  Space-delimited list of properties to clear, in json-path format.  (eg:  --unset
                       .targets.default)

DESCRIPTION
  Applies the given values to an existing image export configuration.  Both registryUrl and environment act as filters
  to limit the operation.  That is, an upsert of registry targets is performed for the given image, based on the given
  registryUrl and/or environment.

ALIASES
  $ codiac image patch
  $ codiac img patch

See code: dist/commands/images/patch.ts

codiac images remove IMAGENAME​

Deletes the given image export from the configuration.

USAGE
  $ codiac images remove IMAGENAME [-h]

ARGUMENTS
  IMAGENAME  image name including, scope prefix. eg:  "your-company/your-image"

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Deletes the given image export from the configuration.

ALIASES
  $ codiac image remove
  $ codiac img remove
  $ codiac image delete
  $ codiac img delete

See code: dist/commands/images/remove.ts

codiac images version NAME​

Output the local version a given image. useful for ci/cd automation.

USAGE
  $ codiac images version NAME [-h] [-o stdOut|json]

ARGUMENTS
  NAME  Image name

FLAGS
  -h, --help             Show CLI help.
  -o, --output=<option>  [default: stdOut] Format for the response data.
                         <options: stdOut|json>

DESCRIPTION
  Output the local version a given image. useful for ci/cd automation.

ALIASES
  $ codiac image version get
  $ codiac img version get

See code: dist/commands/images/version.ts

codiac images version bump NAME​

Output the local version a given image. useful for ci/cd automation.

USAGE
  $ codiac images version bump NAME [-h] [--version <value>] [-M] [-m] [-p] [-r] [-i <value>]

ARGUMENTS
  NAME  Image name (as it appears in the codiac.json)

FLAGS
  -M, --major          Increments the version by one Major version number (using Major.Minor.Patch).
  -h, --help           Show CLI help.
  -i, --preid=<value>  Sets the prereleaseId and resets the prerelease number (or increments it if the same preid is
                       already set) (using Major.Minor.Patch-PreId.PreRelease).  NOTE:  Increments the Patch version
                       number when appending.
  -m, --minor          Increments the version by one Minor version number (using Major.Minor.Patch).
  -p, --patch          Increments the version by one Patch version number (using Major.Minor.Patch).
  -r, --prerelease     (default for this command) Increments the prerelease number (using Major.Minor.Patch-PreRelease).
                       NOTE:  Increments the Patch version number when appending.
  --version=<value>    Overwrites the full version for the build (using Major.Minor.Patch).

DESCRIPTION
  Output the local version a given image. useful for ci/cd automation.

ALIASES
  $ codiac image version bump
  $ codiac img version bump

See code: dist/commands/images/version/bump.ts

codiac img [IMAGENAME]​

Configures a container image to be built and published by the project.

USAGE
  $ codiac img [IMAGENAME] [-h] [-p <value>] [-f <value>] [-r <value>] [-i <value>] [-e <value>] [-u
    <value>] [-s <value>] [-b <value>] [--silent | --echo | --to-script]

ARGUMENTS
  IMAGENAME  Image name including scope prefix, eg: "your-company/your-image".

FLAGS
  -b, --buildParams=<value>...  Additional freeform arguments to apply to the Docker build command (as: arg=val, eg: -b
                                "--size=12" -b "--color=blue").
  -e, --environment=<value>     (Optional) Declaration that this registry shall be the target when publishing to the
                                given environment.
  -f, --sourceFile=<value>      Path and filename of the image definition file, relative to the project root (eg:
                                "./Dockerfile"). If omitted, the build will use an in-memory image definition
                                auto-generated at build time.
  -h, --help                    Show CLI help.
  -i, --infoUrl=<value>         (Optional) Address on the registry website or portal of the human-readable web page for
                                the image.
  -p, --port=<value>            Recommended port number to assign, in the toybox template, to an Asset defined by this
                                image.
  -r, --registryUrl=<value>     [default: https://index.docker.io/v1] (Optional, defaults to Docker Hub) Address of the
                                container registry to which the image will be published (without protocol prefix), eg:
                                "yourimages.azurecr.io".
  -s, --password=<value>        (Optional) Password credential for the given registry. WARNING: these credentials will
                                be stored in the codiac config file in this project.
  -u, --username=<value>        (Optional) Login credential for the given registry. WARNING: these credentials will be
                                stored in the codiac config file in this project.
  --echo                        Renders the equivalent non-interactive command for future use before executing.
  --silent                      Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                   Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Configures a container image to be built and published by the project.

ALIASES
  $ codiac image
  $ codiac image add
  $ codiac img
  $ codiac img add

EXAMPLES
  Configure an image interactively.

    $ codiac img

  Configure a named image.

    $ codiac img your-company/your-image

  Renders the equivalent silent command without executing.

    $ codiac img your-company/your-image --to-script

codiac img add [IMAGENAME]​

Configures a container image to be built and published by the project.

USAGE
  $ codiac img add [IMAGENAME] [-h] [-p <value>] [-f <value>] [-r <value>] [-i <value>] [-e <value>] [-u
    <value>] [-s <value>] [-b <value>] [--silent | --echo | --to-script]

ARGUMENTS
  IMAGENAME  Image name including scope prefix, eg: "your-company/your-image".

FLAGS
  -b, --buildParams=<value>...  Additional freeform arguments to apply to the Docker build command (as: arg=val, eg: -b
                                "--size=12" -b "--color=blue").
  -e, --environment=<value>     (Optional) Declaration that this registry shall be the target when publishing to the
                                given environment.
  -f, --sourceFile=<value>      Path and filename of the image definition file, relative to the project root (eg:
                                "./Dockerfile"). If omitted, the build will use an in-memory image definition
                                auto-generated at build time.
  -h, --help                    Show CLI help.
  -i, --infoUrl=<value>         (Optional) Address on the registry website or portal of the human-readable web page for
                                the image.
  -p, --port=<value>            Recommended port number to assign, in the toybox template, to an Asset defined by this
                                image.
  -r, --registryUrl=<value>     [default: https://index.docker.io/v1] (Optional, defaults to Docker Hub) Address of the
                                container registry to which the image will be published (without protocol prefix), eg:
                                "yourimages.azurecr.io".
  -s, --password=<value>        (Optional) Password credential for the given registry. WARNING: these credentials will
                                be stored in the codiac config file in this project.
  -u, --username=<value>        (Optional) Login credential for the given registry. WARNING: these credentials will be
                                stored in the codiac config file in this project.
  --echo                        Renders the equivalent non-interactive command for future use before executing.
  --silent                      Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                   Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Configures a container image to be built and published by the project.

ALIASES
  $ codiac image
  $ codiac image add
  $ codiac img
  $ codiac img add

EXAMPLES
  Configure an image interactively.

    $ codiac img add

  Configure a named image.

    $ codiac img add your-company/your-image

  Renders the equivalent silent command without executing.

    $ codiac img add your-company/your-image --to-script

codiac img delete IMAGENAME​

Deletes the given image export from the configuration.

USAGE
  $ codiac img delete IMAGENAME [-h]

ARGUMENTS
  IMAGENAME  image name including, scope prefix. eg:  "your-company/your-image"

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Deletes the given image export from the configuration.

ALIASES
  $ codiac image remove
  $ codiac img remove
  $ codiac image delete
  $ codiac img delete

codiac img list​

Renders the list of container images that are configured as project exports.

USAGE
  $ codiac img list [-h] [-o table|extended|json|csv]

FLAGS
  -h, --help             Show CLI help.
  -o, --output=<option>  [default: table] Format for the response data.
                         <options: table|extended|json|csv>

DESCRIPTION
  Renders the list of container images that are configured as project exports.

ALIASES
  $ codiac image list
  $ codiac img list

codiac img patch IMAGENAME​

Applies the given values to an existing image export configuration. Both registryUrl and environment act as filters to limit the operation. That is, an upsert of registry targets is performed for the given image, based on the given registryUrl and/or environment.

USAGE
  $ codiac img patch IMAGENAME [-h] [-s <value>] [-u <value>]

ARGUMENTS
  IMAGENAME  image name including, scope prefix. eg:  "your-company/your-image"

FLAGS
  -h, --help           Show CLI help.
  -s, --set=<value>    Space-delimited list of key-value pairs tp apply with json-path on the left and the desired value
                       on the right.  (eg:  --set .targets.default.registryUrl=mystuff.azurecr.io)
  -u, --unset=<value>  Space-delimited list of properties to clear, in json-path format.  (eg:  --unset
                       .targets.default)

DESCRIPTION
  Applies the given values to an existing image export configuration.  Both registryUrl and environment act as filters
  to limit the operation.  That is, an upsert of registry targets is performed for the given image, based on the given
  registryUrl and/or environment.

ALIASES
  $ codiac image patch
  $ codiac img patch

codiac img remove IMAGENAME​

Deletes the given image export from the configuration.

USAGE
  $ codiac img remove IMAGENAME [-h]

ARGUMENTS
  IMAGENAME  image name including, scope prefix. eg:  "your-company/your-image"

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Deletes the given image export from the configuration.

ALIASES
  $ codiac image remove
  $ codiac img remove
  $ codiac image delete
  $ codiac img delete

codiac img version bump NAME​

Output the local version a given image. useful for ci/cd automation.

USAGE
  $ codiac img version bump NAME [-h] [--version <value>] [-M] [-m] [-p] [-r] [-i <value>]

ARGUMENTS
  NAME  Image name (as it appears in the codiac.json)

FLAGS
  -M, --major          Increments the version by one Major version number (using Major.Minor.Patch).
  -h, --help           Show CLI help.
  -i, --preid=<value>  Sets the prereleaseId and resets the prerelease number (or increments it if the same preid is
                       already set) (using Major.Minor.Patch-PreId.PreRelease).  NOTE:  Increments the Patch version
                       number when appending.
  -m, --minor          Increments the version by one Minor version number (using Major.Minor.Patch).
  -p, --patch          Increments the version by one Patch version number (using Major.Minor.Patch).
  -r, --prerelease     (default for this command) Increments the prerelease number (using Major.Minor.Patch-PreRelease).
                       NOTE:  Increments the Patch version number when appending.
  --version=<value>    Overwrites the full version for the build (using Major.Minor.Patch).

DESCRIPTION
  Output the local version a given image. useful for ci/cd automation.

ALIASES
  $ codiac image version bump
  $ codiac img version bump

codiac img version get NAME​

Output the local version a given image. useful for ci/cd automation.

USAGE
  $ codiac img version get NAME [-h] [-o stdOut|json]

ARGUMENTS
  NAME  Image name

FLAGS
  -h, --help             Show CLI help.
  -o, --output=<option>  [default: stdOut] Format for the response data.
                         <options: stdOut|json>

DESCRIPTION
  Output the local version a given image. useful for ci/cd automation.

ALIASES
  $ codiac image version get
  $ codiac img version get

codiac infrx cab create [CABINET]​

Initializes a cabinet for a given enterprise and environment. Returns an error if the cabinet already exists.

USAGE
  $ codiac infrx cab create [CABINET] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h] [--enterprise <value>] [-e <value>] [-c <value>] [--take-defaults | [--silent | --echo
    | --to-script]]

ARGUMENTS
  CABINET  The name of the cabinet to create

FLAGS
  -c, --cluster=<value>      (optional: defaults to the first cluster in the environment) The name of the cluster to use
                             for the cabinet.
  -e, --environment=<value>  (optional: defaults to that of the current project branch) The name of the environment this
                             cabinet will be grouped under.
  -h, --help                 Show CLI help.
  -v, --verbose              Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>               Fires this command with an argument list that was previously remembered using the
                             --rememberAs flag.
  --echo                     Echo interaction mode; renders the equivalent non-interactive cli command for future use
                             before final execution.
  --enterprise=<value>       (required only if more than one enterprise exists) The name of the enterprise under which
                             to create this cabinet.
  --remember                 Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>       Saves the given argument list so that it can be called by name.
  --silent                   Non-Interactive mode; executes without any user interaction and fails on any missing or
                             invalid arguments.
  --take-defaults            Setting this to true prevents prompting for confirmation on parameters that were passed in
                             or were automatically set to default values (Irrelevant in --silent mode).
  --to-script                Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                             execution.
  --unremember=<value>       Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                             were previously stored under the given name (use "--unRemember default" to clear default
                             argument list memorized with the --remember flag).
  --withoutdefaults          Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Initializes a cabinet for a given enterprise and environment. Returns an error if the cabinet already exists.

ALIASES
  $ codiac cab create
  $ codiac infrx cabinet create
  $ codiac infrx cab create

EXAMPLES
  Create a cabinet interatively.

    cod cabinet create

  Create a cabinet interatively and assemble a non-interactive command string.

    cod cabinet create --echo

  Assemble a non-interactive command string WITHOUT actually creating a cabinet (dry run).

    cod cabinet create --to-script

  Create a cabinet silently.

    cod cabinet create my-cab-name --enterprise main -e dev-environemt -c my-cluster --silent

codiac infrx cab list​

Shows the list of cabinets and environment.

USAGE
  $ codiac infrx cab list [-h] [-e <value>] [-o json|yaml|tree|text] [-q <value>] [--silent | --echo | --to-script]

FLAGS
  -e, --enterprise=<value>  The name of the enterprise in which to list cabinets (required only if more than one
                            enterprise exists).
  -h, --help                Show CLI help.
  -o, --output=<option>     Format in which to render the results (defaults to tree).
                            <options: json|yaml|tree|text>
  -q, --query=<value>       JMESPath expression to filter or reshape the results (see jmespath.org).
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Shows the list of cabinets and environment.

ALIASES
  $ codiac cab list
  $ codiac infrx cabinet list
  $ codiac infrx cab list

EXAMPLES
  List all cabinets for the current enterprise.

    $ codiac infrx cab list

  List cabinets for a specific enterprise.

    $ codiac infrx cab list -e myEnterprise

  List cabinet names only.

    $ codiac infrx cab list -q '[].name'

  Export as YAML.

    $ codiac infrx cab list -o yaml

  Non-interactive (scripted) invocation.

    $ codiac infrx cab list -e myEnterprise --silent

codiac infrx cab obliterate [CABINET]​

Hard-deletes an entire cabinet and everything in it; makes it as if the cabinet itself never existed.

USAGE
  $ codiac infrx cab obliterate [CABINET] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h] [-c <value>] [-n <value>] [-e <value>] [-s | -x | -t] [-d]

ARGUMENTS
  CABINET  The name of the cabinet

FLAGS
  -c, --cabinet=<value>      REQUIRED: The name of the cabinet
  -d, --take-defaults        Take all defaults for prompts
  -e, --environment=<value>  REQUIRED: The name of the environment this cabinet will be grouped under.
  -h, --help                 Show CLI help.
  -n, --enterprise=<value>   REQUIRED: The name of the enterprise containing the cabinet.
  -s, --silent               Runs the command in silent mode. Requires --enterprise, --environment, and --cabinet flags.
  -t, --to-script            Prints the command that would be executed to the console and exits
  -v, --verbose              Renders additional logging levels (detail, trace, and debug) to the console output.
  -x, --echo                 Prints the command that would be executed to the console
  --as=<value>               Fires this command with an argument list that was previously remembered using the
                             --rememberAs flag.
  --remember                 Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>       Saves the given argument list so that it can be called by name.
  --unremember=<value>       Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                             were previously stored under the given name (use "--unRemember default" to clear default
                             argument list memorized with the --remember flag).
  --withoutdefaults          Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Hard-deletes an entire cabinet and everything in it; makes it as if the cabinet itself never existed.

ALIASES
  $ codiac cab obliterate
  $ codiac infrx cabinet obliterate
  $ codiac infrx cab obliterate

codiac infrx cabinet create [CABINET]​

Initializes a cabinet for a given enterprise and environment. Returns an error if the cabinet already exists.

USAGE
  $ codiac infrx cabinet create [CABINET] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h] [--enterprise <value>] [-e <value>] [-c <value>] [--take-defaults | [--silent | --echo
    | --to-script]]

ARGUMENTS
  CABINET  The name of the cabinet to create

FLAGS
  -c, --cluster=<value>      (optional: defaults to the first cluster in the environment) The name of the cluster to use
                             for the cabinet.
  -e, --environment=<value>  (optional: defaults to that of the current project branch) The name of the environment this
                             cabinet will be grouped under.
  -h, --help                 Show CLI help.
  -v, --verbose              Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>               Fires this command with an argument list that was previously remembered using the
                             --rememberAs flag.
  --echo                     Echo interaction mode; renders the equivalent non-interactive cli command for future use
                             before final execution.
  --enterprise=<value>       (required only if more than one enterprise exists) The name of the enterprise under which
                             to create this cabinet.
  --remember                 Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>       Saves the given argument list so that it can be called by name.
  --silent                   Non-Interactive mode; executes without any user interaction and fails on any missing or
                             invalid arguments.
  --take-defaults            Setting this to true prevents prompting for confirmation on parameters that were passed in
                             or were automatically set to default values (Irrelevant in --silent mode).
  --to-script                Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                             execution.
  --unremember=<value>       Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                             were previously stored under the given name (use "--unRemember default" to clear default
                             argument list memorized with the --remember flag).
  --withoutdefaults          Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Initializes a cabinet for a given enterprise and environment. Returns an error if the cabinet already exists.

ALIASES
  $ codiac cab create
  $ codiac infrx cabinet create
  $ codiac infrx cab create

EXAMPLES
  Create a cabinet interatively.

    cod cabinet create

  Create a cabinet interatively and assemble a non-interactive command string.

    cod cabinet create --echo

  Assemble a non-interactive command string WITHOUT actually creating a cabinet (dry run).

    cod cabinet create --to-script

  Create a cabinet silently.

    cod cabinet create my-cab-name --enterprise main -e dev-environemt -c my-cluster --silent

codiac infrx cabinet list​

Shows the list of cabinets and environment.

USAGE
  $ codiac infrx cabinet list [-h] [-e <value>] [-o json|yaml|tree|text] [-q <value>] [--silent | --echo | --to-script]

FLAGS
  -e, --enterprise=<value>  The name of the enterprise in which to list cabinets (required only if more than one
                            enterprise exists).
  -h, --help                Show CLI help.
  -o, --output=<option>     Format in which to render the results (defaults to tree).
                            <options: json|yaml|tree|text>
  -q, --query=<value>       JMESPath expression to filter or reshape the results (see jmespath.org).
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Shows the list of cabinets and environment.

ALIASES
  $ codiac cab list
  $ codiac infrx cabinet list
  $ codiac infrx cab list

EXAMPLES
  List all cabinets for the current enterprise.

    $ codiac infrx cabinet list

  List cabinets for a specific enterprise.

    $ codiac infrx cabinet list -e myEnterprise

  List cabinet names only.

    $ codiac infrx cabinet list -q '[].name'

  Export as YAML.

    $ codiac infrx cabinet list -o yaml

  Non-interactive (scripted) invocation.

    $ codiac infrx cabinet list -e myEnterprise --silent

codiac infrx cabinet obliterate [CABINET]​

Hard-deletes an entire cabinet and everything in it; makes it as if the cabinet itself never existed.

USAGE
  $ codiac infrx cabinet obliterate [CABINET] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h] [-c <value>] [-n <value>] [-e <value>] [-s | -x | -t] [-d]

ARGUMENTS
  CABINET  The name of the cabinet

FLAGS
  -c, --cabinet=<value>      REQUIRED: The name of the cabinet
  -d, --take-defaults        Take all defaults for prompts
  -e, --environment=<value>  REQUIRED: The name of the environment this cabinet will be grouped under.
  -h, --help                 Show CLI help.
  -n, --enterprise=<value>   REQUIRED: The name of the enterprise containing the cabinet.
  -s, --silent               Runs the command in silent mode. Requires --enterprise, --environment, and --cabinet flags.
  -t, --to-script            Prints the command that would be executed to the console and exits
  -v, --verbose              Renders additional logging levels (detail, trace, and debug) to the console output.
  -x, --echo                 Prints the command that would be executed to the console
  --as=<value>               Fires this command with an argument list that was previously remembered using the
                             --rememberAs flag.
  --remember                 Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>       Saves the given argument list so that it can be called by name.
  --unremember=<value>       Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                             were previously stored under the given name (use "--unRemember default" to clear default
                             argument list memorized with the --remember flag).
  --withoutdefaults          Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Hard-deletes an entire cabinet and everything in it; makes it as if the cabinet itself never existed.

ALIASES
  $ codiac cab obliterate
  $ codiac infrx cabinet obliterate
  $ codiac infrx cab obliterate

codiac infrx enviro cluster attach​

Includes the given cluster within the given environment. DOES NOT modify any infrastructure; only creates an association within Codiac.

USAGE
  $ codiac infrx enviro cluster attach [-e <value>] [-n <value>] [-c <value>] [--take-defaults | [--silent | --echo |
    --to-script]]

FLAGS
  -c, --cluster=<value>
      Name of the cluster.

  -e, --enterprise=<value>
      The name of the enterprise in which the environment resides. NOTE: You can leave this blank if there is only one.

  -n, --environment=<value>
      Name of the environment being modified.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Includes the given cluster within the given environment.  DOES NOT modify any infrastructure; only creates an
  association within Codiac.

ALIASES
  $ codiac enviro cluster attach
  $ codiac infrx environment cluster attach
  $ codiac infrx enviro cluster attach

codiac infrx enviro cluster detach​

Removes the linkage between the given environment and the given cluster. DOES NOT delete any infrastructure; only the association within Codiac.

USAGE
  $ codiac infrx enviro cluster detach [-e <value>] [-n <value>] [-c <value>] [--take-defaults | [--silent | --echo |
    --to-script]]

FLAGS
  -c, --cluster=<value>
      Name of the cluster.

  -e, --enterprise=<value>
      The name of the enterprise in which the environment resides. NOTE: You can leave this blank if there is only one.

  -n, --environment=<value>
      Name of the environment being modified.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Removes the linkage between the given environment and the given cluster.  DOES NOT delete any infrastructure; only the
  association within Codiac.

ALIASES
  $ codiac enviro cluster detach
  $ codiac infrx environment cluster detach
  $ codiac infrx enviro cluster detach

codiac infrx enviro create [NAME]​

Create a new environment for a given enterprise. Returns an error if the environment already exists.

USAGE
  $ codiac infrx enviro create [NAME] [-c <value>] [-e <value>] [--as <value>] [--remember] [--rememberAs <value>]
    [--unremember <value>] [--withoutdefaults] [-v] [-h] [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  NAME  The name of the environment to create

FLAGS
  -c, --cluster=<value>...  (Required in silent mode) The cluster/s the environment will include.
  -e, --enterprise=<value>  (required only if more than one enterprise exists) The enterprise in which to create the
                            environment.
  -h, --help                Show CLI help.
  -v, --verbose             Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>              Fires this command with an argument list that was previously remembered using the
                            --rememberAs flag.
  --echo                    Echo interaction mode; renders the equivalent non-interactive cli command for future use
                            before final execution.
  --remember                Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>      Saves the given argument list so that it can be called by name.
  --silent                  Non-Interactive mode; executes without any user interaction and fails on any missing or
                            invalid arguments.
  --take-defaults           Setting this to true prevents prompting for confirmation on parameters that were passed in
                            or were automatically set to default values (Irrelevant in --silent mode).
  --to-script               Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                            execution.
  --unremember=<value>      Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                            were previously stored under the given name (use "--unRemember default" to clear default
                            argument list memorized with the --remember flag).
  --withoutdefaults         Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Create a new environment for a given enterprise. Returns an error if the environment already exists.

ALIASES
  $ codiac enviro create
  $ codiac infrx environment create
  $ codiac infrx enviro create

EXAMPLES
  Create a cabinet interativley.

    cod environment create

  Create a cabinet with cluster selected.

    cod environment create dev --cluster my-cluster-1

  Create a cabinet with multiple clusters selected.

    cod environment create dev --cluster my-cluster-1 --cluster my-cluster-2

  Create a cabinet silently.

    cod environment create dev --enterprise main --cluster my-cluster-1 --cluster my-cluster-2 --silent

codiac infrx enviro delete [NAME]​

Deletes an existing environment from a given enterprise. Returns an error if the environment does not exist.

USAGE
  $ codiac infrx enviro delete [NAME] [-e <value>] [--as <value>] [--remember] [--rememberAs <value>] [--unremember
    <value>] [--withoutdefaults] [-v] [-h] [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  NAME  The name of the environment to delete.

FLAGS
  -e, --enterprise=<value>  Code name of the enterprise from which to delete the environment.
  -h, --help                Show CLI help.
  -v, --verbose             Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>              Fires this command with an argument list that was previously remembered using the
                            --rememberAs flag.
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --remember                Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>      Saves the given argument list so that it can be called by name.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --take-defaults           Accepts default values without prompting for confirmation. (Irrelevant in --silent mode).
  --to-script               Renders the equivalent non-interactive command without executing it.
  --unremember=<value>      Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                            were previously stored under the given name (use "--unRemember default" to clear default
                            argument list memorized with the --remember flag).
  --withoutdefaults         Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Deletes an existing environment from a given enterprise. Returns an error if the environment does not exist.

ALIASES
  $ codiac enviro delete
  $ codiac infrx environment delete
  $ codiac infrx enviro delete

EXAMPLES
  Delete an environment interactively.

    $ codiac infrx enviro delete

  Delete a named environment interactively.

    $ codiac infrx enviro delete dev

  Delete an environment non-interactively.

    $ codiac infrx enviro delete dev --enterprise main --silent

  Renders the equivalent silent command and then executes.

    $ codiac infrx enviro delete dev --enterprise main --echo

  Renders the equivalent silent command without executing.

    $ codiac infrx enviro delete dev --enterprise main --to-script

codiac infrx enviro list​

Shows the list of environments.

USAGE
  $ codiac infrx enviro list [-h] [-e <value>] [-o json|yaml|tree|text] [-q <value>] [--silent | --echo | --to-script]

FLAGS
  -e, --enterprise=<value>  The name of the enterprise to which the environments belong (defaults to the current
                            enterprise context).
  -h, --help                Show CLI help.
  -o, --output=<option>     Format in which to render the results (defaults to tree).
                            <options: json|yaml|tree|text>
  -q, --query=<value>       JMESPath expression to filter or reshape the results (see jmespath.org).
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Shows the list of environments.

ALIASES
  $ codiac enviro list
  $ codiac infrx environment list
  $ codiac infrx enviro list

EXAMPLES
  List all environments for the current enterprise.

    $ codiac infrx enviro list

  List environments for a specific enterprise.

    $ codiac infrx enviro list -e myEnterprise

  List environment names only.

    $ codiac infrx enviro list -q '[].name'

  Export as YAML.

    $ codiac infrx enviro list -o yaml

  Non-interactive (scripted) invocation.

    $ codiac infrx enviro list -e myEnterprise --silent

codiac infrx environment cluster attach​

Includes the given cluster within the given environment. DOES NOT modify any infrastructure; only creates an association within Codiac.

USAGE
  $ codiac infrx environment cluster attach [-e <value>] [-n <value>] [-c <value>] [--take-defaults | [--silent | --echo |
    --to-script]]

FLAGS
  -c, --cluster=<value>
      Name of the cluster.

  -e, --enterprise=<value>
      The name of the enterprise in which the environment resides. NOTE: You can leave this blank if there is only one.

  -n, --environment=<value>
      Name of the environment being modified.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Includes the given cluster within the given environment.  DOES NOT modify any infrastructure; only creates an
  association within Codiac.

ALIASES
  $ codiac enviro cluster attach
  $ codiac infrx environment cluster attach
  $ codiac infrx enviro cluster attach

codiac infrx environment cluster detach​

Removes the linkage between the given environment and the given cluster. DOES NOT delete any infrastructure; only the association within Codiac.

USAGE
  $ codiac infrx environment cluster detach [-e <value>] [-n <value>] [-c <value>] [--take-defaults | [--silent | --echo |
    --to-script]]

FLAGS
  -c, --cluster=<value>
      Name of the cluster.

  -e, --enterprise=<value>
      The name of the enterprise in which the environment resides. NOTE: You can leave this blank if there is only one.

  -n, --environment=<value>
      Name of the environment being modified.

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Removes the linkage between the given environment and the given cluster.  DOES NOT delete any infrastructure; only the
  association within Codiac.

ALIASES
  $ codiac enviro cluster detach
  $ codiac infrx environment cluster detach
  $ codiac infrx enviro cluster detach

codiac infrx environment create [NAME]​

Create a new environment for a given enterprise. Returns an error if the environment already exists.

USAGE
  $ codiac infrx environment create [NAME] [-c <value>] [-e <value>] [--as <value>] [--remember] [--rememberAs <value>]
    [--unremember <value>] [--withoutdefaults] [-v] [-h] [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  NAME  The name of the environment to create

FLAGS
  -c, --cluster=<value>...  (Required in silent mode) The cluster/s the environment will include.
  -e, --enterprise=<value>  (required only if more than one enterprise exists) The enterprise in which to create the
                            environment.
  -h, --help                Show CLI help.
  -v, --verbose             Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>              Fires this command with an argument list that was previously remembered using the
                            --rememberAs flag.
  --echo                    Echo interaction mode; renders the equivalent non-interactive cli command for future use
                            before final execution.
  --remember                Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>      Saves the given argument list so that it can be called by name.
  --silent                  Non-Interactive mode; executes without any user interaction and fails on any missing or
                            invalid arguments.
  --take-defaults           Setting this to true prevents prompting for confirmation on parameters that were passed in
                            or were automatically set to default values (Irrelevant in --silent mode).
  --to-script               Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                            execution.
  --unremember=<value>      Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                            were previously stored under the given name (use "--unRemember default" to clear default
                            argument list memorized with the --remember flag).
  --withoutdefaults         Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Create a new environment for a given enterprise. Returns an error if the environment already exists.

ALIASES
  $ codiac enviro create
  $ codiac infrx environment create
  $ codiac infrx enviro create

EXAMPLES
  Create a cabinet interativley.

    cod environment create

  Create a cabinet with cluster selected.

    cod environment create dev --cluster my-cluster-1

  Create a cabinet with multiple clusters selected.

    cod environment create dev --cluster my-cluster-1 --cluster my-cluster-2

  Create a cabinet silently.

    cod environment create dev --enterprise main --cluster my-cluster-1 --cluster my-cluster-2 --silent

codiac infrx environment delete [NAME]​

Deletes an existing environment from a given enterprise. Returns an error if the environment does not exist.

USAGE
  $ codiac infrx environment delete [NAME] [-e <value>] [--as <value>] [--remember] [--rememberAs <value>] [--unremember
    <value>] [--withoutdefaults] [-v] [-h] [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  NAME  The name of the environment to delete.

FLAGS
  -e, --enterprise=<value>  Code name of the enterprise from which to delete the environment.
  -h, --help                Show CLI help.
  -v, --verbose             Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>              Fires this command with an argument list that was previously remembered using the
                            --rememberAs flag.
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --remember                Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>      Saves the given argument list so that it can be called by name.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --take-defaults           Accepts default values without prompting for confirmation. (Irrelevant in --silent mode).
  --to-script               Renders the equivalent non-interactive command without executing it.
  --unremember=<value>      Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                            were previously stored under the given name (use "--unRemember default" to clear default
                            argument list memorized with the --remember flag).
  --withoutdefaults         Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Deletes an existing environment from a given enterprise. Returns an error if the environment does not exist.

ALIASES
  $ codiac enviro delete
  $ codiac infrx environment delete
  $ codiac infrx enviro delete

EXAMPLES
  Delete an environment interactively.

    $ codiac infrx environment delete

  Delete a named environment interactively.

    $ codiac infrx environment delete dev

  Delete an environment non-interactively.

    $ codiac infrx environment delete dev --enterprise main --silent

  Renders the equivalent silent command and then executes.

    $ codiac infrx environment delete dev --enterprise main --echo

  Renders the equivalent silent command without executing.

    $ codiac infrx environment delete dev --enterprise main --to-script

codiac infrx environment list​

Shows the list of environments.

USAGE
  $ codiac infrx environment list [-h] [-e <value>] [-o json|yaml|tree|text] [-q <value>] [--silent | --echo |
  --to-script]

FLAGS
  -e, --enterprise=<value>  The name of the enterprise to which the environments belong (defaults to the current
                            enterprise context).
  -h, --help                Show CLI help.
  -o, --output=<option>     Format in which to render the results (defaults to tree).
                            <options: json|yaml|tree|text>
  -q, --query=<value>       JMESPath expression to filter or reshape the results (see jmespath.org).
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Shows the list of environments.

ALIASES
  $ codiac enviro list
  $ codiac infrx environment list
  $ codiac infrx enviro list

EXAMPLES
  List all environments for the current enterprise.

    $ codiac infrx environment list

  List environments for a specific enterprise.

    $ codiac infrx environment list -e myEnterprise

  List environment names only.

    $ codiac infrx environment list -q '[].name'

  Export as YAML.

    $ codiac infrx environment list -o yaml

  Non-interactive (scripted) invocation.

    $ codiac infrx environment list -e myEnterprise --silent

codiac init DIRECTORY​

Declares the given folder as a project root

USAGE
  $ codiac init DIRECTORY [-h] [-c <value>] [-t <value>]

ARGUMENTS
  DIRECTORY  Path to the desired project root, relative to current directory.

FLAGS
  -c, --clone=<value>        (Optional) The git repo from which to hydrate the project folder.
  -h, --help                 Show CLI help.
  -t, --projectType=<value>  (Optional) The type of Codiac project to scaffold.

DESCRIPTION
  Declares the given folder as a project root

See code: dist/commands/init.ts

codiac kit create​

Creates a new kit from an existing asset.

USAGE
  $ codiac kit create [-h] [-a <value>] [-e <value>] [-n <value>] [-s <value>] [--silent | --echo | --to-script]

FLAGS
  -a, --asset=<value>       The enterprise asset from which to create the kit.
  -e, --enterprise=<value>  The name of the enterprise containing the given asset (defaults to the current enterprise
                            context).
  -h, --help                Show CLI help.
  -n, --name=<value>        Override for the name to give the new kit (optional; defaults to the asset name).
  -s, --scope=<value>       The globally unique directory name in which to register the kit, prefixed to the kit name
                            for global uniqueness (optional; defaults to the public shared library).
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Creates a new kit from an existing asset.

EXAMPLES
  Create a kit interactively.

    $ codiac kit create

  Create a kit from a specific asset.

    $ codiac kit create -e myEnterprise -a myApi

  Non-interactive (scripted) invocation.

    $ codiac kit create -e myEnterprise -a myApi --silent

  Renders the equivalent silent command without executing.

    $ codiac kit create -e myEnterprise -a myApi --to-script

See code: dist/commands/kit/create.ts

codiac login​

Codiac system login to authenticate user under a tenant.

USAGE
  $ codiac login [-h] [-i | -p <value>] [-t <value>] [-o -u <value>] [-y ]

FLAGS
  -h, --help                Show CLI help.
  -i, --passwordIn          Reads the password directly from the standard input stream.  Enables users to avoid
                            explicitly rendering it in a command string. eg:  `cat mypass.txt | cod login -u joecool
                            --passwordIn`.  Invokes `--silent` mode, so interaction will be disabled.
  -o, --tokenOut            Writes the token as the sole stdout content (so that it is available to be piped or
                            redirected elsewhere, eg `cod login > mycodiactoken.txt`).  Leaves stdout empty on errors.
                            Invokes `--silent` mode, so interaction will be disabled.
  -p, --password=<value>    password on Codiac
  -t, --tenantCode=<value>  Human-readable Identifier for the Codiac tenant to log in under (optional: defaults to the
                            tenant code for the current project or prompts you to select one from your profile).
  -u, --username=<value>    Username on Codiac
  -y, --silent              (Optional: defaults to false) Prevents interactive user-interface and throws if interaction
                            is needed. Requires arguments: [--username -u, --passwordIn -i]

DESCRIPTION
  Codiac system login to authenticate user under a tenant.

ALIASES
  $ codiac user login

EXAMPLES
  Interactive login

    $ codiac login

  Scripted login (non-TTY, eg: in a pipeline) with password piped in from an env variable.

    echo $PW | codiac login -u joe.cool@yaml.dev --passwordIn

  Scripted login to specific tenant (non-TTY, eg: in a pipeline) with password piped in from an env variable.  Use
  this when the current user is a member of more than one codiac tenant.

    echo $PW | codiac login --tenantCode acme -u joe.cool@yaml.dev --passwordIn

  Scripted login to specific tenant (non-TTY, eg: in a pipeline) with password read from  an env variable.  Use this
  when the current user is a member of more than one codiac tenant.

    $ codiac login --tenantCode acme -u joe.cool@yaml.dev --password $PW

  Login and capture token (with password read from a file) (Non-TTY)

    cat mypassword.txt | codiac login -u joe.cool@fyaml.dev --passwordIn --tokenOut

  Login and capture token (with clear-text password read an env variable) (Non-TTY)

    $ codiac login -u joe.cool@fyaml.dev --password $PW --tokenOut

See code: dist/commands/login.ts

codiac logout​

Resets the current user to anonymous and clears any local user cache.

USAGE
  $ codiac logout [-h] [--silent | --echo | --to-script]

FLAGS
  -h, --help   Show CLI help.
  --echo       Renders the equivalent non-interactive command for future use before executing.
  --silent     Executes without any user interaction; fails on missing or invalid arguments.
  --to-script  Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Resets the current user to anonymous and clears any local user cache.

EXAMPLES
  Log out the current user.

    $ codiac logout

  Non-interactive invocation.

    $ codiac logout --silent

  Renders the equivalent silent command without executing.

    $ codiac logout --to-script

See code: dist/commands/logout.ts

codiac merge [BRANCH]​

Merges the given branch into the current branch of the main project and on any sourced dependencies.

USAGE
  $ codiac merge [BRANCH] [-h] [-c]

ARGUMENTS
  BRANCH  The branch name to merge into the current one.

FLAGS
  -c, --commit  Commits if merge succeeds.
  -h, --help    Show CLI help.

DESCRIPTION
  Merges the given branch into the current branch of the main project and on any sourced dependencies.

See code: dist/commands/merge.ts

codiac noc cluster capture​

Creates a new record in Codiac for a cluster that already physically exists in a cloud subscription. You will need credentials for the cloud service provider subscription you are drawing the cluster from. Use cod csp login to capture your credentials. Use cod cluster forget ---running to undo this operation.

USAGE
  $ codiac noc cluster capture [-h] [-t <value>] [-g <value>] [--echo | --to-script | [--silent -n <value> -p azure|aws
    -s <value> -l <value>]]

FLAGS
  -g, --azResourceGroup=<value>       (required for Azure) The Azure resource group in which to find the cluster.
  -h, --help                          Show CLI help.
  -l, --location=<value>              The short name of the regional data center in which the cliuster resides.
  -n, --name=<value>                  Name of the cluster to capture
  -p, --provider=<option>             Cloud service provider on which to find the cluster
                                      <options: azure|aws>
  -s, --providerSubscription=<value>  The cloud provider subscription Id under which to find the cluster (eg:
                                      SubscriptionId for azure, AccountId for aws).
  -t, --providerTenantId=<value>      (in silent mode, either this or providerSubscription is required if you have more
                                      than one tenant profile on a given cloud provider) The Id of the cloud provider
                                      tenant under which to authenticate.
  --echo                              Echo interaction mode; renders the equivalent non-interactive cli command for
                                      future use before final execution.
  --silent                            Non-Interactive mode; executes without any user interaction and fails on any
                                      missing or invalid arguments.
  --to-script                         Toscript interaction mode; renders the equivalent non-interactive cli command
                                      WITHOUT any execution.

DESCRIPTION
  Creates a new record in Codiac for a cluster that already physically exists in a cloud subscription.      You will
  need credentials for the cloud service provider subscription you are drawing the cluster from.      Use `cod csp
  login` to capture your credentials.      Use `cod cluster forget ---running` to undo this operation.

ALIASES
  $ codiac cluster capture

EXAMPLES
  Capture a cluster interatively.

    cod cluster capture

  Capture an Azure cluster silently.

    cod cluster capture -n my-cluster -p azure -s abcd123-xyzpdq-5678-pdq345 -l eastus -g our-dev-stuff

  Capture an AWS cluster silently.

    cod cluster capture -n my-cluster -p aws -s 123456789012 -l us-east-1

See code: dist/commands/noc/cluster/capture.ts

codiac noc cluster create [NAME]​

Provisions the physical cluster

USAGE
  $ codiac noc cluster create [NAME] [-h] [--provider azure|aws|localMachine] [-s <value>] [-g <value>] [-l <value>] [-q
    <value>] [--k8sVersion <value>] [-k <value>] [--networkPlugin kubenet|azure] [-n <value>] [-u <value>]
    [--identityUserId <value>] [--nodesMin <value>] [--nodesMax <value>] [--init] [--take-defaults | [--silent | --echo
    | --to-script]]

ARGUMENTS
  NAME  Proposed name of the cluster

FLAGS
  -g, --resourceGroup=<value>         (Required in silent mode) The Azure resource group to create for the cluster.
  -h, --help                          Show CLI help.
  -k, --subnet=<value>...             OPTIONAL: The resource id of the subnet in which the cluster is to be created.
  -l, --location=<value>              (Required in silent mode) The short name of the azure data center in which the
                                      cluster is to reside.
  -n, --nodeSpec=<value>              The identifier for the type of VM to use for nodes in the cluster.
  -q, --nodeQty=<value>               [default: 2] (Required in silent mode) The starting node count with which to
                                      create the cluster.
  -s, --providerSubscription=<value>  (Required in silent mode) The Azure subscription Id under which to create the
                                      cluster.
  -u, --identityUserName=<value>      OPTIONAL. Name of Svc Principal or Managed Identity to execute as.
  --echo                              Echo interaction mode; renders the equivalent non-interactive cli command for
                                      future use before final execution.
  --identityUserId=<value>            OPTIONAL. ID of Svc Principal or Managed Identity to execute as.
  --[no-]init                         Automatically initialize cluster after creation (use --no-init to skip).
  --k8sVersion=<value>                (Required in silent mode) The version of Kubernetes to install on the cluster.
  --networkPlugin=<option>            OPTIONAL: The network plugin for the cluster (kubenet, azure). Defaults to
                                      kubenet.
                                      <options: kubenet|azure>
  --nodesMax=<value>                  OPTIONAL. The maximum number of nodes to maintain in the cluster.
  --nodesMin=<value>                  OPTIONAL. The minimum number of nodes to maintain in the cluster.
  --provider=<option>                 (Required in silent mode) Cloud service provider on which to provision the cluster
                                      <options: azure|aws|localMachine>
  --silent                            Non-Interactive mode; executes without any user interaction and fails on any
                                      missing or invalid arguments.
  --take-defaults                     Setting this to true prevents prompting for confirmation on parameters that were
                                      passed in or were automatically set to default values (Irrelevant in --silent
                                      mode).
  --to-script                         Toscript interaction mode; renders the equivalent non-interactive cli command
                                      WITHOUT any execution.

DESCRIPTION
  Provisions the physical cluster

ALIASES
  $ codiac cluster provision
  $ codiac cluster create

EXAMPLES
  Create a cluster interatively.

    cod cluster create my-cluster

  Create a cluster interatively and assemble a non-interactive command string.

    cod cluster create my-cluster --echo

  Assemble a non-interactive command string WITHOUT actually creating a cluster (dry run).

    cod cluster create my-cluster --to-script

  Create a cluster silently.

    cod cluster create my-cluster --provider azure --providerSubscription 12345678-1234-1234-1234-123456789012 ^
      --resourceGroup my-rg --location eastus --nodeSpec Standard_DS2_v2 --nodeQty 2 --silent

  Create a cluster silently with all available options (NOTE: you can generate this command using --to-script)

    cod cluster create my-comprehensive-cluster --provider azure --providerSubscription ^
      12345678-1234-1234-1234-123456789012 --resourceGroup my-resource-group --location eastus2 --nodeSpec ^
      Standard_D2s_v3 --nodeQty 3 --k8sVersion 1.21.2 --networkPlugin azure --nodesMin 2 --nodesMax 5 --owner ^
      my-tenant-code --subnet /subscriptions/12345678-1234-1234-1234-123456789012/resourceGroups/my-vnet-rg/providers/ ^
      Microsoft.Network/virtualNetworks/my-vnet/subnets/my-subnet --identityUserName my-service-principal ^
      --identityUserId 87654321-4321-4321-4321-210987654321 --identityUserPassword mySecurePassword123! --silent

FLAG DESCRIPTIONS
  --[no-]init  Automatically initialize cluster after creation (use --no-init to skip).

    By default, the cluster creation command automatically runs `init-cluster`. Use this flag to skip the initialization
    step and leave the cluster in a non-initialized state. Not applicable when invoked as `cluster:provision` —
    initialization is always skipped in that mode.

See code: dist/commands/noc/cluster/create.ts

codiac noc cluster credentials-set [NAME]​

Registers connection credentials for a self-managed cluster (provider: other). Supply a kubeconfig file via --file or pipe it via stdin. When the file contains multiple contexts, specify which one to use with --context. If there is only one context, it is ingested automatically.

USAGE
  $ codiac noc cluster credentials-set [NAME] [-f <value>] [-x <value>] [--take-defaults | [--silent | --echo |
  --to-script]]

ARGUMENTS
  NAME  Name of the cluster to register credentials for.

FLAGS
  -f, --file=<value>     Path to a kubeconfig file. Mutually exclusive with stdin.
  -x, --context=<value>  Name of the context to extract from a multi-context kubeconfig. If omitted and exactly one
                         context references a cluster matching the cluster name argument, that context is selected
                         automatically. Required only when the match is ambiguous.
  --echo                 Renders the equivalent non-interactive command before executing.
  --silent               Non-interactive mode; executes without user interaction and fails on missing or invalid
                         arguments.
  --take-defaults        Prevents prompting for confirmation on parameters already provided.
  --to-script            Renders the equivalent non-interactive command without executing.

DESCRIPTION
  Registers connection credentials for a self-managed cluster (provider: other). Supply a kubeconfig file via --file or
  pipe it via stdin. When the file contains multiple contexts, specify which one to use with --context. If there is only
  one context, it is ingested automatically.

ALIASES
  $ codiac cluster credentials-set

EXAMPLES
  Register credentials from a file (single-context kubeconfig).

    $ codiac noc cluster credentials-set my-cluster --file ~/.kube/my-cluster.yaml

  Multi-context kubeconfig — auto-selected because one context references a cluster named my-cluster.

    $ codiac noc cluster credentials-set my-cluster --file ~/.kube/config

  Multi-context kubeconfig — explicit context when auto-selection is ambiguous.

    $ codiac noc cluster credentials-set my-cluster --file ~/.kube/config --context my-cluster-admin

  Pipe a kubeconfig in via stdin.

    cat ~/.kube/my-cluster.yaml | codiac noc cluster credentials-set my-cluster

  Non-interactive (scripted) invocation.

    $ codiac noc cluster credentials-set my-cluster --file ~/.kube/my-cluster.yaml --silent

See code: dist/commands/noc/cluster/credentials-set.ts

codiac noc cluster define [NAME]​

Creates or updates a cluster metadata record (ClusterDef) without provisioning any physical infrastructure. Use this to register a cluster definition before running cod noc cluster restore, or to update metadata on a cluster that has no live instance. If the cluster already has a running instance, destroy it first (cod cluster destroy <name>), then redefine.

USAGE
  $ codiac noc cluster define [NAME] [-h] [--provider azure|aws|localMachine|other] [-s <value>] [-g <value>] [-l
    <value>] [-n <value>] [-q <value>] [--k8sVersion <value>] [--nodesMin <value>] [--nodesMax <value>] [-k <value>]
    [--networkPlugin kubenet|azure] [-u <value>] [--identityUserId <value>] [--take-defaults | [--silent | --echo |
    --to-script]]

ARGUMENTS
  NAME  Name of the cluster to define or update.

FLAGS
  -g, --resourceGroup=<value>         (Azure only, required) The resource group associated with the cluster.
  -h, --help                          Show CLI help.
  -k, --subnet=<value>...             (Optional) Resource Id of the subnet in which the cluster was or will be created.
  -l, --location=<value>              The short name of the regional data center where the cluster resides.
  -n, --nodeSpec=<value>              The VM size used for cluster nodes.
  -q, --nodeQty=<value>               [default: 2] Starting node count recorded in the cluster definition.
  -s, --providerSubscription=<value>  The cloud provider subscription Id (Azure) or account Id (AWS) for the cluster.
  -u, --identityUserName=<value>      (Optional) Name of the Service Principal or Managed Identity the cluster executes
                                      as.
  --echo                              Renders the equivalent non-interactive command for future use before executing.
  --identityUserId=<value>            (Optional) Id of the Service Principal or Managed Identity the cluster executes
                                      as.
  --k8sVersion=<value>                The version of Kubernetes the cluster runs.
  --networkPlugin=<option>            (Optional) Network plugin for the cluster.
                                      <options: kubenet|azure>
  --nodesMax=<value>                  Maximum number of nodes for autoscaling.
  --nodesMin=<value>                  Minimum number of nodes for autoscaling.
  --provider=<option>                 Cloud service provider on which the cluster resides or will reside.
                                      <options: azure|aws|localMachine|other>
  --silent                            Executes without any user interaction; fails on missing or invalid arguments.
  --take-defaults                     Prevents prompting for confirmation on parameters that were passed in or
                                      automatically set to default values.
  --to-script                         Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Creates or updates a cluster metadata record (ClusterDef) without provisioning any physical infrastructure. Use this
  to register a cluster definition before running `cod noc cluster restore`, or to update metadata on a cluster that has
  no live instance. If the cluster already has a running instance, destroy it first (`cod cluster destroy <name>`), then
  redefine.

ALIASES
  $ codiac cluster define

EXAMPLES
  Define a cluster interactively.

    $ codiac noc cluster define

  Define an Azure cluster non-interactively.

    $ codiac noc cluster define my-cluster --provider azure --providerSubscription <sub-id> --resourceGroup my-rg ^
      --location eastus --nodeSpec Standard_D4s_v3 --nodeQty 3 --k8sVersion 1.29.0 --silent

  Renders the equivalent silent command and then executes.

    $ codiac noc cluster define my-cluster --echo

  Renders the equivalent silent command without executing.

    $ codiac noc cluster define my-cluster --to-script

See code: dist/commands/noc/cluster/define.ts

codiac noc cluster deinit​

Deinitialization of the cluster (uninstalls the ingress controller and tls cert manager services)

USAGE
  $ codiac noc cluster deinit [-h] [-n <value>] [-p artifactHub|aws|azure|dockerHub|localMachine|other] [--silent |
    --echo | --to-script]

FLAGS
  -h, --help               Show CLI help.
  -n, --name=<value>       Name of the cluster to deinitialize.
  -p, --provider=<option>  Code for the cloud service provider.
                           <options: artifactHub|aws|azure|dockerHub|localMachine|other>
  --echo                   Renders the equivalent non-interactive command for future use before executing.
  --silent                 Executes without any user interaction; fails on missing or invalid arguments.
  --to-script              Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Deinitialization of the cluster (uninstalls the ingress controller and tls cert manager services)

ALIASES
  $ codiac cluster deinit

EXAMPLES
  Deinitialize a cluster interactively.

    $ codiac noc cluster deinit

  Non-interactive invocation.

    $ codiac noc cluster deinit -n my-cluster --silent

  Renders the equivalent silent command without executing.

    $ codiac noc cluster deinit -n my-cluster --to-script

See code: dist/commands/noc/cluster/deinit.ts

codiac noc cluster destroy [NAME]​

Kills the physical cluster, but not the Codiac cluster definition record

USAGE
  $ codiac noc cluster destroy [NAME] [-h] [-p artifactHub|aws|azure|dockerHub|localMachine|other] [-i] [-a] [-l] [-s |
    -e | -t] [-d]

ARGUMENTS
  NAME  Name of cluster to destroy

FLAGS
  -a, --partials           OPTIONAL: Include clusters that were never fully created.
  -d, --take-defaults      Takes all defaults for prompts.
  -e, --echo               Prints the command that would be executed, but does not execute it.
  -h, --help               Show CLI help.
  -i, --deleteIdentity     OPTIONAL: Ensures that identity security account for the cluster shall also be deleted after
                           the cluster itself is destroyed.
  -l, --local              OPTIONAL: Include only clusters that reside locally on this machine.
  -p, --provider=<option>  REQUIRED: Code for the cloud service provider.
                           <options: artifactHub|aws|azure|dockerHub|localMachine|other>
  -s, --silent             Runs the command in silent mode. Requires --name and --provider flags.
  -t, --to-script          Prints the command that would be executed and exits.

DESCRIPTION
  Kills the physical cluster, but not the Codiac cluster definition record

ALIASES
  $ codiac cluster destroy

See code: dist/commands/noc/cluster/destroy.ts

codiac noc cluster forget​

Permanently removes the record of a cluster. This command does NOT affect any infrastructure; it simply removes the cluster from the Codiac consciousness. You must remove all cabinets and environments in a cluster before forgetting it.

USAGE
  $ codiac noc cluster forget [-r] [--forget-cabinets] [-y -n <value> -p
    artifactHub|aws|azure|dockerHub|localMachine|other]

FLAGS
  -n, --name=<value>       Name of the cluster.
  -p, --provider=<option>  Code for the cloud service provider.
                           <options: artifactHub|aws|azure|dockerHub|localMachine|other>
  -r, --running            Include clusters that still have a running instance.
  -y, --silent             (Optional: defaults to false) Prevents confirmations of user-values. Required: ["name",
                           "provider"]
  --forget-cabinets        Permanently delete cabinet records instead of just orphaning them (clearing the cluster
                           assignment).

DESCRIPTION
  Permanently removes the record of a cluster.  This command does NOT affect any infrastructure; it simply removes the
  cluster from the Codiac consciousness. You must remove all cabinets and environments in a cluster before forgetting
  it.

ALIASES
  $ codiac cluster forget

EXAMPLES
  Forget a cluster using interactive prompts:

    $ codiac noc cluster forget

  Forget an aws cluster:

    $ codiac noc cluster forget --provider aws --name my-cluster

  Forget an azure cluster:

    $ codiac noc cluster forget --provider azure --name my-other-cluster

  Forget an azure cluster in silent mode:

    $ codiac noc cluster forget --provider azure --name my-other-cluster --silent

  Forget a cluster that is not destroyed yet:

    $ codiac noc cluster forget --running

See code: dist/commands/noc/cluster/forget.ts

codiac noc cluster grant​

(AWS Only) Provides cluster access to the given user.

USAGE
  $ codiac noc cluster grant [-h] [-c <value>] [-u <value>] [--silent | --echo | --to-script]

FLAGS
  -c, --cluster=<value>  Name of the cluster to grant access on.
  -h, --help             Show CLI help.
  -u, --user=<value>     AWS username (as email) to add.
  --echo                 Renders the equivalent non-interactive command for future use before executing.
  --silent               Executes without any user interaction; fails on missing or invalid arguments.
  --to-script            Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  (AWS Only) Provides cluster access to the given user.

ALIASES
  $ codiac cluster grant

EXAMPLES
  Grant cluster access interactively.

    $ codiac noc cluster grant

  Non-interactive invocation.

    $ codiac noc cluster grant -c my-cluster -u user@example.com --silent

  Renders the equivalent silent command without executing.

    $ codiac noc cluster grant -c my-cluster -u user@example.com --to-script

See code: dist/commands/noc/cluster/grant.ts

codiac noc cluster init​

Post-create initialization for the cluster (installs the ingress controller service)

USAGE
  $ codiac noc cluster init [-h] [-n <value>] [-p artifactHub|aws|azure|dockerHub|localMachine|other] [--adjust]
    [--silent | --echo | --to-script]

FLAGS
  -h, --help               Show CLI help.
  -n, --name=<value>       Name of the cluster to initialize.
  -p, --provider=<option>  Code for the cloud service provider.
                           <options: artifactHub|aws|azure|dockerHub|localMachine|other>
  --adjust                 Invokes interactive user-interface to make changes to the initialization specs even when
                           specs already exist.
  --echo                   Renders the equivalent non-interactive command for future use before executing.
  --silent                 Executes without any user interaction; fails on missing or invalid arguments.
  --to-script              Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Post-create initialization for the cluster (installs the ingress controller service)

ALIASES
  $ codiac cluster init

EXAMPLES
  Initialize a cluster interactively.

    $ codiac noc cluster init

  Adjust ingress spec on an already-initialized cluster.

    $ codiac noc cluster init --adjust

  Non-interactive invocation.

    $ codiac noc cluster init -n my-cluster --silent

  Renders the equivalent silent command without executing.

    $ codiac noc cluster init -n my-cluster --to-script

See code: dist/commands/noc/cluster/init.ts

codiac noc cluster journal [CLUSTER]​

Shows the setup journal for the given cluster. The journal outlines the individual components that were created in the CSP subscription (Cloud Service Provider) comprising the cluster.

USAGE
  $ codiac noc cluster journal [CLUSTER] [-o json|yaml|pretty] [--take-defaults | [--silent | --echo | --to-script]]

ARGUMENTS
  CLUSTER  Name of the cluster in Codiac.  You can use `cod cluster list` to see the names of your codiac clusters.

FLAGS
  -o, --output=<option>  [default: pretty] format in which to render the data.
                         <options: json|yaml|pretty>
  --echo                 Echo interaction mode; renders the equivalent non-interactive cli command for future use before
                         final execution.
  --silent               Non-Interactive mode; executes without any user interaction and fails on any missing or invalid
                         arguments.
  --take-defaults        Setting this to true prevents prompting for confirmation on parameters that were passed in or
                         were automatically set to default values (Irrelevant in --silent mode).  This behavior does NOT
                         apply to scenarios that the command needs to override invalid user input; such cases will
                         always prompt for confirmation.  eg: when no argument was provided for file or type, and only
                         one exists, the system will render the autoselected file unless this flag is set.
  --to-script            Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                         execution.

DESCRIPTION
  Shows the setup journal for the given cluster.  The journal outlines the individual components that were created in
  the CSP subscription (Cloud Service Provider) comprising the cluster.

ALIASES
  $ codiac cluster journal

EXAMPLES
  $ codiac noc cluster journal

  $ codiac noc cluster journal --echo

  $ codiac noc cluster journal dev-west-aws-02

  $ codiac noc cluster journal -o yaml dev-west-aws-02

  $ codiac noc cluster journal -o yaml --silent dev-west-aws-02

  $ codiac noc cluster journal -o yaml --silent dev-west-aws-02 > myfiles/journal.yaml

See code: dist/commands/noc/cluster/journal.ts

codiac noc cluster list​

Shows the list of clusters.

USAGE
  $ codiac noc cluster list [-h] [-e <value>] [-o text|tree|json|yaml|tsv|csv] [-q <value>] [--silent | --echo |
    --to-script]

FLAGS
  -e, --enterpriseCode=<value>  Code name of the enterprise to target.
  -h, --help                    Show CLI help.
  -o, --output=<option>         Format in which to render the results.
                                <options: text|tree|json|yaml|tsv|csv>
  -q, --query=<value>           JMESPath expression to filter or reshape the results (see jmespath.org).
  --echo                        Renders the equivalent non-interactive command for future use before executing.
  --silent                      Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                   Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Shows the list of clusters.

ALIASES
  $ codiac cluster list

EXAMPLES
  Simple listing.

    $ codiac noc cluster list

  List of cluster names only.

    $ codiac noc cluster list -q '[].name'

  Multi-property projection.

    $ codiac noc cluster list -q '[].{ name: name, loc: locationName }'

  Filter by name.

    $ codiac noc cluster list -q "[?name == 'my-cluster-on-aws']"

  Show name and location, sorted by location.

    $ codiac noc cluster list -q "[].{ name: name, loc: locationName } | sort_by(@, &loc)"

  Export as YAML.

    $ codiac noc cluster list -o yaml

  Non-interactive invocation.

    $ codiac noc cluster list -e myEnterprise --silent

  Renders the equivalent silent command without executing.

    $ codiac noc cluster list -e myEnterprise --to-script

See code: dist/commands/noc/cluster/list.ts

codiac noc cluster recreate [NAME]​

Provisions the physical cluster using the existing ClusterDef record (with any changes provided by the caller).

USAGE
  $ codiac noc cluster recreate [NAME] [-h] [-p <value>] [-s <value>] [-g <value>] [-l <value>] [-k <value>] [-v <value>]
    [-w -n <value> -q <value>] [--identityName <value>] [--silent | --echo | --to-script]

ARGUMENTS
  NAME  Name of an existing cluster to re-create.

FLAGS
  -g, --resourceGroup=<value>         The Azure resource group to create for the cluster.
  -h, --help                          Show CLI help.
  -k, --subnet=<value>                The resource id of the subnet in which the cluster is to be created.
  -l, --location=<value>              The short name of the azure data center in which the cluster is to reside.
  -n, --nodeSpec=<value>              The identifier for the type of VM to use for nodes in the cluster.
  -p, --owner=<value>                 Tenant code of the private owner of the cluster.
  -q, --nodeQty=<value>               The starting node count with which to create the cluster.
  -s, --providerSubscription=<value>  The Azure subscription Id under which to create the cluster.
  -v, --k8sVersion=<value>            The Kubernetes version for the new cluster. This must be a supported version from
                                      the cloud provider.
  -w, --windowsSupport                Add a windows nodepool.
  --echo                              Renders the equivalent non-interactive command for future use before executing.
  --identityName=<value>              Name of an existing service principal to use for the cluster identity.
  --silent                            Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                         Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Provisions the physical cluster using the existing ClusterDef record (with any changes provided by the caller).

ALIASES
  $ codiac cluster recreate

EXAMPLES
  Re-create a cluster interactively.

    $ codiac noc cluster recreate

  Re-create a specific cluster.

    $ codiac noc cluster recreate my-cluster --silent

  Renders the equivalent silent command without executing.

    $ codiac noc cluster recreate my-cluster --to-script

See code: dist/commands/noc/cluster/recreate.ts

codiac noc cluster restore [NAME]​

Restores a cluster to fully operational state from its existing ClusterDef: provisions cloud infrastructure, installs the Codiac agent, installs infrx stacks, and restores all SDLC cabinets. Pass --no-provision to re-run bootstrap only on an already-provisioned cluster.

USAGE
  $ codiac noc cluster restore [NAME] [--no-provision] [--no-agent] [--no-infrx] [--no-cabinets] [-e <value>] [--silent |
    --echo | --to-script]

ARGUMENTS
  NAME  Name of the cluster to restore.

FLAGS
  -e, --enterprise=<value>  Scope cabinet restore to a specific enterprise. When omitted, all enterprises are restored.
  --echo                    Echo interaction mode; renders the equivalent non-interactive command before executing.
  --no-agent                Skip Codiac agent installation. Also skips infrx and cabinet restore.
  --no-cabinets             Skip SDLC cabinet restore. Provision, agent, and infrx still run.
  --no-infrx                Skip infrx stack installation. Also skips cabinet restore.
  --no-provision            Skip cloud infrastructure provisioning. The cluster must already have a live instance. Use
                            this to re-run bootstrap on an existing cluster.
  --silent                  Non-interactive mode; executes without any user interaction and fails on any missing or
                            invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing.

DESCRIPTION
  Restores a cluster to fully operational state from its existing ClusterDef: provisions cloud infrastructure, installs
  the Codiac agent, installs infrx stacks, and restores all SDLC cabinets. Pass --no-provision to re-run bootstrap only
  on an already-provisioned cluster.

ALIASES
  $ codiac cluster restore

EXAMPLES
  Full restore interactively.

    $ codiac noc cluster restore

  Full restore of a specific cluster.

    $ codiac noc cluster restore prod-cluster-1 --silent

  Re-run bootstrap only (cluster already provisioned).

    $ codiac noc cluster restore prod-cluster-1 --no-provision --silent

  Provision and agent only (skip infrx and cabinets).

    $ codiac noc cluster restore prod-cluster-1 --no-infrx --no-cabinets --silent

  Restore scoped to one enterprise.

    $ codiac noc cluster restore prod-cluster-1 --enterprise acme --silent

  Render the equivalent silent command without executing.

    $ codiac noc cluster restore prod-cluster-1 --to-script

See code: dist/commands/noc/cluster/restore.ts

codiac pkg add [DEFINITIONFILE]​

Configures a package to be built and published by the project.

USAGE
  $ codiac pkg add [DEFINITIONFILE] [-h] [-r <value>] [-e <value>] [-u <value>] [-s <value>]

ARGUMENTS
  DEFINITIONFILE  Path and filename of the package definition file, relative to the codiac project root, (eg:
                  "./package.json")

FLAGS
  -e, --environment=<value>  (optional) Declaration that this registry shall be the target when publishing to the given
                             environment.
  -h, --help                 Show CLI help.
  -r, --registryUrl=<value>  Address of the registry to which the package will be published (without protocol prefix),
                             eg: "yourpackages.azurecr.io".  NOTE: This registry will be used by the "codiac publish"
                             command, whereas when running in "local" mode, packages will instead be registered to the
                             built-in package registry on the local machine.  NOTE:  This url shall define the default
                             publishing target, for use when publishing for any environment, unless otherwise specified.
  -s, --password=<value>     (optional) Password credential for the given registry.  WARNING!! these username/password
                             credentials will be stored in the codiac config file in this project, and therefore
                             configuring username and password in this manner is not recommended!
  -u, --username=<value>     (optional) Login credential for the given registry.  WARNING!! these username/password
                             credentials will be stored in the codiac config file in this project, and therefore
                             configuring username and password in this manner is not recommended!

DESCRIPTION
  Configures a package to be built and published by the project.

See code: dist/commands/pkg/add.ts

codiac pkg delete [PACKAGENAME]​

Deletes the given package export from the configuration.

USAGE
  $ codiac pkg delete [PACKAGENAME] [-h]

ARGUMENTS
  PACKAGENAME  package name including, scope prefix. eg:  "your-company/your-package"

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Deletes the given package export from the configuration.

ALIASES
  $ codiac pkg delete

codiac pkg list​

Renders the list of packages that are configured as project exports.

USAGE
  $ codiac pkg list [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Renders the list of packages that are configured as project exports.

See code: dist/commands/pkg/list.ts

codiac pkg patch PACKAGENAME​

Applies the given values to an existing package export configuration. Both registryUrl and environment act as filters to limit the operation. That is, an upsert of registry targets is performed for the given package, based on the given registryUrl and/or environment.

USAGE
  $ codiac pkg patch PACKAGENAME [-h] [-s <value>] [-u <value>]

ARGUMENTS
  PACKAGENAME  package name including, scope prefix. eg:  "your-company/your-package"

FLAGS
  -h, --help           Show CLI help.
  -s, --set=<value>    Space-delimited list of key-value pairs tp apply with json-path on the left and the desired value
                       on the right.  (eg:  --set .targets.default.registryUrl=mystuff.azurecr.io)
  -u, --unset=<value>  Space-delimited list of properties to clear, in json-path format.  (eg:  --unset
                       .targets.default)

DESCRIPTION
  Applies the given values to an existing package export configuration.  Both registryUrl and environment act as filters
  to limit the operation.  That is, an upsert of registry targets is performed for the given package, based on the given
  registryUrl and/or environment.

See code: dist/commands/pkg/patch.ts

codiac pkg remove [PACKAGENAME]​

Deletes the given package export from the configuration.

USAGE
  $ codiac pkg remove [PACKAGENAME] [-h]

ARGUMENTS
  PACKAGENAME  package name including, scope prefix. eg:  "your-company/your-package"

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Deletes the given package export from the configuration.

ALIASES
  $ codiac pkg delete

See code: dist/commands/pkg/remove.ts

codiac portal​

Starts the codiac relay services, maintains container instance, and opens the web app.

USAGE
  $ codiac portal [-h] [--silent | --echo | --to-script]

FLAGS
  -h, --help   Show CLI help.
  --echo       Renders the equivalent non-interactive command for future use before executing.
  --silent     Executes without any user interaction; fails on missing or invalid arguments.
  --to-script  Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Starts the codiac relay services, maintains container instance, and opens the web app.

EXAMPLES
  Open the Codiac portal.

    $ codiac portal

  Non-interactive invocation.

    $ codiac portal --silent

  Renders the equivalent silent command without executing.

    $ codiac portal --to-script

See code: dist/commands/portal.ts

codiac probe create [CMD]​

Declares the implementation of a health or readiness probe for an asset.

USAGE
  $ codiac probe create [CMD] -u readiness|liveness|startup [-h] [-n <value>] [-a <value>] [-v <value>] [-d
    <value>] [-p <value>] [-t <value>] [--success-threshold <value>] [--failure-threshold <value>] [--predefined <value>
    | --exec | --grpc | --http | --socket] [-x <value>] [--grpcHost <value> ] [--grpcPort <value> ] [--httpScheme
    http|https ] [--httpHost <value> ] [--httpPort <value> ] [--httpPath <value> ] [-r <value> ] [--socketHost <value> ]
    [--socketPort <value> ] [--silent | --echo | --to-script]

ARGUMENTS
  CMD  (requires --exec) command and its space-separated arguments to run in the target replica.

FLAGS
  -a, --asset=<value>          The name of the asset to which this probe is to apply.
  -d, --delay=<value>          The time (in seconds) to wait before the first execution of the probe.
  -h, --help                   Show CLI help.
  -n, --enterprise=<value>     The name of the enterprise to which this probe is to apply.
  -p, --period=<value>         [default: 10] How often (in seconds) to fire the probe.
  -r, --httpHeader=<value>...  (For use only with http) Key value pair (in format x=y) to be used as an http header in
                               an http probe action.
  -t, --timeout=<value>        How long to wait (in seconds) for a probe to respond before declaring it a failed
                               execution (default and min 1 second).
  -u, --usage=<option>         (required) [default: readiness] The diagnostic purpose the probe will serve.
                               <options: readiness|liveness|startup>
  -v, --versions=<value>       Asset version range for which this probe is to be used. (optional: defaults to >=latest)
  -x, --action=<value>         The JSON specification for the probe action itself.  The structure follows the
                               actionType.
  --echo                       Renders the equivalent non-interactive command for future use before executing.
  --exec                       Declares the probe shall be carried out as an executable CLI command. A return code of
                               zero indicates success.  Any nonzero result indicates failure.
  --failure-threshold=<value>  The number of unsuccessful probe executions to allow before determining the pod
                               unhealthy.
  --grpc                       Declares the probe shall be carried out as a grpc api request.
  --grpcHost=<value>           (For use only with grpc).
  --grpcPort=<value>           (For use only with grpc).
  --http                       Declares the probe shall be carried out as an http request. Any code greater than or
                               equal to 200 and less than 400 indicates success. Any other code indicates failure.
  --httpHost=<value>           (For use only with http) The host name or IP to probe.
  --httpPath=<value>           (For use only with http) The URL path to probe.
  --httpPort=<value>           (For use only with http) The port to probe.
  --httpScheme=<option>        (For use only with http) The http protocol to use.
                               <options: http|https>
  --predefined=<value>         Calls out by name for an existing standard or shared probe action.  Use this argument
                               instead of defining the probe action with the exec, grpc, http or socket arguments.
  --silent                     Executes without any user interaction; fails on missing or invalid arguments.
  --socket                     Declares the probe shall be carried out as a TCP Socket request.
  --socketHost=<value>         (For use only with socket) The host to connect to.
  --socketPort=<value>         (For use only with socket) The port to connect to.
  --success-threshold=<value>  Minimum consecutive successes for the probe to be considered successful after having
                               failed. Defaults to 1. Must be 1 for liveness and startup Probes. Minimum value is 1.
  --to-script                  Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Declares the implementation of a health or readiness probe for an asset.

ALIASES
  $ codiac probe create

EXAMPLES
  Create a probe interactively.

    $ codiac probe create

  Exec probe using a predefined action.

    $ codiac probe create --predefined builtin-heartbeat-file-exists

  Exec probe with inline command.

    $ codiac probe create -p 15 --exec -- "cat /app/data/last-heartbeat.json"

  Http probe with headers.

    $ codiac probe create -n acme -a myapi -u readiness -p 15 --http --httpScheme https --httpHost myapi.acme.com ^
      --httpPort 443 --httpPath /diag/heartbeat -r Accept=application/json -r user-agent=MyUserAgent

  Non-interactive invocation.

    $ codiac probe create -n acme -a myapi --predefined builtin-heartbeat-file-exists --silent

  Renders the equivalent silent command without executing.

    $ codiac probe create -n acme -a myapi --predefined builtin-heartbeat-file-exists --to-script

codiac publish [NAME]​

Publishes the exports (packages and images) declared in the ProjectConfig.

USAGE
  $ codiac publish [NAME] [-h] [-r] [-l] [-y -i <value> -u <value> -p <value>] [-o] [-i]

ARGUMENTS
  NAME  The official unique name of a currently sourced dependency.  Applies the command to ONLY this sourced
        dependency.

FLAGS
  -h, --help              Show CLI help.
  -i, --image=<value>...  (optional, defaults to all) Limits the list of images to publish.  Value must match the name
                          property of an image export defined in the codiac project file (codiac.json)
  -i, --includeDeps       Also performs the operation on any currently source dependencies.
  -l, --local             Publishes to the local built-in image registry.  NOTE: this setting gets remembered and is
                          used for subsequent calls unless otherwise specified.
  -o, --only              Applies the command only the sourced dependencies selected from a prompt. Quits if no
                          dependencies are currently sourced.
  -p, --password=<value>  (optional, prompts as needed) Password or token at the target registry.
  -r, --remote            Publishes to the remote image registry.  NOTE: this setting gets remembered and is used for
                          subsequent calls unless otherwise specified.
  -u, --username=<value>  (optional, prompts as needed) Username at the target registry.
  -y, --silent            Suppresses user dialogue.

DESCRIPTION
  Publishes the exports (packages and images) declared in the ProjectConfig.

See code: dist/commands/publish.ts

codiac pull [NAME]​

Pulls all commits from upstream to local.

USAGE
  $ codiac pull [NAME] [-h] [-o] [-i]

ARGUMENTS
  NAME  The official unique name of a currently sourced dependency.  Applies the command to ONLY this sourced
        dependency.

FLAGS
  -h, --help         Show CLI help.
  -i, --includeDeps  Also performs the operation on any currently source dependencies.
  -o, --only         Applies the command only the sourced dependencies selected from a prompt. Quits if no dependencies
                     are currently sourced.

DESCRIPTION
  Pulls all commits from upstream to local.

See code: dist/commands/pull.ts

codiac pullsecret​

Upserts the primary and secondary pull secret references for the given container registry.

USAGE
  $ codiac pullsecret [-h] [-r <value> | ] [-f primary|secondary] [--scope everywhere|unmatchingSubx] [-t
    awsKeyVault|azBlob|azKeyVault|etcd|mongoCollection|mongoDocument] [-s <value>] [-n <value>] [--silent | --echo |
    --to-script]

FLAGS
  -f, --item=<option>       [default: primary] Applies the command to either the primary (default) or secondary secret
                            for the image registry.
                            <options: primary|secondary>
  -h, --help                Show CLI help.
  -n, --name=<value>        The name of the secret within the secret store.
  -r, --registry=<value>    The container registry in which the image exists (defaults to docker hub).
  -s, --storeName=<value>   The name of the secret store containing the actual pull secrets.
  -t, --storeType=<option>  The type of secret store containing the actual pull secrets.
                            <options: awsKeyVault|azBlob|azKeyVault|etcd|mongoCollection|mongoDocument>
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --scope=<option>          Applicability of the pullsecret. Allows for other authorization methods when the cluster and
                            image registry are in the same subscription.
                            <options: everywhere|unmatchingSubx>
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Upserts the primary and secondary pull secret references for the given container registry.

ALIASES
  $ codiac pullsecret

codiac pullsecret unset​

Removes the primary or secondary pull secret reference for the given container registry.

USAGE
  $ codiac pullsecret unset [-h] [-r <value> | ] [-f primary|secondary] [--silent | --echo | --to-script]

FLAGS
  -f, --item=<option>     [default: primary] Applies the command to either the primary (default) or secondary secret for
                          the image registry.
                          <options: primary|secondary>
  -h, --help              Show CLI help.
  -r, --registry=<value>  The container registry in which the image exists (defaults to docker hub).
  --echo                  Renders the equivalent non-interactive command for future use before executing.
  --silent                Executes without any user interaction; fails on missing or invalid arguments.
  --to-script             Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Removes the primary or secondary pull secret reference for the given container registry.

ALIASES
  $ codiac pullsecret unset

codiac push [NAME]​

Pushes all local commits upstream.

USAGE
  $ codiac push [NAME] [-h] [-o] [-i]

ARGUMENTS
  NAME  The official unique name of a currently sourced dependency.  Applies the command to ONLY this sourced
        dependency.

FLAGS
  -h, --help         Show CLI help.
  -i, --includeDeps  Also performs the operation on any currently source dependencies.
  -o, --only         Applies the command only the sourced dependencies selected from a prompt. Quits if no dependencies
                     are currently sourced.

DESCRIPTION
  Pushes all local commits upstream.

See code: dist/commands/push.ts

codiac relay-version​

Outputs the version of the relay container used by this version of the cli.

USAGE
  $ codiac relay-version

DESCRIPTION
  Outputs the version of the relay container used by this version of the cli.

EXAMPLES
  $ codiac relay-version

See code: dist/commands/relay-version.ts

codiac run​

Runs the latest build of the api container locally.

USAGE
  $ codiac run [-b] [-d] [-e <value>] [-h] [-i] [-n <value>] [-m <value>] [-p <value>] [-l <value>] [-w]
    [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>] [--withoutdefaults] [-v]

FLAGS
  -b, --build                 Triggers a new local build beforehand.
  -d, --detach                Run container in background and print the container ID.
  -e, --entrypoint=<value>    Overrides the default container startup command.
  -h, --help                  Renders the help document for this command.
  -i, --interactive           Run the container interactively (in the console; dies with the console).  Use
                              -e|--entrypoint to override the startup command for the container.
  -l, --internalPort=<value>  (default: 5775) The port the application inside the container is listening on.  Sets the
                              port to which map incoming requests on the container.  This port mapping MUST match
                              whatever port number the actual application is listening on.
  -m, --mountFolder=<value>   Mounts a folder on the host as a read-write volume on the container. In format
                              "src=~/my/local/folder,dst=/root/in/container".
  -n, --network=<value>       The docker network to which the container will be attached (defaults to a network named as
                              the company code, which will be created on demand as a bridge network).
  -p, --port=<value>          (default: 5775) Sets the external port to open on the container.  That is, the port on
                              which the api will be listening to calls from outside the container.
  -v, --verbose               Renders additional logging levels (detail, trace, and debug) to the console output.
  -w, --watch                 Forces a detach run and follows log output from the container.
  --as=<value>                Fires this command with an argument list that was previously remembered using the
                              --rememberAs flag.
  --remember                  Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>        Saves the given argument list so that it can be called by name.
  --unremember=<value>        Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                              were previously stored under the given name (use "--unRemember default" to clear default
                              argument list memorized with the --remember flag).
  --withoutdefaults           Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Runs the latest build of the api container locally.

See code: dist/commands/run.ts

codiac secretStore​

Upserts a reference to an existing secretStore.

USAGE
  $ codiac secretStore [-h] [-u <value>] [-p artifactHub|aws|azure|dockerHub|localMachine|other] [-n <value>] [-s
    <value>] [-l <value>] [--silent | --echo | --to-script]

FLAGS
  -h, --help                    Show CLI help.
  -l, --location=<value>        The region or data center in which the secret store resides (use the code name, eg: in
                                Aws use 'us-east-1', NOT 'Virginia, US').
  -n, --name=<value>            The resource name of the secret store within the cloud provider subscription.
  -p, --provider=<option>       The cloud provider hosting the secret store.
                                <options: artifactHub|aws|azure|dockerHub|localMachine|other>
  -s, --subscriptionId=<value>  The id of the cloud provider account in which the secret store resides (in Aws, this is
                                the 'AccountId').
  -u, --url=<value>             The container registry url.
  --echo                        Renders the equivalent non-interactive command for future use before executing.
  --silent                      Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                   Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Upserts a reference to an existing secretStore.

ALIASES
  $ codiac secretStore

codiac secretStore capture​

Upserts a reference to an existing secretStore.

USAGE
  $ codiac secretStore capture [-h] [-u <value>] [-p artifactHub|aws|azure|dockerHub|localMachine|other] [-n <value>] [-s
    <value>] [-l <value>] [--silent | --echo | --to-script]

FLAGS
  -h, --help                    Show CLI help.
  -l, --location=<value>        The region or data center in which the secret store resides (use the code name, eg: in
                                Aws use 'us-east-1', NOT 'Virginia, US').
  -n, --name=<value>            The resource name of the secret store within the cloud provider subscription.
  -p, --provider=<option>       The cloud provider hosting the secret store.
                                <options: artifactHub|aws|azure|dockerHub|localMachine|other>
  -s, --subscriptionId=<value>  The id of the cloud provider account in which the secret store resides (in Aws, this is
                                the 'AccountId').
  -u, --url=<value>             The container registry url.
  --echo                        Renders the equivalent non-interactive command for future use before executing.
  --silent                      Executes without any user interaction; fails on missing or invalid arguments.
  --to-script                   Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Upserts a reference to an existing secretStore.

ALIASES
  $ codiac secretStore

See code: dist/commands/secretStore/capture.ts

codiac secretStore forget​

Removes the reference to the given secret store for the tenant. Does NOT delete the store itself.

USAGE
  $ codiac secretStore forget [-h] [-n <value>] [--silent | --echo | --to-script]

FLAGS
  -h, --help          Show CLI help.
  -n, --name=<value>  The name of the secret store to forget.
  --echo              Renders the equivalent non-interactive command for future use before executing.
  --silent            Executes without any user interaction; fails on missing or invalid arguments.
  --to-script         Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Removes the reference to the given secret store for the tenant.  Does NOT delete the store itself.

See code: dist/commands/secretStore/forget.ts

codiac secretStore list​

Retrieves the list of existing secret stores captured for a given enterprise.

USAGE
  $ codiac secretStore list [-e <value>] [-t aws-secrets|az-key-vault] [-o json|yaml|auto] [--take-defaults |
    [--silent | --echo | --to-script]]

FLAGS
  -e, --enterprise=<value>
      (optional if there is only one) The enterprise for which the secret stores have been captured.

  -o, --output=<option>
      [default: auto] format in which to render the data.
      <options: json|yaml|auto>

  -t, --type=<option>
      The cloud provider hosting the secret store.
      <options: aws-secrets|az-key-vault>

  --echo
      Echo interaction mode; renders the equivalent non-interactive cli command for future use before final execution.

  --silent
      Non-Interactive mode; executes without any user interaction and fails on any missing or invalid arguments.

  --take-defaults
      Setting this to true prevents prompting for confirmation on parameters that were passed in or were automatically set
      to default values (Irrelevant in --silent mode).  This behavior does NOT apply to scenarios that the command needs
      to override invalid user input; such cases will always prompt for confirmation.  eg: when no argument was provided
      for file or type, and only one exists, the system will render the autoselected file unless this flag is set.

  --to-script
      Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any execution.

DESCRIPTION
  Retrieves the list of existing secret stores captured for a given enterprise.

EXAMPLES
  $ codiac secretStore list

See code: dist/commands/secretStore/list.ts

codiac shell init​

Emits a shell snippet that establishes a stable session ID for this terminal instance. Add eval "$(cod shell init)" to your shell profile (~/.bashrc, ~/.zshrc, PowerShell $PROFILE, etc.) to enable per-console tenant/enterprise context isolation.

USAGE
  $ codiac shell init [-h] [-s bash|zsh|sh|fish|powershell]

FLAGS
  -h, --help            Show CLI help.
  -s, --shell=<option>  Shell to emit syntax for (bash, zsh, sh, fish, powershell). Auto-detected when omitted.
                        <options: bash|zsh|sh|fish|powershell>

DESCRIPTION
  Emits a shell snippet that establishes a stable session ID for this terminal instance. Add `eval "$(cod shell init)"`
  to your shell profile (~/.bashrc, ~/.zshrc, PowerShell $PROFILE, etc.) to enable per-console tenant/enterprise context
  isolation.

EXAMPLES
  Emit the init snippet for the current shell (auto-detected).

    $ codiac shell init

  Emit the init snippet for bash/zsh. Add to ~/.bashrc or ~/.zshrc.

    eval "$(codiac shell init --shell bash)"

  Emit the init snippet for fish. Add to ~/.config/fish/config.fish.

    $ codiac shell init --shell fish | source

  Emit the init snippet for PowerShell. Add to $PROFILE.

    Invoke-Expression (codiac shell init --shell powershell)

See code: dist/commands/shell/init.ts

codiac snapshot deploy​

Deploys all assets in a snapshot to a target cabinet.

USAGE
  $ codiac snapshot deploy [-h] [-e <value>] [-v <value>] [-c <value>] [--silent | --echo | --to-script]

FLAGS
  -c, --cabinet=<value>     The target cabinet name to deploy to.
  -e, --enterprise=<value>  The name of the enterprise containing the snapshot to deploy.
  -h, --help                Displays the help document for this command.
  -v, --version=<value>     The version of the snapshot to deploy (e.g., 5CJRH7XB).
  --echo                    Echo interaction mode; renders the equivalent non-interactive cli command for future use
                            before final execution.
  --silent                  Non-Interactive mode; executes without any user interaction and fails on any missing or
                            invalid arguments.
  --to-script               Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                            execution.

DESCRIPTION
  Deploys all assets in a snapshot to a target cabinet.

See code: dist/commands/snapshot/deploy.ts

codiac snapshot list​

Shows the list of snapshots (enterprise version configs) in a given enterprise.

USAGE
  $ codiac snapshot list [-h] [-e <value>] [-o json|yaml|tree|text] [-q <value>] [--silent | --echo | --to-script]

FLAGS
  -e, --enterprise=<value>  The name of the enterprise containing the snapshots (defaults to the current enterprise
                            context).
  -h, --help                Show CLI help.
  -o, --output=<option>     Format in which to render the results (defaults to tree).
                            <options: json|yaml|tree|text>
  -q, --query=<value>       JMESPath expression to filter or reshape the results (see jmespath.org).
  --echo                    Renders the equivalent non-interactive command for future use before executing.
  --silent                  Executes without any user interaction; fails on missing or invalid arguments.
  --to-script               Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Shows the list of snapshots (enterprise version configs) in a given enterprise.

ALIASES
  $ codiac cluster stack list

EXAMPLES
  List all snapshots for the current enterprise.

    $ codiac snapshot list

  List snapshots for a specific enterprise.

    $ codiac snapshot list -e myEnterprise

  List snapshot versions only.

    $ codiac snapshot list -q '[].version'

  Export as YAML.

    $ codiac snapshot list -o yaml

  Non-interactive (scripted) invocation.

    $ codiac snapshot list -e myEnterprise --silent

See code: dist/commands/snapshot/list.ts

codiac snapshot tags​

manage snapshot version tags

USAGE
  $ codiac snapshot tags [-c <value>] [-d <value>] [-v <value>] [-t <value>] [--addTags <value> -s] [--removeTags
    <value> ] [--toScript] [--to-script |  | ] [--pageSize <value>]

FLAGS
  -c, --filterCabinets=<value>...  Filter by cabinet
  -d, --filterDates=<value>...     Filter by exact date
  -s, --silent                     Run in silent mode without interactive prompts
  -t, --filterTags=<value>...      Filter by tag
  -v, --filterVersions=<value>...  Filter by version
  --addTags=<value>...             Tags to add
  --pageSize=<value>               [default: 10] Number of records per page
  --removeTags=<value>...          Tags to remove
  --to-script                      scripts interaction mode; renders the equivalent non-interactive cli command WITHOUT
                                   any execution.
  --toScript                       Generate script command without executing

DESCRIPTION
  manage snapshot version tags

EXAMPLES
  $ codiac snapshot tags

  $ codiac snapshot tags --silent --addTags prod --addTags stable --filterVersions 10036A9Z  --filterVersions 000000

  $ codiac snapshot tags --silent --removeTags deprecated --removeTags stable --filterCabinet west

  echo -n '{"filters":{"versions":["587JZ95N"]},"add":["tag1","tag2"]}' | codiac snapshot tags --silent --addTags tag3 --filterVersions 00000000

  $ codiac snapshot tags --to-script --filterVersions 10036A9Z

See code: dist/commands/snapshot/tags.ts

codiac stage [FILES]​

Flags files to be included in the next commit.

USAGE
  $ codiac stage [FILES] [-h] [-A] [-c <value>]

ARGUMENTS
  FILES  Space-separated list of files to stage. Paths are relative to the main project root.

FLAGS
  -A, --all             Include all modified files.
  -c, --commit=message  Commit the staged changes using the given message
  -h, --help            Show CLI help.

DESCRIPTION
  Flags files to be included in the next commit.

See code: dist/commands/stage.ts

codiac stash [FILE]​

describe the command here

USAGE
  $ codiac stash [FILE] [-h] [-n <value>] [-f]

ARGUMENTS
  FILE  path to the file to stash.

FLAGS
  -f, --force
  -h, --help          Show CLI help.
  -n, --name=<value>  name to print

DESCRIPTION
  describe the command here

See code: dist/commands/stash.ts

codiac status​

Shows the current uncommitted changes in the current branch.

USAGE
  $ codiac status [-h] [-s] [-u]

FLAGS
  -h, --help      Show CLI help.
  -s, --staged    Include the list of staged changes.
  -u, --unstaged  Include the list of unstaged changes.

DESCRIPTION
  Shows the current uncommitted changes in the current branch.

See code: dist/commands/status.ts

codiac stop​

Stops the running container for this project

USAGE
  $ codiac stop [-h] [-r]

FLAGS
  -h, --help    Show CLI help.
  -r, --remove  Deletes the container after stopping it

DESCRIPTION
  Stops the running container for this project

See code: dist/commands/stop.ts

codiac switch [NAME]​

Changes branch on the main project and any sourced dependencies.

USAGE
  $ codiac switch [NAME] [-h]

ARGUMENTS
  NAME  The name of the branch to switch to (Optional: will prompt the user when missing).

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Changes branch on the main project and any sourced dependencies.

See code: dist/commands/switch.ts

codiac sync [NAME]​

Merges the given branch into the current branch.

USAGE
  $ codiac sync [NAME] -b <value> [-h] [-o] [-i]

ARGUMENTS
  NAME  The official unique name of a currently sourced dependency.  Applies the command to ONLY this sourced
        dependency.

FLAGS
  -b, --with=<value>  (required) Branch to merge into this one
  -h, --help          Show CLI help.
  -i, --includeDeps   Also performs the operation on any currently source dependencies.
  -o, --only          Applies the command only the sourced dependencies selected from a prompt. Quits if no dependencies
                      are currently sourced.

DESCRIPTION
  Merges the given branch into the current branch.

See code: dist/commands/sync.ts

codiac tenant create [NAME]​

Registers a new tenant with the current user as the administrator.

USAGE
  $ codiac tenant create [NAME] [-h] [-n <value>] [-c <value>] [--silent | --echo | --to-script]

ARGUMENTS
  NAME  The name of the tenant to create.

FLAGS
  -c, --code=<value>  (Optional, not recommended) Proposed human-readable unique identifier code for the tenant
                      organization. This command will fail if the given tenant code is already taken.
  -h, --help          Show CLI help.
  -n, --name=<value>  Full name of the tenant organization.
  --echo              Renders the equivalent non-interactive command for future use before executing.
  --silent            Executes without any user interaction; fails on missing or invalid arguments.
  --to-script         Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Registers a new tenant with the current user as the administrator.

EXAMPLES
  Create a tenant interactively.

    $ codiac tenant create

  Create a tenant with a given name.

    $ codiac tenant create -n 'Acme Corp'

  Non-interactive invocation.

    $ codiac tenant create -n 'Acme Corp' -c acme --silent

  Renders the equivalent silent command without executing.

    $ codiac tenant create -n 'Acme Corp' -c acme --to-script

See code: dist/commands/tenant/create.ts

codiac tenant switch [CODE]​

Sets a different tenant context from the current user's list of tenants.

USAGE
  $ codiac tenant switch [CODE] [-h] [--silent | --echo | --to-script]

ARGUMENTS
  CODE  The unique string identifying the tenant to switch to.

FLAGS
  -h, --help   Show CLI help.
  --echo       Renders the equivalent non-interactive command for future use before executing.
  --silent     Executes without any user interaction; fails on missing or invalid arguments.
  --to-script  Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Sets a different tenant context from the current user's list of tenants.

EXAMPLES
  Switch tenant interactively.

    $ codiac tenant switch

  Switch to a specific tenant.

    $ codiac tenant switch my-tenant-code

  Non-interactive invocation.

    $ codiac tenant switch my-tenant-code --silent

  Renders the equivalent silent command without executing.

    $ codiac tenant switch my-tenant-code --to-script

See code: dist/commands/tenant/switch.ts

codiac token [TOKENNAME]​

Stores an identity token for the current user, for use with a component tool (such as npm). This command acts as an upsert.

USAGE
  $ codiac token [TOKENNAME] -t <value> [-h] [-p npm|azart|other] [-s <value>] [-r <value>] [-g <value> -e
    <value> -f <value>]

ARGUMENTS
  TOKENNAME  (optional) Conventional name (token_for_[provider]_[scope]) for the tokenized identity.  This name will
             also be used for the build environment variable carrying the token.

FLAGS
  -e, --email=<value>         (Azure Artifacts [aka: azart] only) The email address for this identity.  Npm requires for
                              this, but never uses it.
  -f, --feed=<value>          (Azure Artifacts [aka: azart] only) The human readable identifier for the package feed
  -g, --organization=<value>  (Azure Artifacts [aka: azart] only) Human readable identifier for the organization account
                              with the provider.
  -h, --help                  Renders the help document for this command.
  -p, --provider=<option>     [default: npm] The source of the token.
                              <options: npm|azart|other>
  -r, --registryUrl=<value>   The component tool that issued and can consume the token.
  -s, --scope=<value>         The subdivision within the registry for which this token is honored.
  -t, --token=<value>         (required) The actual raw token string itself issued by the provider

DESCRIPTION
  Stores an identity token for the current user, for use with a component tool (such as npm).  This command acts as an
  upsert.

ALIASES
  $ codiac identify
  $ codiac token

codiac token delete [NAME]​

Removes an identity token from storage for the current user.

USAGE
  $ codiac token delete [NAME] [-h]

ARGUMENTS
  NAME  The name of the token to delete.  Use the 'identity:list' command to view the currently stored tokens.

FLAGS
  -h, --help  Displays the help document for this command.

DESCRIPTION
  Removes an identity token from storage for the current user.

ALIASES
  $ codiac identity remove
  $ codiac token delete
  $ codiac token remove

codiac token list​

Lists out the identity tokens currently stored for the current user.

USAGE
  $ codiac token list [-h] [-o table|extended|json|csv]

FLAGS
  -h, --help             Displays the help document for this command.
  -o, --output=<option>  [default: table] Format for the response data.
                         <options: table|extended|json|csv>

DESCRIPTION
  Lists out the identity tokens currently stored for the current user.

ALIASES
  $ codiac token list

codiac token remove [NAME]​

Removes an identity token from storage for the current user.

USAGE
  $ codiac token remove [NAME] [-h]

ARGUMENTS
  NAME  The name of the token to delete.  Use the 'identity:list' command to view the currently stored tokens.

FLAGS
  -h, --help  Displays the help document for this command.

DESCRIPTION
  Removes an identity token from storage for the current user.

ALIASES
  $ codiac identity remove
  $ codiac token delete
  $ codiac token remove

codiac unstage [FILES]​

Flags files to be included in the next commit.

USAGE
  $ codiac unstage [FILES] [-h] [-A]

ARGUMENTS
  FILES  Space-separated list of files to stage. Paths are relative to the main project root.

FLAGS
  -A, --all   Include all modified files.
  -h, --help  Show CLI help.

DESCRIPTION
  Flags files to be included in the next commit.

See code: dist/commands/unstage.ts

codiac update [CHANNEL]​

update the codiac CLI

USAGE
  $ codiac 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 codiac CLI

EXAMPLES
  Update to the stable channel:

    $ codiac update stable

  Update to a specific version:

    $ codiac update --version 1.0.0

  Interactively select version:

    $ codiac update --interactive

  See available versions:

    $ codiac update --available

See code: @oclif/plugin-update

codiac user login​

Codiac system login to authenticate user under a tenant.

USAGE
  $ codiac user login [-h] [-i | -p <value>] [-t <value>] [-o -u <value>] [-y ]

FLAGS
  -h, --help                Show CLI help.
  -i, --passwordIn          Reads the password directly from the standard input stream.  Enables users to avoid
                            explicitly rendering it in a command string. eg:  `cat mypass.txt | cod login -u joecool
                            --passwordIn`.  Invokes `--silent` mode, so interaction will be disabled.
  -o, --tokenOut            Writes the token as the sole stdout content (so that it is available to be piped or
                            redirected elsewhere, eg `cod login > mycodiactoken.txt`).  Leaves stdout empty on errors.
                            Invokes `--silent` mode, so interaction will be disabled.
  -p, --password=<value>    password on Codiac
  -t, --tenantCode=<value>  Human-readable Identifier for the Codiac tenant to log in under (optional: defaults to the
                            tenant code for the current project or prompts you to select one from your profile).
  -u, --username=<value>    Username on Codiac
  -y, --silent              (Optional: defaults to false) Prevents interactive user-interface and throws if interaction
                            is needed. Requires arguments: [--username -u, --passwordIn -i]

DESCRIPTION
  Codiac system login to authenticate user under a tenant.

ALIASES
  $ codiac user login

EXAMPLES
  Interactive login

    $ codiac user login

  Scripted login (non-TTY, eg: in a pipeline) with password piped in from an env variable.

    echo $PW | codiac user login -u joe.cool@yaml.dev --passwordIn

  Scripted login to specific tenant (non-TTY, eg: in a pipeline) with password piped in from an env variable.  Use
  this when the current user is a member of more than one codiac tenant.

    echo $PW | codiac user login --tenantCode acme -u joe.cool@yaml.dev --passwordIn

  Scripted login to specific tenant (non-TTY, eg: in a pipeline) with password read from  an env variable.  Use this
  when the current user is a member of more than one codiac tenant.

    $ codiac user login --tenantCode acme -u joe.cool@yaml.dev --password $PW

  Login and capture token (with password read from a file) (Non-TTY)

    cat mypassword.txt | codiac user login -u joe.cool@fyaml.dev --passwordIn --tokenOut

  Login and capture token (with clear-text password read an env variable) (Non-TTY)

    $ codiac user login -u joe.cool@fyaml.dev --password $PW --tokenOut

codiac user show​

Renders the codiac username and its current tenant.

USAGE
  $ codiac user show [-h] [-o text|json] [--silent | --echo | --to-script]

FLAGS
  -h, --help             Show CLI help.
  -o, --output=<option>  [default: text] Format for the response data.
                         <options: text|json>
  --echo                 Renders the equivalent non-interactive command for future use before executing.
  --silent               Executes without any user interaction; fails on missing or invalid arguments.
  --to-script            Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Renders the codiac username and its current tenant.

ALIASES
  $ codiac user show

EXAMPLES
  Show current user.

    $ codiac user show

  Show current user as JSON.

    $ codiac user show -o json

  Non-interactive invocation.

    $ codiac user show --silent

  Renders the equivalent silent command without executing.

    $ codiac user show --to-script

codiac version​

USAGE
  $ codiac version [--json] [--verbose]

FLAGS
  --verbose  Show additional information about the CLI.

GLOBAL FLAGS
  --json  Format output as json.

FLAG DESCRIPTIONS
  --verbose  Show additional information about the CLI.

    Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.

See code: @oclif/plugin-version

codiac whereami​

Renders the current cabinet context the image project is pointed to. ie: Tenant, Enterprise, Environment, Cabinet.

USAGE
  $ codiac whereami [-h] [--silent | --echo | --to-script]

FLAGS
  -h, --help   Show CLI help.
  --echo       Renders the equivalent non-interactive command for future use before executing.
  --silent     Executes without any user interaction; fails on missing or invalid arguments.
  --to-script  Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Renders the current cabinet context the image project is pointed to.  ie:  Tenant, Enterprise, Environment, Cabinet.

EXAMPLES
  Show current project context.

    $ codiac whereami

  Non-interactive invocation.

    $ codiac whereami --silent

  Renders the equivalent silent command without executing.

    $ codiac whereami --to-script

See code: dist/commands/whereami.ts

codiac whoami​

Renders the codiac username and its current tenant.

USAGE
  $ codiac whoami [-h] [-o text|json] [--silent | --echo | --to-script]

FLAGS
  -h, --help             Show CLI help.
  -o, --output=<option>  [default: text] Format for the response data.
                         <options: text|json>
  --echo                 Renders the equivalent non-interactive command for future use before executing.
  --silent               Executes without any user interaction; fails on missing or invalid arguments.
  --to-script            Renders the equivalent non-interactive command without executing it.

DESCRIPTION
  Renders the codiac username and its current tenant.

ALIASES
  $ codiac user show

EXAMPLES
  Show current user.

    $ codiac whoami

  Show current user as JSON.

    $ codiac whoami -o json

  Non-interactive invocation.

    $ codiac whoami --silent

  Renders the equivalent silent command without executing.

    $ codiac whoami --to-script

See code: dist/commands/whoami.ts

codiac asset create​

Creates a new asset in the given enterprise from an image that exists in a container registry.

USAGE
  $ codiac asset create [-h] [-k <value> | -i <value> | -r <value>] [-g] [-o] [-t] [-y   -n <value> -c <value> -e
    <value> -p <value>]

FLAGS
  -c, --code=<value>        The host name to assign this asset in the domain url.  eg: 'myasset' in
                            'myasset.your-domain.com' (Optional: defaults to the asset name).
  -e, --enterprise=<value>  The name of the enterprise in which to create this asset. (defaults to the current
                            enterprise context)
  -g, --hasIngress          Declaration that the asset service is to be externally accessible (optional: defaults to
                            false).
  -h, --help                Show CLI help.
  -i, --image=<value>       The image name including scope prefix if applicable (eg: '@yourCompany/your-api-image').
  -k, --kit=<value>         The name of the kit (with library prefix, eg: 'library/kitName') to use to create the asset.
                            Use '?' to be prompted for a kit (Optional: used instead of calling for the image).
  -n, --name=<value>        The name to give the enterprise asset (Optional: defaults to the image name without the
                            scope prefix).
  -o, --routedWithoutName   Indicates that this asset will be the base ingress against your DNS. eg: true services
                            yourwebsite.com (as root/naked) (optional: defaults to false).
  -p, --port=<value>        The default port to assign the asset when deployed to a cabinet (optional).
  -r, --registry=<value>    The container registry in which the image exists (defaults to docker hub).
  -t, --toScript            Outputs an assembled command string, NO execution
  -y, --silent              (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
                            prior runs. Requires: image,registry,name,code,enterprise,port

DESCRIPTION
  Creates a new asset in the given enterprise from an image that exists in a container registry.

ALIASES
  $ codiac asset new

codiac asset destroy​

UN-deploys a given asset from a given cabinet. Defaults to removing only the pod deployments and leaving the service in place; set the --scorch argument to remove the service.

USAGE
  $ codiac asset destroy [-h] [-a <value>] [-v <value>] [-s] [-y]

FLAGS
  -a, --asset=<value>    Search string for the name of the asset to destroy (use ? to be prompted).
  -h, --help             Show CLI help.
  -s, --scorch           (Optional: defaults to false) Destroys the service too, instead of just the deployment and
                         pods.
  -v, --version=<value>  Search string for the version of the asset to destroy  (use ? to be prompted).
  -y, --silent           (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
                         prior runs.

DESCRIPTION
  UN-deploys a given asset from a given cabinet.  Defaults to removing only the pod deployments and leaving the service
  in place; set the --scorch argument to remove the service.

codiac asset get [CMD]​

Renders a selected type of content for an asset

USAGE
  $ codiac asset get [CMD] [-h] [-e <value>] [-a <value>] [-n <value>] [-c <value>] [-r <value>] [-t
    logs|term|exec|env|config|status] [--terminal bash|sh] [-f] [-l <value>] [-F <value>] [--takeDefaults | [--silent |
    --echo | --toscript]]

ARGUMENTS
  CMD  (requires type=exec) command and its space-separated arguments to run in the target replica.

FLAGS
  -F, --configFile=<value>   (requires type=config) The root pathname to the config file to fetch.
  -a, --asset=<value>        The name of the asset to view.
  -c, --cabinet=<value>      The name of the cabinet from which the content is to be drawn.
  -e, --enterprise=<value>   The name of the enterprise containing the asset being viewed.
  -f, --logsFollow           (requires type=logs) Follow (aka watch, tail, stream) the output.
  -h, --help                 Show CLI help.
  -l, --logsTail=<value>     [default: 10] (requires type=logs) Lines of recent logs to include in the output.  Enter -1
                             to include the entire log history stored in the container.
  -n, --environment=<value>  The name of the environment in which the cabinet resides.
  -r, --replica=<value>      The name of one of the asset instances currently running in the cabinet.
  -t, --type=<option>        The type of content to retrieve.
                             <options: logs|term|exec|env|config|status>
  --echo                     Echo interaction mode; renders the equivalent non-interactive cli command for future use
                             before final execution.
  --silent                   Non-Interactive mode; executes without any user interaction and fails on any missing or
                             invalid arguments.
  --takeDefaults             Prevents prompting for confirmation on parameters that were passed in or were set to
                             default values.
  --terminal=<option>        Command used to start the terminal (defaults to "bash")
                             <options: bash|sh>
  --toscript                 Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                             execution.

DESCRIPTION
  Renders a selected type of content for an asset

ALIASES
  $ codiac asset monitor
  $ codiac asset mon
  $ codiac asset get

codiac asset helm [SETTING]​

Creates a new asset in the given enterprise from an image that exists in a container registry.

USAGE
  $ codiac asset helm [SETTING] [-h] [-i <value>] [-y  -r <value> -n <value> -c <value> -e <value> -p <value> -g
    -o]

ARGUMENTS
  SETTING  The key for the config setting to add

FLAGS
  -c, --code=<value>        The host name to assign this asset in the domain url.  eg: 'myasset' in
                            'myasset.your-domain.com' (Optional: defaults to the asset name).
  -e, --enterprise=<value>  The name of the enterprise in which to create this asset. (defaults to the current
                            enterprise context)
  -g, --hasIngress          Declaration that the asset service is to be externally accessible (optional: defaults to
                            false).
  -h, --help                Show CLI help.
  -i, --chart=<value>       The chart name including scope prefix if applicable (eg: '@yourCompany/your-helm-chart').
  -n, --name=<value>        The name to give the enterprise asset (Optional: defaults to the image name without the
                            scope prefix).
  -o, --routedWithoutName   Indicates that this asset will be the base ingress against your DNS. eg: true services
                            yourwebsite.com (as root/naked) (optional: defaults to false).
  -p, --port=<value>        The default port to assign the asset when deployed to a cabinet (optional).
  -r, --registry=<value>    The chart registry in which the chart exists (defaults to docker hub).
  -y, --silent              (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
                            prior runs. Requires: image,registry,name,code,enterprise,port,hasIngress,routedWithoutName

DESCRIPTION
  Creates a new asset in the given enterprise from an image that exists in a container registry.

ALIASES
  $ codiac asset new

codiac asset list​

Shows the list of assets in a given enterprise.

USAGE
  $ codiac asset list [-o json|yaml|tree|text] [-h]

FLAGS
  -h, --help             Displays the help document for this command.
  -o, --output=<option>  [default: tree] format in which to render the data.
                         <options: json|yaml|tree|text>

DESCRIPTION
  Shows the list of assets in a given enterprise.

codiac asset mon [CMD]​

Renders a selected type of content for an asset

USAGE
  $ codiac asset mon [CMD] [-h] [-e <value>] [-a <value>] [-n <value>] [-c <value>] [-r <value>] [-t
    logs|term|exec|env|config|status] [--terminal bash|sh] [-f] [-l <value>] [-F <value>] [--takeDefaults | [--silent |
    --echo | --toscript]]

ARGUMENTS
  CMD  (requires type=exec) command and its space-separated arguments to run in the target replica.

FLAGS
  -F, --configFile=<value>   (requires type=config) The root pathname to the config file to fetch.
  -a, --asset=<value>        The name of the asset to view.
  -c, --cabinet=<value>      The name of the cabinet from which the content is to be drawn.
  -e, --enterprise=<value>   The name of the enterprise containing the asset being viewed.
  -f, --logsFollow           (requires type=logs) Follow (aka watch, tail, stream) the output.
  -h, --help                 Show CLI help.
  -l, --logsTail=<value>     [default: 10] (requires type=logs) Lines of recent logs to include in the output.  Enter -1
                             to include the entire log history stored in the container.
  -n, --environment=<value>  The name of the environment in which the cabinet resides.
  -r, --replica=<value>      The name of one of the asset instances currently running in the cabinet.
  -t, --type=<option>        The type of content to retrieve.
                             <options: logs|term|exec|env|config|status>
  --echo                     Echo interaction mode; renders the equivalent non-interactive cli command for future use
                             before final execution.
  --silent                   Non-Interactive mode; executes without any user interaction and fails on any missing or
                             invalid arguments.
  --takeDefaults             Prevents prompting for confirmation on parameters that were passed in or were set to
                             default values.
  --terminal=<option>        Command used to start the terminal (defaults to "bash")
                             <options: bash|sh>
  --toscript                 Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                             execution.

DESCRIPTION
  Renders a selected type of content for an asset

ALIASES
  $ codiac asset monitor
  $ codiac asset mon
  $ codiac asset get

codiac asset monitor [CMD]​

Renders a selected type of content for an asset

USAGE
  $ codiac asset monitor [CMD] [-h] [-e <value>] [-a <value>] [-n <value>] [-c <value>] [-r <value>] [-t
    logs|term|exec|env|config|status] [--terminal bash|sh] [-f] [-l <value>] [-F <value>] [--takeDefaults | [--silent |
    --echo | --toscript]]

ARGUMENTS
  CMD  (requires type=exec) command and its space-separated arguments to run in the target replica.

FLAGS
  -F, --configFile=<value>   (requires type=config) The root pathname to the config file to fetch.
  -a, --asset=<value>        The name of the asset to view.
  -c, --cabinet=<value>      The name of the cabinet from which the content is to be drawn.
  -e, --enterprise=<value>   The name of the enterprise containing the asset being viewed.
  -f, --logsFollow           (requires type=logs) Follow (aka watch, tail, stream) the output.
  -h, --help                 Show CLI help.
  -l, --logsTail=<value>     [default: 10] (requires type=logs) Lines of recent logs to include in the output.  Enter -1
                             to include the entire log history stored in the container.
  -n, --environment=<value>  The name of the environment in which the cabinet resides.
  -r, --replica=<value>      The name of one of the asset instances currently running in the cabinet.
  -t, --type=<option>        The type of content to retrieve.
                             <options: logs|term|exec|env|config|status>
  --echo                     Echo interaction mode; renders the equivalent non-interactive cli command for future use
                             before final execution.
  --silent                   Non-Interactive mode; executes without any user interaction and fails on any missing or
                             invalid arguments.
  --takeDefaults             Prevents prompting for confirmation on parameters that were passed in or were set to
                             default values.
  --terminal=<option>        Command used to start the terminal (defaults to "bash")
                             <options: bash|sh>
  --toscript                 Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                             execution.

DESCRIPTION
  Renders a selected type of content for an asset

ALIASES
  $ codiac asset monitor
  $ codiac asset mon
  $ codiac asset get

codiac asset new​

Creates a new asset in the given enterprise from an image that exists in a container registry.

USAGE
  $ codiac asset new [-h] [-k <value> | -i <value> | -r <value>] [-g] [-o] [-t] [-y   -n <value> -c <value> -e
    <value> -p <value>]

FLAGS
  -c, --code=<value>        The host name to assign this asset in the domain url.  eg: 'myasset' in
                            'myasset.your-domain.com' (Optional: defaults to the asset name).
  -e, --enterprise=<value>  The name of the enterprise in which to create this asset. (defaults to the current
                            enterprise context)
  -g, --hasIngress          Declaration that the asset service is to be externally accessible (optional: defaults to
                            false).
  -h, --help                Show CLI help.
  -i, --image=<value>       The image name including scope prefix if applicable (eg: '@yourCompany/your-api-image').
  -k, --kit=<value>         The name of the kit (with library prefix, eg: 'library/kitName') to use to create the asset.
                            Use '?' to be prompted for a kit (Optional: used instead of calling for the image).
  -n, --name=<value>        The name to give the enterprise asset (Optional: defaults to the image name without the
                            scope prefix).
  -o, --routedWithoutName   Indicates that this asset will be the base ingress against your DNS. eg: true services
                            yourwebsite.com (as root/naked) (optional: defaults to false).
  -p, --port=<value>        The default port to assign the asset when deployed to a cabinet (optional).
  -r, --registry=<value>    The container registry in which the image exists (defaults to docker hub).
  -t, --toScript            Outputs an assembled command string, NO execution
  -y, --silent              (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
                            prior runs. Requires: image,registry,name,code,enterprise,port

DESCRIPTION
  Creates a new asset in the given enterprise from an image that exists in a container registry.

ALIASES
  $ codiac asset new

codiac asset probe create [CMD]​

Declares the implementation of a health or readiness probe for an asset.

USAGE
  $ codiac asset probe create [CMD] -u readiness|liveness|startup [-h] [-n <value>] [-a <value>] [-v <value>] [-d
    <value>] [-p <value>] [--predefined <value> | --exec | --grpc | --http | --socket] [-x <value>] [--execCommand
    <value> ] [--grpcHost <value> ] [--grpcPort <value> ] [--httpScheme http|https ] [--httpHost <value> ] [--httpPort
    <value> ] [--httpPath <value> ] [-h <value> ] [--socketHost <value> ] [--socketPort <value> ]

ARGUMENTS
  CMD  (requires --exec) command and its space-separated arguments to run in the target replica.

FLAGS
  -a, --asset=<value>          The name of the asset to which this probe is to apply.
  -d, --delay=<value>          The time (in seconds) to wait before the first execution of the probe.
  -h, --help                   Show CLI help.
  -h, --httpHeader=<value>...  (For use only with http) Key value pair (in format x=y) to be used as an http header in
                               an http probe action.
  -n, --enterprise=<value>     The name of the enterprise to which this probe is to apply.
  -p, --period=<value>         [default: 10] How often (in seconds) to fire the probe.
  -u, --usage=<option>         (required) [default: readiness] The diagnostic purpose the probe will serve.
                               <options: readiness|liveness|startup>
  -v, --versions=<value>       Asset version range for which this probe is to be used. (optional: defaults to >=latest)
  -x, --action=<value>         The JSON specification for the probe action itself.  The structure follows the
                               actionType.
  --exec                       Declares the probe shall be carried out as an executable CLI command. A return code of
                               zero indicates success.  Any nonzero result indicates failure.
  --execCommand=<value>...     (For use only with exec) The executable command to run as the probe, as a single string,
                               or as an array of commands and arguments.  If it returns any nonzero result, the probe
                               gets interpreted as a negative/failure.
  --grpc                       Declares the probe shall be carried out as a grpc api request.
  --grpcHost=<value>           (For use only with grpc).
  --grpcPort=<value>           (For use only with grpc).
  --http                       Declares the probe shall be carried out as an http request. Any code greater than or
                               equal to 200 and less than 400 indicates success. Any other code indicates failure.
  --httpHost=<value>           .
  --httpPath=<value>           (For use only with http).
  --httpPort=<value>           (For use only with http).
  --httpScheme=<option>        (For use only with http) The http protocol to use.
                               <options: http|https>
  --predefined=<value>         Calls out by name for an existing standard or shared probe action.  Use this argument
                               instead of defining the probe action with the exec, grpc, http or socket arguments.
  --socket                     Declares the probe shall be carried out as a TCP Socket request.
  --socketHost=<value>         (For use only with socket).
  --socketPort=<value>         (For use only with socket).

DESCRIPTION
  Declares the implementation of a health or readiness probe for an asset.

ALIASES
  $ codiac asset probe create

EXAMPLES
  cod probe:create --predefined builtin-heartbeat-file-exists

  cod probe:create -p 15 --exec --execCommand "cat /app/data/last-heartbeat.json"

  cod probe:create -n acme -a myapi -u readiness -p 15 --exec --execCommand "cat /app/data/last-heartbeat.json"

  cod probe:create -n acme -a myapi -u readiness -p 15 --exec --execCommand cat --execCommand /app/data/last-heartbeat.json

  cod probe:create -n acme -a myapi -u readiness -p 15 --http --httpScheme https --httpHost myapi.acme.com --httpPort 443 --httpPath /diag/heartbeat -h Accept=application/json -h user-agent=MyUserAgent

codiac asset recycle​

Deploys a given asset to a given cabinet. Defaults to current version.

USAGE
  $ codiac asset recycle [-h] [-a <value>] [-v <value>] [-y -e <value> -c <value>]

FLAGS
  -a, --asset=<value>           Search string for the name of the asset to deploy (use ? to be prompted).
  -c, --cabinetName=<value>     Target cabinet name you want deploy
  -e, --enterpriseCode=<value>  Code (name) of the enterprise to deploy
  -h, --help                    Show CLI help.
  -v, --version=<value>         Search string for the version of the asset to deploy  (use ? to be prompted).
  -y, --silent                  (Optional: defaults to false) Prevents confirmations of user-values that are remembered
                                from prior runs. Requires: enterpriseCode,cabinetName

DESCRIPTION
  Deploys a given asset to a given cabinet.  Defaults to current version.

codiac asset view [CMD]​

Renders a selected type of content for an asset

USAGE
  $ codiac asset view [CMD] [-h] [-e <value>] [-a <value>] [-n <value>] [-c <value>] [-r <value>] [-t
    logs|term|exec|env|config|status] [--terminal bash|sh] [-f] [-l <value>] [-F <value>] [--takeDefaults | [--silent |
    --echo | --toscript]]

ARGUMENTS
  CMD  (requires type=exec) command and its space-separated arguments to run in the target replica.

FLAGS
  -F, --configFile=<value>   (requires type=config) The root pathname to the config file to fetch.
  -a, --asset=<value>        The name of the asset to view.
  -c, --cabinet=<value>      The name of the cabinet from which the content is to be drawn.
  -e, --enterprise=<value>   The name of the enterprise containing the asset being viewed.
  -f, --logsFollow           (requires type=logs) Follow (aka watch, tail, stream) the output.
  -h, --help                 Show CLI help.
  -l, --logsTail=<value>     [default: 10] (requires type=logs) Lines of recent logs to include in the output.  Enter -1
                             to include the entire log history stored in the container.
  -n, --environment=<value>  The name of the environment in which the cabinet resides.
  -r, --replica=<value>      The name of one of the asset instances currently running in the cabinet.
  -t, --type=<option>        The type of content to retrieve.
                             <options: logs|term|exec|env|config|status>
  --echo                     Echo interaction mode; renders the equivalent non-interactive cli command for future use
                             before final execution.
  --silent                   Non-Interactive mode; executes without any user interaction and fails on any missing or
                             invalid arguments.
  --takeDefaults             Prevents prompting for confirmation on parameters that were passed in or were set to
                             default values.
  --terminal=<option>        Command used to start the terminal (defaults to "bash")
                             <options: bash|sh>
  --toscript                 Toscript interaction mode; renders the equivalent non-interactive cli command WITHOUT any
                             execution.

DESCRIPTION
  Renders a selected type of content for an asset

ALIASES
  $ codiac asset monitor
  $ codiac asset mon
  $ codiac asset get

codiac asset vol add [MOUNTPATH]​

Declares a named path for mounting a volume to instances of the asset.

USAGE
  $ codiac asset vol add [MOUNTPATH] [-h] [-d <value>] [-y -n <value>]

ARGUMENTS
  MOUNTPATH  Fully qualified mounting path, inside the container, of the folder being mapped as a volume.  Must be
             unique for the asset.

FLAGS
  -d, --description=<value>  Any notes or other information to help clarify the intended purpose of this folder, to
                             assist during the configuration phase when assigning an actual physical file store to it.
  -h, --help                 Show CLI help.
  -n, --name=<value>         Moniker for identifying, retrieving, and accessing this folder mapping.  Must be unique for
                             the asset.
  -y, --silent               (Optional: defaults to false) Prevents confirmations of user-values that are remembered
                             from prior runs. Requires: name

DESCRIPTION
  Declares a named path for mounting a volume to instances of the asset.

ALIASES
  $ codiac asset vol create
  $ codiac asset vol add
  $ codiac asset volume add

codiac asset vol create [MOUNTPATH]​

Declares a named path for mounting a volume to instances of the asset.

USAGE
  $ codiac asset vol create [MOUNTPATH] [-h] [-d <value>] [-y -n <value>]

ARGUMENTS
  MOUNTPATH  Fully qualified mounting path, inside the container, of the folder being mapped as a volume.  Must be
             unique for the asset.

FLAGS
  -d, --description=<value>  Any notes or other information to help clarify the intended purpose of this folder, to
                             assist during the configuration phase when assigning an actual physical file store to it.
  -h, --help                 Show CLI help.
  -n, --name=<value>         Moniker for identifying, retrieving, and accessing this folder mapping.  Must be unique for
                             the asset.
  -y, --silent               (Optional: defaults to false) Prevents confirmations of user-values that are remembered
                             from prior runs. Requires: name

DESCRIPTION
  Declares a named path for mounting a volume to instances of the asset.

ALIASES
  $ codiac asset vol create
  $ codiac asset vol add
  $ codiac asset volume add

codiac asset vol del​

Deletes an existing volume mount in the asset

USAGE
  $ codiac asset vol del [-h] [-y -n <value>]

FLAGS
  -h, --help          Show CLI help.
  -n, --name=<value>  Moniker for identifying, retrieving, and accessing this folder mapping.  Must be unique for the
                      asset.
  -y, --silent        (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior
                      runs. Requires: name

DESCRIPTION
  Deletes an existing volume mount in the asset

ALIASES
  $ codiac asset vol delete
  $ codiac asset volumes delete
  $ codiac asset volume del
  $ codiac asset vol del
  $ codiac asset volumes del

codiac asset vol delete​

Deletes an existing volume mount in the asset

USAGE
  $ codiac asset vol delete [-h] [-y -n <value>]

FLAGS
  -h, --help          Show CLI help.
  -n, --name=<value>  Moniker for identifying, retrieving, and accessing this folder mapping.  Must be unique for the
                      asset.
  -y, --silent        (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior
                      runs. Requires: name

DESCRIPTION
  Deletes an existing volume mount in the asset

ALIASES
  $ codiac asset vol delete
  $ codiac asset volumes delete
  $ codiac asset volume del
  $ codiac asset vol del
  $ codiac asset volumes del

codiac asset vol list​

Renders the currently declared mount paths for the asset.

USAGE
  $ codiac asset vol list [-h] [-p <value>] [-o pretty|json|yaml|auto] [-y -n <value>]

FLAGS
  -h, --help             Show CLI help.
  -n, --name=<value>     Filter volumes within the asset by mount name.
  -o, --output=<option>  [default: auto] Output format of the actual settings data document.
                         <options: pretty|json|yaml|auto>
  -p, --path=<value>     Filter volumes within the asset by mount path.
  -y, --silent           (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
                         prior runs. Requires: name

DESCRIPTION
  Renders the currently declared mount paths for the asset.

ALIASES
  $ codiac asset vol list
  $ codiac asset volumes list

codiac asset volume add [MOUNTPATH]​

Declares a named path for mounting a volume to instances of the asset.

USAGE
  $ codiac asset volume add [MOUNTPATH] [-h] [-d <value>] [-y -n <value>]

ARGUMENTS
  MOUNTPATH  Fully qualified mounting path, inside the container, of the folder being mapped as a volume.  Must be
             unique for the asset.

FLAGS
  -d, --description=<value>  Any notes or other information to help clarify the intended purpose of this folder, to
                             assist during the configuration phase when assigning an actual physical file store to it.
  -h, --help                 Show CLI help.
  -n, --name=<value>         Moniker for identifying, retrieving, and accessing this folder mapping.  Must be unique for
                             the asset.
  -y, --silent               (Optional: defaults to false) Prevents confirmations of user-values that are remembered
                             from prior runs. Requires: name

DESCRIPTION
  Declares a named path for mounting a volume to instances of the asset.

ALIASES
  $ codiac asset vol create
  $ codiac asset vol add
  $ codiac asset volume add

codiac asset volume create [MOUNTPATH]​

Declares a named path for mounting a volume to instances of the asset.

USAGE
  $ codiac asset volume create [MOUNTPATH] [-h] [-d <value>] [-y -n <value>]

ARGUMENTS
  MOUNTPATH  Fully qualified mounting path, inside the container, of the folder being mapped as a volume.  Must be
             unique for the asset.

FLAGS
  -d, --description=<value>  Any notes or other information to help clarify the intended purpose of this folder, to
                             assist during the configuration phase when assigning an actual physical file store to it.
  -h, --help                 Show CLI help.
  -n, --name=<value>         Moniker for identifying, retrieving, and accessing this folder mapping.  Must be unique for
                             the asset.
  -y, --silent               (Optional: defaults to false) Prevents confirmations of user-values that are remembered
                             from prior runs. Requires: name

DESCRIPTION
  Declares a named path for mounting a volume to instances of the asset.

ALIASES
  $ codiac asset vol create
  $ codiac asset vol add
  $ codiac asset volume add

codiac asset volume del​

Deletes an existing volume mount in the asset

USAGE
  $ codiac asset volume del [-h] [-y -n <value>]

FLAGS
  -h, --help          Show CLI help.
  -n, --name=<value>  Moniker for identifying, retrieving, and accessing this folder mapping.  Must be unique for the
                      asset.
  -y, --silent        (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior
                      runs. Requires: name

DESCRIPTION
  Deletes an existing volume mount in the asset

ALIASES
  $ codiac asset vol delete
  $ codiac asset volumes delete
  $ codiac asset volume del
  $ codiac asset vol del
  $ codiac asset volumes del

codiac asset volume delete​

Deletes an existing volume mount in the asset

USAGE
  $ codiac asset volume delete [-h] [-y -n <value>]

FLAGS
  -h, --help          Show CLI help.
  -n, --name=<value>  Moniker for identifying, retrieving, and accessing this folder mapping.  Must be unique for the
                      asset.
  -y, --silent        (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior
                      runs. Requires: name

DESCRIPTION
  Deletes an existing volume mount in the asset

ALIASES
  $ codiac asset vol delete
  $ codiac asset volumes delete
  $ codiac asset volume del
  $ codiac asset vol del
  $ codiac asset volumes del

codiac asset volume list​

Renders the currently declared mount paths for the asset.

USAGE
  $ codiac asset volume list [-h] [-p <value>] [-o pretty|json|yaml|auto] [-y -n <value>]

FLAGS
  -h, --help             Show CLI help.
  -n, --name=<value>     Filter volumes within the asset by mount name.
  -o, --output=<option>  [default: auto] Output format of the actual settings data document.
                         <options: pretty|json|yaml|auto>
  -p, --path=<value>     Filter volumes within the asset by mount path.
  -y, --silent           (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
                         prior runs. Requires: name

DESCRIPTION
  Renders the currently declared mount paths for the asset.

ALIASES
  $ codiac asset vol list
  $ codiac asset volumes list

codiac asset volumes del​

Deletes an existing volume mount in the asset

USAGE
  $ codiac asset volumes del [-h] [-y -n <value>]

FLAGS
  -h, --help          Show CLI help.
  -n, --name=<value>  Moniker for identifying, retrieving, and accessing this folder mapping.  Must be unique for the
                      asset.
  -y, --silent        (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior
                      runs. Requires: name

DESCRIPTION
  Deletes an existing volume mount in the asset

ALIASES
  $ codiac asset vol delete
  $ codiac asset volumes delete
  $ codiac asset volume del
  $ codiac asset vol del
  $ codiac asset volumes del

codiac asset volumes delete​

Deletes an existing volume mount in the asset

USAGE
  $ codiac asset volumes delete [-h] [-y -n <value>]

FLAGS
  -h, --help          Show CLI help.
  -n, --name=<value>  Moniker for identifying, retrieving, and accessing this folder mapping.  Must be unique for the
                      asset.
  -y, --silent        (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior
                      runs. Requires: name

DESCRIPTION
  Deletes an existing volume mount in the asset

ALIASES
  $ codiac asset vol delete
  $ codiac asset volumes delete
  $ codiac asset volume del
  $ codiac asset vol del
  $ codiac asset volumes del

codiac asset volumes list​

Renders the currently declared mount paths for the asset.

USAGE
  $ codiac asset volumes list [-h] [-p <value>] [-o pretty|json|yaml|auto] [-y -n <value>]

FLAGS
  -h, --help             Show CLI help.
  -n, --name=<value>     Filter volumes within the asset by mount name.
  -o, --output=<option>  [default: auto] Output format of the actual settings data document.
                         <options: pretty|json|yaml|auto>
  -p, --path=<value>     Filter volumes within the asset by mount path.
  -y, --silent           (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
                         prior runs. Requires: name

DESCRIPTION
  Renders the currently declared mount paths for the asset.

ALIASES
  $ codiac asset vol list
  $ codiac asset volumes list

codiac autocomplete [SHELL]​

display autocomplete installation instructions

USAGE
  $ codiac autocomplete [SHELL] [-r]

ARGUMENTS
  SHELL  shell type

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

DESCRIPTION
  display autocomplete installation instructions

EXAMPLES
  $ codiac autocomplete

  $ codiac autocomplete bash

  $ codiac autocomplete zsh

  $ codiac autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

codiac branch [NAME]​

Creates a new branch for the parent project and any sourced dependencies.

USAGE
  $ codiac branch [NAME] [-s] [-h]

ARGUMENTS
  NAME  The name of the branch to create.

FLAGS
  -h, --help    Show CLI help.
  -s, --switch  Automatically switches to the new branch after creating it.

DESCRIPTION
  Creates a new branch for the parent project and any sourced dependencies.

See code: src/commands/branch.ts

codiac branch current​

Renders the name of the current branch (for the main project and for any sourced dependencies).

USAGE
  $ codiac branch current [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Renders the name of the current branch (for the main project and for any sourced dependencies).

ALIASES
  $ codiac branches current

codiac branch list​

Lists out existing branches for the project repo.

USAGE
  $ codiac branch list [-h] [-r | -l]

FLAGS
  -h, --help     Displays the help document for this command.
  -l, --locals   (Optional, defaults to false) Limits to local branches only.
  -r, --remotes  (Optional, defaults to false) Limits to remote branches only.

DESCRIPTION
  Lists out existing branches for the project repo.

ALIASES
  $ codiac branches list

codiac branches current​

Renders the name of the current branch (for the main project and for any sourced dependencies).

USAGE
  $ codiac branches current [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Renders the name of the current branch (for the main project and for any sourced dependencies).

ALIASES
  $ codiac branches current

codiac branches list​

Lists out existing branches for the project repo.

USAGE
  $ codiac branches list [-h] [-r | -l]

FLAGS
  -h, --help     Displays the help document for this command.
  -l, --locals   (Optional, defaults to false) Limits to local branches only.
  -r, --remotes  (Optional, defaults to false) Limits to remote branches only.

DESCRIPTION
  Lists out existing branches for the project repo.

ALIASES
  $ codiac branches list

codiac build​

Builds the project and the docker container

USAGE
  $ codiac build [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h] [-f <value>] [-n] [-d -b <value>] [--version <value>] [-M] [-m] [-p] [-r] [-c] [-s
    images|packages] [-i <value>] [-t <value>]

FLAGS
  -M, --major                     Increments the version by one Major version number (using Major.Minor.Patch).
  -b, --buildDef=<value>          Replaces the default build command with the given process.  For a multi-command
                                  sequence, separate each with a Pipe (|) character.
  -c, --clear                     Completely deletes the output folder before building.
  -d, --asDefault                 Overwrites the default build command for the project with the buildDef argument
  -f, --frameworkVersion=<value>  (Future) Explicitly sets the version of the Toyhauler base image to use (default:
                                  latest).
  -h, --help                      Show CLI help.
  -i, --image=<value>...          (optional, defaults to all) Limits the list of images to build.  Value must match the
                                  name property of an image export defined in the codiac project file (codiac.json)
  -m, --minor                     Increments the version by one Minor version number (using Major.Minor.Patch).
  -n, --noCache                   Ignores the local Docker image cache, thereby forcing a fresh download of each image
                                  from its container registry layer in the build.
  -p, --patch                     Increments the version by one Patch version number (using Major.Minor.Patch).
  -r, --prerelease                Increments the prerelease number (using Major.Minor.Patch-PreRelease).  NOTE:
                                  Increments the Patch version number when appending.
  -s, --skip=<option>             (optional) Prevents the building of any declared container images or packages.
                                  <options: images|packages>
  -t, --buildTarget=<value>       (optional) Calls out the only stage to be built for images defined with multistage
                                  builds.
  -v, --verbose                   Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>                    Fires this command with an argument list that was previously remembered using the
                                  --rememberAs flag.
  --remember                      Saves the arguments, so they are invoked as defaults whenever this command gets
                                  called.
  --rememberAs=<value>            Saves the given argument list so that it can be called by name.
  --unremember=<value>            Administrative only: DOES NOT fire the actual command.  Simply clears the arguments
                                  that were previously stored under the given name (use "--unRemember default" to clear
                                  default argument list memorized with the --remember flag).
  --version=<value>               Overwrites the full version for the build (using Major.Minor.Patch).
  --withoutdefaults               Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Builds the project and the docker container

See code: src/commands/build.ts

codiac cab create [CABINET]​

Initializes a cabinet for a given enterprise and environment. Overwrites any existing if forced, otherwise returns an error if the cabinet already exists.

USAGE
  $ codiac cab create [CABINET] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h] [-f] [-e <value>]

ARGUMENTS
  CABINET  The name of the cabinet to create

FLAGS
  -e, --environment=<value>  (optional: defaults to that of the current project branch) The name of the environment this
                             cabinet will be grouped under.
  -f, --force                Overwrites and reinitializes if the cabinet already exists.
  -h, --help                 Show CLI help.
  -v, --verbose              Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>               Fires this command with an argument list that was previously remembered using the
                             --rememberAs flag.
  --remember                 Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>       Saves the given argument list so that it can be called by name.
  --unremember=<value>       Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                             were previously stored under the given name (use "--unRemember default" to clear default
                             argument list memorized with the --remember flag).
  --withoutdefaults          Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Initializes a cabinet for a given enterprise and environment.  Overwrites any existing if forced, otherwise returns an
  error if the cabinet already exists.

ALIASES
  $ codiac cab create

codiac cab list​

Shows the list of cabinets and environment.

USAGE
  $ codiac cab list [-o json|yaml|tree|text] [-h]

FLAGS
  -h, --help             Displays the help document for this command.
  -o, --output=<option>  [default: tree] format in which to render the data.
                         <options: json|yaml|tree|text>

DESCRIPTION
  Shows the list of cabinets and environment.

ALIASES
  $ codiac cab list

codiac cab obliterate [CABINET]​

Hard-deletes an entire cabinet and everything in it; makes it as if the cabinet itself never existed.

USAGE
  $ codiac cab obliterate [CABINET] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h] [-e <value>]

ARGUMENTS
  CABINET  The name of the cabinet

FLAGS
  -e, --environment=<value>  (optional: defaults to that of the current project branch) The name of the environment this
                             cabinet will be grouped under.
  -h, --help                 Show CLI help.
  -v, --verbose              Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>               Fires this command with an argument list that was previously remembered using the
                             --rememberAs flag.
  --remember                 Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>       Saves the given argument list so that it can be called by name.
  --unremember=<value>       Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                             were previously stored under the given name (use "--unRemember default" to clear default
                             argument list memorized with the --remember flag).
  --withoutdefaults          Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Hard-deletes an entire cabinet and everything in it; makes it as if the cabinet itself never existed.

ALIASES
  $ codiac cab obliterate

codiac cabinet create [CABINET]​

Initializes a cabinet for a given enterprise and environment. Overwrites any existing if forced, otherwise returns an error if the cabinet already exists.

USAGE
  $ codiac cabinet create [CABINET] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h] [-f] [-e <value>]

ARGUMENTS
  CABINET  The name of the cabinet to create

FLAGS
  -e, --environment=<value>  (optional: defaults to that of the current project branch) The name of the environment this
                             cabinet will be grouped under.
  -f, --force                Overwrites and reinitializes if the cabinet already exists.
  -h, --help                 Show CLI help.
  -v, --verbose              Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>               Fires this command with an argument list that was previously remembered using the
                             --rememberAs flag.
  --remember                 Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>       Saves the given argument list so that it can be called by name.
  --unremember=<value>       Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                             were previously stored under the given name (use "--unRemember default" to clear default
                             argument list memorized with the --remember flag).
  --withoutdefaults          Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Initializes a cabinet for a given enterprise and environment.  Overwrites any existing if forced, otherwise returns an
  error if the cabinet already exists.

ALIASES
  $ codiac cab create

codiac cabinet list​

Shows the list of cabinets and environment.

USAGE
  $ codiac cabinet list [-o json|yaml|tree|text] [-h]

FLAGS
  -h, --help             Displays the help document for this command.
  -o, --output=<option>  [default: tree] format in which to render the data.
                         <options: json|yaml|tree|text>

DESCRIPTION
  Shows the list of cabinets and environment.

ALIASES
  $ codiac cab list

codiac cabinet obliterate [CABINET]​

Hard-deletes an entire cabinet and everything in it; makes it as if the cabinet itself never existed.

USAGE
  $ codiac cabinet obliterate [CABINET] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h] [-e <value>]

ARGUMENTS
  CABINET  The name of the cabinet

FLAGS
  -e, --environment=<value>  (optional: defaults to that of the current project branch) The name of the environment this
                             cabinet will be grouped under.
  -h, --help                 Show CLI help.
  -v, --verbose              Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>               Fires this command with an argument list that was previously remembered using the
                             --rememberAs flag.
  --remember                 Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>       Saves the given argument list so that it can be called by name.
  --unremember=<value>       Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                             were previously stored under the given name (use "--unRemember default" to clear default
                             argument list memorized with the --remember flag).
  --withoutdefaults          Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Hard-deletes an entire cabinet and everything in it; makes it as if the cabinet itself never existed.

ALIASES
  $ codiac cab obliterate

codiac cfg add [SETTING]​

Adds a key value pair to the app config

USAGE
  $ codiac cfg add [SETTING] [-h] [-s <value>] [-v <value>] [-n <value> | -e <value> | -c <value>] [-f
    <value>]

ARGUMENTS
  SETTING  The key for the config setting to add

FLAGS
  -c, --cabinet=<value>      The name of the cabinet to which this value is to apply.
  -e, --environment=<value>  The name of the environment to which this value is to apply.
  -f, --file=<value>         The path-name to the file to which the settings are written, relative to the root of the
                             Codiac project.
  -h, --help                 Show CLI help.
  -n, --enterprise=<value>   The name of the enterprise to which this value is to apply.
  -s, --setting=<value>      The config key (in dotpath/JSONPath), relative to the root of the config.
  -v, --value=<value>        The actual concrete data to be applied as the setting value.

DESCRIPTION
  Adds a key value pair to the app config

ALIASES
  $ codiac config set
  $ codiac cfg add

codiac cfg delete [SETTING]​

Removes the given keys from the app config

USAGE
  $ codiac cfg delete [SETTING] [-h] [-s <value>] [-n <value> | -e <value> | -c <value>] [-f <value>]

ARGUMENTS
  SETTING  (optional) Specific config key to remove. Omit to select from a list. Enter "all" to clear the entire config.

FLAGS
  -c, --cabinet=<value>      The name of the cabinet to which this value is to apply.
  -e, --environment=<value>  The name of the environment to which this value is to apply.
  -f, --file=<value>         The path-name to the config file holding the settings, relative to the root of the Codiac
                             project.
  -h, --help                 Show CLI help.
  -n, --enterprise=<value>   The name of the enterprise to which this value is to apply.
  -s, --setting=<value>      The config key (in dotpath/JSONPath), relative to the root of the config.

DESCRIPTION
  Removes the given keys from the app config

ALIASES
  $ codiac cfg delete

codiac cfg view [SETTING]​

Shows the values that are explicitly set in the given config

USAGE
  $ codiac cfg view [SETTING] [-h] [-p] [-a <value>] [-f <value>] [-y [-c <value> |  | ] ] [-o
    pretty|json|yaml|auto]

ARGUMENTS
  SETTING  (optional) Name of specific setting value to view; omit to show all.

FLAGS
  -a, --asset=<value>    Search string for the name of the asset to deploy (use ? to be prompted).
  -c, --cabinet=<value>  The name of the cabinet to assemble the configuration for.
  -f, --file=<value>     [default: app-config.json] The relative pathname of the config file to view (relative to the
                         root of the codiac project).
  -h, --help             Show CLI help.
  -o, --output=<option>  [default: auto] Output format of the actual settings data document.
                         <options: pretty|json|yaml|auto>
  -p, --prompt           Invokes a prompt to select from the existing settings.
  -y, --silent           (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
                         prior runs.

DESCRIPTION
  Shows the values that are explicitly set in the given config

ALIASES
  $ codiac cfg view

EXAMPLES
  $ cod config:view

  $ cod config:view port

  $ cod config:view -p

  $ cod config:view -o pretty

  $ cod config:view -c dev2 -f settings.json -o pretty

codiac cli​

Applies settings to the Codiac CLI itself (scoped to the local machine).

USAGE
  $ codiac cli [-h] [-s <value>]

FLAGS
  -h, --help            Show the help docs for this command.
  -s, --set=<value>...  A key=value expression for the setting to apply.  Leave this argument out of your call to get a
                        list of the available settings keys and their types.

DESCRIPTION
  Applies settings to the Codiac CLI itself (scoped to the local machine).

See code: src/commands/cli.ts

codiac cluster create [NAME]​

Provisions the physical cluster

USAGE
  $ codiac cluster create [NAME] [-h] [-p <value>] [-k <value>] [-u <value>] [-u <value>] [-y <value> -s <value> -g
    <value> -l <value> -n <value> -q <value>] [-t]

ARGUMENTS
  NAME  Proposed name of the cluster

FLAGS
  -g, --resourceGroup=<value>         The Azure resource group to create for the cluster.
  -h, --help                          Show CLI help.
  -k, --subnet=<value>                The resource id of the subnet in which the cluster is to be created.
  -l, --location=<value>              The short name of the azure data center in which the cliuster is to reside.
  -n, --nodeSpec=<value>              The identifier for the type of VM to use for nodes in the cluster.
  -p, --owner=<value>                 Tenant code of the private owner of the cluster
  -q, --nodeQty=<value>               The starting node count with which to create the cluster.
  -s, --providerSubscription=<value>  The Azure subscription Id under which to create the cluster.
  -t, --toScript                      Outputs an assembled command string, NO execution
  -u, --identityUserId=<value>        OPTIONAL. ID of Svc Principal or Managed Identity to execute as. To create k8s
                                      cluster, IP address, and container Pull.  If none supplied Codiac will try to
                                      create one.
  -u, --identityUserName=<value>      OPTIONAL. Name of Svc Principal or Managed Identity to execute as. To create k8s
                                      cluster, IP address, and container Pull.  If none supplied Codiac will try to
                                      create one.
  -y, --silent=<value>                (Optional: defaults to false) Prevents confirmations of user-values. Required:
                                      providerSubscription,resourceGroup,location,nodeSpec,nodeQty

DESCRIPTION
  Provisions the physical cluster

ALIASES
  $ codiac cluster create

codiac cluster deinit [NAME]​

Deinitialization of the cluster (uninstalls the ingress controller and tls cert manager services)

USAGE
  $ codiac cluster deinit [NAME] [-h] [-p aws|azure|dockerHub|other] [-y -n <value>]

ARGUMENTS
  NAME  Name of existing cluster.

FLAGS
  -h, --help               Show CLI help.
  -n, --name=<value>       Name of the cluster.
  -p, --provider=<option>  Code for the cloud service provider.
                           <options: aws|azure|dockerHub|other>
  -y, --silent             (Optional: defaults to false) Prevents interactive user-interface and throws if interaction
                           is needed. Requires arguments: [--name -n]

DESCRIPTION
  Deinitialization of the cluster (uninstalls the ingress controller and tls cert manager services)

ALIASES
  $ codiac cluster deinit

codiac cluster destroy [NAME]​

Kills the physical cluster, but not the Codiac cluster definition record

USAGE
  $ codiac cluster destroy [NAME] [-h] [-p] [-i] [-p azure|aws|dockerHub|other] [-y -n <value>]

ARGUMENTS
  NAME  Proposed name of the cluster

FLAGS
  -h, --help               Show CLI help.
  -i, --deleteIdentity     (optional: defaults to false) Ensures that identity security account for the cluster shall
                           also be deleted after the cluster itself is destroyed.
  -n, --name=<value>       Name of the cluster.
  -p, --partials           Include clusters that were never fully created.
  -p, --provider=<option>  Code for the cloud service provider.
                           <options: azure|aws|dockerHub|other>
  -y, --silent             (Optional: defaults to false) Prevents confirmations of user-values. Required: name

DESCRIPTION
  Kills the physical cluster, but not the Codiac cluster definition record

ALIASES
  $ codiac cluster destroy

codiac cluster forget​

Permanently removes the record of a cluster. This command does NOT affect any infrastructure; it simply removes the cluster from the Codiac consciousness. Use cod cluster capture to re-acquire an existing but forgotten cluster. You must remove all cabinets and environments in a cluster before forgetting it.

USAGE
  $ codiac cluster forget [-y -n <value> -p azure|aws|dockerHub|other]

FLAGS
  -n, --name=<value>       Name of the cluster.
  -p, --provider=<option>  Code for the cloud service provider.
                           <options: azure|aws|dockerHub|other>
  -y, --silent             (Optional: defaults to false) Prevents confirmations of user-values. Required: ["name",
                           "provider"]

DESCRIPTION
  Permanently removes the record of a cluster.  This command does NOT affect any infrastructure; it simply removes the
  cluster from the Codiac consciousness.  Use `cod cluster capture` to re-acquire an existing but forgotten cluster.
  You must remove all cabinets and environments in a cluster before forgetting it.

ALIASES
  $ codiac cluster forget

codiac cluster grant [NAME]​

(AWS Only) Provides cluster access to the given user.

USAGE
  $ codiac cluster grant [NAME] [-h] [-y -c <value> -u <value>]

ARGUMENTS
  NAME  Proposed name of the cluster

FLAGS
  -c, --cluster=<value>  Name of the cluster.
  -h, --help             Show CLI help.
  -u, --user=<value>     AWS usernames (as email) to add.
  -y, --silent           (Optional: defaults to false) Prevents confirmations of user-values.

DESCRIPTION
  (AWS Only) Provides cluster access to the given user.

ALIASES
  $ codiac cluster grant

codiac cluster init [NAME]​

Post-create initialization for the cluster (installs the ingress controller service)

USAGE
  $ codiac cluster init [NAME] [-h] [-p azure|aws|dockerHub|other] [-y -n <value>]

ARGUMENTS
  NAME  Name of existing cluster to initialize.

FLAGS
  -h, --help               Show CLI help.
  -n, --name=<value>       Name of the cluster.
  -p, --provider=<option>  Code for the cloud service provider.
                           <options: azure|aws|dockerHub|other>
  -y, --silent             (Optional: defaults to false) Prevents interactive user-interface and throws if interaction
                           is needed. Requires arguments: [--name -n]

DESCRIPTION
  Post-create initialization for the cluster (installs the ingress controller service)

ALIASES
  $ codiac cluster init

codiac cluster list​

Shows the list of clusters.

USAGE
  $ codiac cluster list [-o text|tree|json|yaml] [-h]

FLAGS
  -h, --help             Displays the help document for this command.
  -o, --output=<option>  [default: tree] format in which to render the data.
                         <options: text|tree|json|yaml>

DESCRIPTION
  Shows the list of clusters.

ALIASES
  $ codiac cluster list

codiac cluster recreate [NAME]​

Provisions the physical cluster using the existing ClusterDef record (with any changes provided by the caller).

USAGE
  $ codiac cluster recreate [NAME] [-h] [-p <value>] [-s <value>] [-g <value>] [-l <value>] [-k <value>] [-v <value>]
    [-w -n <value> -q <value>] [--identityName <value>] [-y] [-t]

ARGUMENTS
  NAME  Name of an existing cluster to re-create

FLAGS
  -g, --resourceGroup=<value>         The Azure resource group to create for the cluster.
  -h, --help                          Show CLI help.
  -k, --subnet=<value>                The resource id of the subnet in which the cluster is to be created.
  -l, --location=<value>              The short name of the azure data center in which the cliuster is to reside.
  -n, --nodeSpec=<value>              The identifier for the type of VM to use for nodes in the cluster.
  -p, --owner=<value>                 Tenant code of the private owner of the cluster
  -q, --nodeQty=<value>               The starting node count with which to create the cluster.
  -s, --providerSubscription=<value>  The Azure subscription Id under which to create the cluster.
  -t, --toScript                      Outputs an assembled command string, NO execution
  -v, --k8sVersion=<value>            The Kubernetes version for the new cluster.  This must be a supported version from
                                      the cloud provider.
  -w, --windowsSupport                Add a windows nodepool.
  -y, --silent                        (Optional: defaults to false) Prevents confirmations of user-values. Required:
  --identityName=<value>              name of an existing service principal to use for the cluster identity

DESCRIPTION
  Provisions the physical cluster using the existing ClusterDef record (with any changes provided by the caller).

ALIASES
  $ codiac cluster recreate

codiac commit [MESSAGE]​

Commits the currently staged changes on the current branch of the main project and on any sourced dependencies.

USAGE
  $ codiac commit [MESSAGE] [-h]

ARGUMENTS
  MESSAGE  The description to include in this particular commit.

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Commits the currently staged changes on the current branch of the main project and on any sourced dependencies.

See code: src/commands/commit.ts

codiac config add [SETTING]​

Adds a key value pair to the app config

USAGE
  $ codiac config add [SETTING] [-h] [-s <value>] [-v <value>] [-n <value> | -e <value> | -c <value>] [-f
    <value>]

ARGUMENTS
  SETTING  The key for the config setting to add

FLAGS
  -c, --cabinet=<value>      The name of the cabinet to which this value is to apply.
  -e, --environment=<value>  The name of the environment to which this value is to apply.
  -f, --file=<value>         The path-name to the file to which the settings are written, relative to the root of the
                             Codiac project.
  -h, --help                 Show CLI help.
  -n, --enterprise=<value>   The name of the enterprise to which this value is to apply.
  -s, --setting=<value>      The config key (in dotpath/JSONPath), relative to the root of the config.
  -v, --value=<value>        The actual concrete data to be applied as the setting value.

DESCRIPTION
  Adds a key value pair to the app config

ALIASES
  $ codiac config set
  $ codiac cfg add

codiac config delete [SETTING]​

Removes the given keys from the app config

USAGE
  $ codiac config delete [SETTING] [-h] [-s <value>] [-n <value> | -e <value> | -c <value>] [-f <value>]

ARGUMENTS
  SETTING  (optional) Specific config key to remove. Omit to select from a list. Enter "all" to clear the entire config.

FLAGS
  -c, --cabinet=<value>      The name of the cabinet to which this value is to apply.
  -e, --environment=<value>  The name of the environment to which this value is to apply.
  -f, --file=<value>         The path-name to the config file holding the settings, relative to the root of the Codiac
                             project.
  -h, --help                 Show CLI help.
  -n, --enterprise=<value>   The name of the enterprise to which this value is to apply.
  -s, --setting=<value>      The config key (in dotpath/JSONPath), relative to the root of the config.

DESCRIPTION
  Removes the given keys from the app config

ALIASES
  $ codiac cfg delete

codiac config deploy​

Deploys a given asset to a given cabinet. Defaults to current version.

USAGE
  $ codiac config deploy [-h] [-a <value>] [-v <value>] [-y -e <value> -c <value>]

FLAGS
  -a, --asset=<value>           Search string for the name of the asset to deploy (use ? to be prompted).
  -c, --cabinetName=<value>     Target cabinet name you want deploy
  -e, --enterpriseCode=<value>  Code (name) of the enterprise to deploy
  -h, --help                    Show CLI help.
  -v, --version=<value>         Search string for the version of the asset to deploy  (use ? to be prompted).
  -y, --silent                  (Optional: defaults to false) Prevents confirmations of user-values that are remembered
                                from prior runs. Requires: enterpriseCode,cabinetName

DESCRIPTION
  Deploys a given asset to a given cabinet.  Defaults to current version.

codiac config import [SETTING]​

Adds a key value pair to the app config

USAGE
  $ codiac config import [SETTING] [-h] [-n <value> | -e <value> | -c <value>] [-s <value>] [-f <value>]

ARGUMENTS
  SETTING  The key for the config setting to add

FLAGS
  -c, --cabinet=<value>          The name of the cabinet to which this value is to apply.
  -e, --environment=<value>      The name of the environment to which this value is to apply.
  -f, --runtimePathName=<value>  (optional, uses the original filename) The pathname relative to the app root to assume
                                 in the container.
  -h, --help                     Show CLI help.
  -n, --enterprise=<value>       The name of the enterprise to which this value is to apply.
  -s, --sourceFile=<value>       The path-name to the LOCAL file to which the settings are written, relative to the root
                                 of the Codiac project.

DESCRIPTION
  Adds a key value pair to the app config

ALIASES
  $ codiac cfg add

codiac config set [SETTING]​

Adds a key value pair to the app config

USAGE
  $ codiac config set [SETTING] [-h] [-s <value>] [-v <value>] [-n <value> | -e <value> | -c <value>] [-f
    <value>]

ARGUMENTS
  SETTING  The key for the config setting to add

FLAGS
  -c, --cabinet=<value>      The name of the cabinet to which this value is to apply.
  -e, --environment=<value>  The name of the environment to which this value is to apply.
  -f, --file=<value>         The path-name to the file to which the settings are written, relative to the root of the
                             Codiac project.
  -h, --help                 Show CLI help.
  -n, --enterprise=<value>   The name of the enterprise to which this value is to apply.
  -s, --setting=<value>      The config key (in dotpath/JSONPath), relative to the root of the config.
  -v, --value=<value>        The actual concrete data to be applied as the setting value.

DESCRIPTION
  Adds a key value pair to the app config

ALIASES
  $ codiac config set
  $ codiac cfg add

codiac config view [SETTING]​

Shows the values that are explicitly set in the given config

USAGE
  $ codiac config view [SETTING] [-h] [-p] [-a <value>] [-f <value>] [-y [-c <value> |  | ] ] [-o
    pretty|json|yaml|auto]

ARGUMENTS
  SETTING  (optional) Name of specific setting value to view; omit to show all.

FLAGS
  -a, --asset=<value>    Search string for the name of the asset to deploy (use ? to be prompted).
  -c, --cabinet=<value>  The name of the cabinet to assemble the configuration for.
  -f, --file=<value>     [default: app-config.json] The relative pathname of the config file to view (relative to the
                         root of the codiac project).
  -h, --help             Show CLI help.
  -o, --output=<option>  [default: auto] Output format of the actual settings data document.
                         <options: pretty|json|yaml|auto>
  -p, --prompt           Invokes a prompt to select from the existing settings.
  -y, --silent           (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
                         prior runs.

DESCRIPTION
  Shows the values that are explicitly set in the given config

ALIASES
  $ codiac cfg view

EXAMPLES
  $ cod config:view

  $ cod config:view port

  $ cod config:view -p

  $ cod config:view -o pretty

  $ cod config:view -c dev2 -f settings.json -o pretty

codiac csp login [PROVIDER]​

Authenticates with the given Cloud Service Provider (CSP), eg: aws, azure, docker. Use this command both to validate credentials and to declare the csp user account for subsequent commands involving that provider.

USAGE
  $ codiac csp login [PROVIDER] [-u <value> | --clientSecret] [-p <value> | ] [-y]

ARGUMENTS
  PROVIDER  (aws|azure|dockerHub|other) Code indicating the Cloud Service Provider (CSP) being authenticated with.

FLAGS
  -p, --password=<value>  (must be provided via stdin) The password at the given cloud provider.
  -u, --user=<value>      The username at the given cloud provider.
  -y, --silent            (Optional: defaults to false) Suppresses any user-interaction.
  --clientSecret          (must be provided interactively or via stdin) Invokes the OAuth Client Credentials Flow. Used
                          to authenticate when no user is present, such as an internal service or in a devops pipeline.
                          Note: This is a secret that must be created when Codiac gets registered as a trusted
                          application in your cloud service provider subscription (eg: in azure, this is an app
                          registration in Azure AD).

DESCRIPTION
  Authenticates with the given Cloud Service Provider (CSP), eg: aws, azure, docker.  Use this command both to validate
  credentials and to declare the csp user account for subsequent commands involving that provider.

EXAMPLES
  cod csp login

  cod csp login docker

  cat mypassword.txt | cod csp login -u me@mydomain.com --silent docker

  cat theclientsecret.txt | cod csp login --clientSecret --silent azure

codiac csp logout [PROVIDER]​

Closes session with the given Cloud Service Provider (CSP), eg: aws, azure, docker. Use this command to clear the local cache for your security account at that provider.

USAGE
  $ codiac csp logout [PROVIDER] [-y]

ARGUMENTS
  PROVIDER  (aws|azure|dockerHub|other) Code indicating the Cloud Service Provider (CSP) being authenticated with.

FLAGS
  -y, --silent  (Optional: defaults to false) Suppresses any user-interaction.

DESCRIPTION
  Closes session with the given Cloud Service Provider (CSP), eg: aws, azure, docker.  Use this command to clear the
  local cache for your security account at that provider.

EXAMPLES
  cod csp logout

  cod csp logout docker

  cod csp logout --silent azure

codiac dash​

Spins up the dashboard for a given cabinet

USAGE
  $ codiac dash [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Spins up the dashboard for a given cabinet

ALIASES
  $ codiac view dash
  $ codiac dash

codiac dep [NAME]​

Installs a package into current project.

USAGE
  $ codiac dep [NAME] [-h] [-v <value>]

ARGUMENTS
  NAME  The official unique name of the package to install.

FLAGS
  -h, --help             Show CLI help.
  -v, --version=<value>  version of the package to install

DESCRIPTION
  Installs a package into current project.

See code: src/commands/dep.ts

codiac dep create [URL]​

Sources a new dependency into the project from an existing repo url, initializes it with the package repository, and publishes the initial version if it is not already. If the package repository is already initialized, the latest package version is used.

USAGE
  $ codiac dep create [URL] -n <value> [-h] [-v <value>]

ARGUMENTS
  URL  The official clone url for the repository.

FLAGS
  -h, --help             Show CLI help.
  -n, --pkgName=<value>  (required) Package name including any scope prefix (eg: @codiac.io/)
  -v, --version=<value>  Version to apply to the dependency package if it has not yet been initialized.

DESCRIPTION
  Sources a new dependency into the project from an existing repo url, initializes it with the package repository, and
  publishes the initial version if it is not already.  If the package repository is already initialized, the latest
  package version is used.

codiac dep install​

installs any missing dependency packages into the local project folder.

USAGE
  $ codiac dep install [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  installs any missing dependency packages into the local project folder.

codiac dep list​

Shows the dependencies for the project.

USAGE
  $ codiac dep list [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Shows the dependencies for the project.

codiac dep remove [NAME]​

Removes a dependency from the project.

USAGE
  $ codiac dep remove [NAME] [-h] [-d]

ARGUMENTS
  NAME  The official unique name of the dependency package.

FLAGS
  -d, --discard  If the dependency to remove is sourced into the project, setting this flag discards all uncommitted
                 changes (staged and unstaged) before removing it.  Again, uncomitted changes are LOST when this flag is
                 set.
  -h, --help     Show CLI help.

DESCRIPTION
  Removes a dependency from the project.

codiac dep source [NAME]​

Loads the source code for the given dependency

USAGE
  $ codiac dep source [NAME] [-h] [-d <value>]

ARGUMENTS
  NAME  The official unique name of the dependency package.

FLAGS
  -d, --distSubPath=<value>  Subfolder path, relative to the root of the submodule,  to the folder from which the
                             package is created,  aka: the build output folder or 'dist' folder (eg: bin, dist, or lib,
                             ...etc).  This folder is used as the target folder for npm link.
  -h, --help                 Show CLI help.

DESCRIPTION
  Loads the source code for the given dependency

ALIASES
  $ codiac dep src

codiac dep src [NAME]​

Loads the source code for the given dependency

USAGE
  $ codiac dep src [NAME] [-h] [-d <value>]

ARGUMENTS
  NAME  The official unique name of the dependency package.

FLAGS
  -d, --distSubPath=<value>  Subfolder path, relative to the root of the submodule,  to the folder from which the
                             package is created,  aka: the build output folder or 'dist' folder (eg: bin, dist, or lib,
                             ...etc).  This folder is used as the target folder for npm link.
  -h, --help                 Show CLI help.

DESCRIPTION
  Loads the source code for the given dependency

ALIASES
  $ codiac dep src

codiac dep syncup DEPENDENCY​

Publishes the dependency in its current state and upgrades to it in the main project.

USAGE
  $ codiac dep syncup DEPENDENCY [-h]

ARGUMENTS
  DEPENDENCY  The package name of the dependency to sync up into the main project

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Publishes the dependency in its current state and upgrades to it in the main project.

codiac dep unsource [NAME]​

Exits source mode for the given dependency by physically removing its source code folder from the project, and points the project dependency back to the package version it previously depended on.

USAGE
  $ codiac dep unsource [NAME] [-h] [-d] [-c]

ARGUMENTS
  NAME  The official unique name of the dependency package.

FLAGS
  -c, --comment  The commit message for any outstanding changes.
  -d, --discard  Discards all uncommitted changes (staged and unstaged) before unsourcing, and goes back to the
                 previously installed version of the dependency.  Again, uncomitted changes are LOST when this flag is
                 set.
  -h, --help     Show CLI help.

DESCRIPTION
  Exits source mode for the given dependency by physically removing its source code folder from the project, and points
  the project dependency back to the package version it previously depended on.

ALIASES
  $ codiac dep unsrc

codiac dep unsrc [NAME]​

Exits source mode for the given dependency by physically removing its source code folder from the project, and points the project dependency back to the package version it previously depended on.

USAGE
  $ codiac dep unsrc [NAME] [-h] [-d] [-c]

ARGUMENTS
  NAME  The official unique name of the dependency package.

FLAGS
  -c, --comment  The commit message for any outstanding changes.
  -d, --discard  Discards all uncommitted changes (staged and unstaged) before unsourcing, and goes back to the
                 previously installed version of the dependency.  Again, uncomitted changes are LOST when this flag is
                 set.
  -h, --help     Show CLI help.

DESCRIPTION
  Exits source mode for the given dependency by physically removing its source code folder from the project, and points
  the project dependency back to the package version it previously depended on.

ALIASES
  $ codiac dep unsrc

codiac dep upgrade [DEPENDENCY]​

describe the command here

USAGE
  $ codiac dep upgrade [DEPENDENCY] [-h] [-v <value>]

ARGUMENTS
  DEPENDENCY  The dependency to upgrade

FLAGS
  -h, --help             Show CLI help.
  -v, --version=<value>  version of the package to install

DESCRIPTION
  describe the command here

codiac deploy​

Deploys a given asset to a given cabinet. Defaults to current version.

USAGE
  $ codiac deploy [-h] [-a <value>] [-u <value>] [-n <value>] [-p <value>] [-y -e <value> -c <value>]

FLAGS
  -a, --asset=<value>             Search string for the name of the asset to deploy (use ? or ?? to be prompted).
  -c, --cabinetName=<value>       Target cabinet name you want deploy
  -e, --enterpriseCode=<value>    Code (name) of the enterprise to deploy
  -h, --help                      Show CLI help.
  -n, --providerUserName=<value>  OPTIONAL: For silent/scripted calls, bring cloud creds to auth against
  -p, --providerPassword=<value>  OPTIONAL: For silent/scripted calls, bring cloud creds to auth against
  -u, --version=<value>           Search string for the version of the asset to deploy  (use ? or ?? to be prompted).
  -y, --silent                    (Optional: defaults to false) Prevents confirmations of user-values that are
                                  remembered from prior runs. Requires: enterpriseCode,cabinetName

DESCRIPTION
  Deploys a given asset to a given cabinet.  Defaults to current version.

See code: src/commands/deploy.ts

codiac domain map [DOMAIN]​

Declares a strategy for mapping assets to ingress routes for a domain name.

USAGE
  $ codiac domain map [DOMAIN] [-h] [-n <value>] [-e <value> | -v <value>] [-c <value> | ] [-x]

ARGUMENTS
  DOMAIN  The domain name to route (eg: "my-company.com")

FLAGS
  -c, --cabinet=<value>      The name of the cabinet on which to apply this naming strategy.  Must be qualified by also
                             setting enterprise.  NOTE: You can leave this blank if there is only one. If cabinet names
                             are not unique, use the --enterprise/-e argument to fully qualify the cabinet name.
  -e, --enterprise=<value>   The name of the enterprise on which to apply this naming strategy. NOTE: You can leave this
                             blank if there is only one.
  -h, --help                 Show CLI help.
  -n, --naming=<value>       The host naming strategy to apply.
  -v, --environment=<value>  The name of the environment on which to apply this naming strategy. Must be qualified by
                             also setting enterprise.  NOTE: You can leave this blank if there is only one.
  -x, --noninteractive       Throws errors if user interaction is required.

DESCRIPTION
  Declares a strategy for mapping assets to ingress routes for a domain name.

ALIASES
  $ codiac domain map

codiac ent list​

Shows the list of enterprises.

USAGE
  $ codiac ent list [-o json|yaml|tree|text] [-h]

FLAGS
  -h, --help             Displays the help document for this command.
  -o, --output=<option>  [default: tree] format in which to render the data.
                         <options: json|yaml|tree|text>

DESCRIPTION
  Shows the list of enterprises.

ALIASES
  $ codiac ent list

codiac enterprise create [CODE]​

Creates a new enterprise under the current tenant.

USAGE
  $ codiac enterprise create [CODE] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h]

ARGUMENTS
  CODE  The unique human-readable identitifer to use for the enterprise (must be alphanunmeric with no spaces).

FLAGS
  -h, --help            Show CLI help.
  -v, --verbose         Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>          Fires this command with an argument list that was previously remembered using the --rememberAs
                        flag.
  --remember            Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>  Saves the given argument list so that it can be called by name.
  --unremember=<value>  Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that were
                        previously stored under the given name (use "--unRemember default" to clear default argument
                        list memorized with the --remember flag).
  --withoutdefaults     Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Creates a new enterprise under the current tenant.

codiac enterprise list​

Shows the list of enterprises.

USAGE
  $ codiac enterprise list [-o json|yaml|tree|text] [-h]

FLAGS
  -h, --help             Displays the help document for this command.
  -o, --output=<option>  [default: tree] format in which to render the data.
                         <options: json|yaml|tree|text>

DESCRIPTION
  Shows the list of enterprises.

ALIASES
  $ codiac ent list

codiac env add [SETTING]​

Adds a key value pair to the app config

USAGE
  $ codiac env add [SETTING] [-h] [-s <value>] [-v <value>] [-n <value> | -e <value> | -c <value>]

ARGUMENTS
  SETTING  The name of the environment variable to add

FLAGS
  -c, --cabinet=<value>      The name of the cabinet to which this value is to apply.
  -e, --environment=<value>  The name of the environment to which this value is to apply.
  -h, --help                 Show CLI help.
  -n, --enterprise=<value>   The name of the enterprise to which this value is to apply.
  -s, --setting=<value>      The name of the environment variable to add.
  -v, --value=<value>        The actual concrete data to be applied as the setting value.

DESCRIPTION
  Adds a key value pair to the app config

codiac enviro create [NAME]​

Initializes a cabinet for a given enterprise and environment. Overwrites any existing if forced, otherwise returns an error if the cabinet already exists.

USAGE
  $ codiac enviro create [NAME] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h]

ARGUMENTS
  NAME  The name of the environment to create

FLAGS
  -h, --help            Show CLI help.
  -v, --verbose         Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>          Fires this command with an argument list that was previously remembered using the --rememberAs
                        flag.
  --remember            Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>  Saves the given argument list so that it can be called by name.
  --unremember=<value>  Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that were
                        previously stored under the given name (use "--unRemember default" to clear default argument
                        list memorized with the --remember flag).
  --withoutdefaults     Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Initializes a cabinet for a given enterprise and environment.  Overwrites any existing if forced, otherwise returns an
  error if the cabinet already exists.

ALIASES
  $ codiac enviro create

codiac enviro list​

Shows the list of environments.

USAGE
  $ codiac enviro list [-o json|yaml|tree|text] [-h]

FLAGS
  -h, --help             Displays the help document for this command.
  -o, --output=<option>  [default: tree] format in which to render the data.
                         <options: json|yaml|tree|text>

DESCRIPTION
  Shows the list of environments.

ALIASES
  $ codiac enviro list

codiac environment create [NAME]​

Initializes a cabinet for a given enterprise and environment. Overwrites any existing if forced, otherwise returns an error if the cabinet already exists.

USAGE
  $ codiac environment create [NAME] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h]

ARGUMENTS
  NAME  The name of the environment to create

FLAGS
  -h, --help            Show CLI help.
  -v, --verbose         Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>          Fires this command with an argument list that was previously remembered using the --rememberAs
                        flag.
  --remember            Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>  Saves the given argument list so that it can be called by name.
  --unremember=<value>  Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that were
                        previously stored under the given name (use "--unRemember default" to clear default argument
                        list memorized with the --remember flag).
  --withoutdefaults     Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Initializes a cabinet for a given enterprise and environment.  Overwrites any existing if forced, otherwise returns an
  error if the cabinet already exists.

ALIASES
  $ codiac enviro create

codiac environment list​

Shows the list of environments.

USAGE
  $ codiac environment list [-o json|yaml|tree|text] [-h]

FLAGS
  -h, --help             Displays the help document for this command.
  -o, --output=<option>  [default: tree] format in which to render the data.
                         <options: json|yaml|tree|text>

DESCRIPTION
  Shows the list of environments.

ALIASES
  $ codiac enviro list

codiac fileshare capture​

Creates a reference point in the given enterprise for an existing filestore instance in a cloud provider subscription.

USAGE
  $ codiac fileshare capture [-h] [--resourceGroup <value>] [-y -e <value> -n <value> --storageAccount <value>
    --shareName <value> --providerSubscriptionId <value>  ]

FLAGS
  -e, --enterprise=<value>          The name of the enterprise in which to create this asset. (defaults to the current
                                    enterprise context)
  -h, --help                        Show CLI help.
  -n, --name=<value>                The name by which to identify this fileshare definition within the enterprise
                                    (Optional: defaults to the shareName).
  -y, --silent                      (Optional: defaults to false) Prevents confirmations of user-values that are
                                    remembered from prior runs. Requires:
                                    enterprise,name,storageAccount,shareName,providerSubscriptionId,resourceId,accessKey
  --providerSubscriptionId=<value>  The identifier of the cloud provider subscription under which the file storage
                                    account resides.
  --resourceGroup=<value>           The name of the Azure resource group under which the instance is to be created
                                    (Azure-specific).
  --shareName=<value>               The name of the fileshare to connect to within the file storage account.
  --storageAccount=<value>          The name within the cloud provider of the file storage account within which the
                                    share resides.

DESCRIPTION
  Creates a reference point in the given enterprise for an existing filestore instance in a cloud provider subscription.

ALIASES
  $ codiac fileshare capture

codiac filestore capture​

Creates a reference point in the given enterprise for an existing filestore instance in a cloud provider subscription.

USAGE
  $ codiac filestore capture [-h] [--resourceGroup <value>] [-y -e <value> -n <value> --storageAccount <value>
    --shareName <value> --providerSubscriptionId <value>  ]

FLAGS
  -e, --enterprise=<value>          The name of the enterprise in which to create this asset. (defaults to the current
                                    enterprise context)
  -h, --help                        Show CLI help.
  -n, --name=<value>                The name by which to identify this fileshare definition within the enterprise
                                    (Optional: defaults to the shareName).
  -y, --silent                      (Optional: defaults to false) Prevents confirmations of user-values that are
                                    remembered from prior runs. Requires:
                                    enterprise,name,storageAccount,shareName,providerSubscriptionId,resourceId,accessKey
  --providerSubscriptionId=<value>  The identifier of the cloud provider subscription under which the file storage
                                    account resides.
  --resourceGroup=<value>           The name of the Azure resource group under which the instance is to be created
                                    (Azure-specific).
  --shareName=<value>               The name of the fileshare to connect to within the file storage account.
  --storageAccount=<value>          The name within the cloud provider of the file storage account within which the
                                    share resides.

DESCRIPTION
  Creates a reference point in the given enterprise for an existing filestore instance in a cloud provider subscription.

ALIASES
  $ codiac fileshare capture

codiac help [COMMANDS]​

Display help for codiac.

USAGE
  $ codiac 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 codiac.

See code: @oclif/plugin-help

codiac host map [DOMAIN]​

Declares a strategy for mapping assets to ingress routes for a domain name.

USAGE
  $ codiac host map [DOMAIN] [-h] [-n <value>] [-e <value> | -v <value>] [-c <value> | ] [-x]

ARGUMENTS
  DOMAIN  The domain name to route (eg: "my-company.com")

FLAGS
  -c, --cabinet=<value>      The name of the cabinet on which to apply this naming strategy.  Must be qualified by also
                             setting enterprise.  NOTE: You can leave this blank if there is only one. If cabinet names
                             are not unique, use the --enterprise/-e argument to fully qualify the cabinet name.
  -e, --enterprise=<value>   The name of the enterprise on which to apply this naming strategy. NOTE: You can leave this
                             blank if there is only one.
  -h, --help                 Show CLI help.
  -n, --naming=<value>       The host naming strategy to apply.
  -v, --environment=<value>  The name of the environment on which to apply this naming strategy. Must be qualified by
                             also setting enterprise.  NOTE: You can leave this blank if there is only one.
  -x, --noninteractive       Throws errors if user interaction is required.

DESCRIPTION
  Declares a strategy for mapping assets to ingress routes for a domain name.

ALIASES
  $ codiac domain map

codiac identify [TOKENNAME]​

Stores an identity token for the current user, for use with a component tool (such as npm). This command acts as an upsert.

USAGE
  $ codiac identify [TOKENNAME] -t <value> [-h] [-p npm|azart|other] [-s <value>] [-r <value>] [-g <value> -e
    <value> -f <value>]

ARGUMENTS
  TOKENNAME  (optional) Conventional name (token_for_[provider]_[scope]) for the tokenized identity.  This name will
             also be used for the build environment variable carrying the token.

FLAGS
  -e, --email=<value>         (Azure Artifacts [aka: azart] only) The email address for this identity.  Npm requires for
                              this, but never uses it.
  -f, --feed=<value>          (Azure Artifacts [aka: azart] only) The human readable identifier for the package feed
  -g, --organization=<value>  (Azure Artifacts [aka: azart] only) Human readable identifier for the organization account
                              with the provider.
  -h, --help                  Renders the help document for this command.
  -p, --provider=<option>     [default: npm] The source of the token.
                              <options: npm|azart|other>
  -r, --registryUrl=<value>   The component tool that issued and can consume the token.
  -s, --scope=<value>         The subdivision within the registry for which this token is honored.
  -t, --token=<value>         (required) The actual raw token string itself issued by the provider

DESCRIPTION
  Stores an identity token for the current user, for use with a component tool (such as npm).  This command acts as an
  upsert.

ALIASES
  $ codiac identify
  $ codiac token

codiac identity [TOKENNAME]​

Stores an identity token for the current user, for use with a component tool (such as npm). This command acts as an upsert.

USAGE
  $ codiac identity [TOKENNAME] -t <value> [-h] [-p npm|azart|other] [-s <value>] [-r <value>] [-g <value> -e
    <value> -f <value>]

ARGUMENTS
  TOKENNAME  (optional) Conventional name (token_for_[provider]_[scope]) for the tokenized identity.  This name will
             also be used for the build environment variable carrying the token.

FLAGS
  -e, --email=<value>         (Azure Artifacts [aka: azart] only) The email address for this identity.  Npm requires for
                              this, but never uses it.
  -f, --feed=<value>          (Azure Artifacts [aka: azart] only) The human readable identifier for the package feed
  -g, --organization=<value>  (Azure Artifacts [aka: azart] only) Human readable identifier for the organization account
                              with the provider.
  -h, --help                  Renders the help document for this command.
  -p, --provider=<option>     [default: npm] The source of the token.
                              <options: npm|azart|other>
  -r, --registryUrl=<value>   The component tool that issued and can consume the token.
  -s, --scope=<value>         The subdivision within the registry for which this token is honored.
  -t, --token=<value>         (required) The actual raw token string itself issued by the provider

DESCRIPTION
  Stores an identity token for the current user, for use with a component tool (such as npm).  This command acts as an
  upsert.

ALIASES
  $ codiac identify
  $ codiac token

See code: src/commands/identity.ts

codiac identity delete [NAME]​

Removes an identity token from storage for the current user.

USAGE
  $ codiac identity delete [NAME] [-h]

ARGUMENTS
  NAME  The name of the token to delete.  Use the 'identity:list' command to view the currently stored tokens.

FLAGS
  -h, --help  Displays the help document for this command.

DESCRIPTION
  Removes an identity token from storage for the current user.

ALIASES
  $ codiac identity remove
  $ codiac token delete
  $ codiac token remove

codiac identity list​

Lists out the identity tokens currently stored for the current user.

USAGE
  $ codiac identity list [-h] [-o table|extended|json|csv]

FLAGS
  -h, --help             Displays the help document for this command.
  -o, --output=<option>  [default: table] Format for the response data.
                         <options: table|extended|json|csv>

DESCRIPTION
  Lists out the identity tokens currently stored for the current user.

ALIASES
  $ codiac token list

codiac identity remove [NAME]​

Removes an identity token from storage for the current user.

USAGE
  $ codiac identity remove [NAME] [-h]

ARGUMENTS
  NAME  The name of the token to delete.  Use the 'identity:list' command to view the currently stored tokens.

FLAGS
  -h, --help  Displays the help document for this command.

DESCRIPTION
  Removes an identity token from storage for the current user.

ALIASES
  $ codiac identity remove
  $ codiac token delete
  $ codiac token remove

codiac image [IMAGENAME]​

Configures a container image to be built and published by the project.

USAGE
  $ codiac image [IMAGENAME] [-h] [-i <value>] [-e <value>] [-s <value>] [-y -r <value> -p <value> -f
    <value> -u <value> ] [-b <value>]

ARGUMENTS
  IMAGENAME  image name including, scope prefix. eg:  "your-company/your-image"

FLAGS
  -b, --buildParams=<value>...
      Additional freeform arguments to apply to the Docker build command.

  -e, --environment=<value>
      (optional) Declaration that this registry shall be the target when publishing to the given environment.

  -f, --sourceFile=<value>
      Path and filename of the image definition file, relative to the project root, (eg: "./Dockerfile").  If omitted, the
      build will use an in-memory image definition auto-generated at build time.

  -h, --help
      Show CLI help.

  -i, --infoUrl=<value>
      (Optional) Address on the registry website or portal of the human-readable web page for the image.

  -p, --port=<value>
      Recommended port number to assign, in the toybox template, to an Asset defined by this image.

  -r, --registryUrl=<value>
      [default: https://index.docker.io/v1] (Optional, defaults to Docker Hub) Address of the container registry to which
      the image will be published (without protocol prefix), eg: "yourimages.azurecr.io".  NOTE: This registry will be
      used by the "publish" command, whereas when running in "local" mode, images will instead be registered to the
      built-in image registry on the local machine.  NOTE:  This url shall define the default publishing target, for use
      when publishing for any environment, unless otherwise specified.

  -s, --password=<value>
      (optional) Password credential for the given registry.  WARNING!! these username/password credentials will be stored
      in the codiac config file in this project, and therefore configuring username and password in this manner is not
      recommended!

  -u, --username=<value>
      (optional) Login credential for the given registry.  WARNING!! these username/password credentials will be stored in
      the codiac config file in this project, and therefore configuring username and password in this manner is not
      recommended!

  -y, --silent
      (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior runs. Requires:
      registryUrl,port,sourceFile,username,name

DESCRIPTION
  Configures a container image to be built and published by the project.

ALIASES
  $ codiac image
  $ codiac image add
  $ codiac img
  $ codiac img add

codiac image add [IMAGENAME]​

Configures a container image to be built and published by the project.

USAGE
  $ codiac image add [IMAGENAME] [-h] [-i <value>] [-e <value>] [-s <value>] [-y -r <value> -p <value> -f
    <value> -u <value> ] [-b <value>]

ARGUMENTS
  IMAGENAME  image name including, scope prefix. eg:  "your-company/your-image"

FLAGS
  -b, --buildParams=<value>...
      Additional freeform arguments to apply to the Docker build command.

  -e, --environment=<value>
      (optional) Declaration that this registry shall be the target when publishing to the given environment.

  -f, --sourceFile=<value>
      Path and filename of the image definition file, relative to the project root, (eg: "./Dockerfile").  If omitted, the
      build will use an in-memory image definition auto-generated at build time.

  -h, --help
      Show CLI help.

  -i, --infoUrl=<value>
      (Optional) Address on the registry website or portal of the human-readable web page for the image.

  -p, --port=<value>
      Recommended port number to assign, in the toybox template, to an Asset defined by this image.

  -r, --registryUrl=<value>
      [default: https://index.docker.io/v1] (Optional, defaults to Docker Hub) Address of the container registry to which
      the image will be published (without protocol prefix), eg: "yourimages.azurecr.io".  NOTE: This registry will be
      used by the "publish" command, whereas when running in "local" mode, images will instead be registered to the
      built-in image registry on the local machine.  NOTE:  This url shall define the default publishing target, for use
      when publishing for any environment, unless otherwise specified.

  -s, --password=<value>
      (optional) Password credential for the given registry.  WARNING!! these username/password credentials will be stored
      in the codiac config file in this project, and therefore configuring username and password in this manner is not
      recommended!

  -u, --username=<value>
      (optional) Login credential for the given registry.  WARNING!! these username/password credentials will be stored in
      the codiac config file in this project, and therefore configuring username and password in this manner is not
      recommended!

  -y, --silent
      (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior runs. Requires:
      registryUrl,port,sourceFile,username,name

DESCRIPTION
  Configures a container image to be built and published by the project.

ALIASES
  $ codiac image
  $ codiac image add
  $ codiac img
  $ codiac img add

codiac image delete IMAGENAME​

Deletes the given image export from the configuration.

USAGE
  $ codiac image delete IMAGENAME [-h]

ARGUMENTS
  IMAGENAME  image name including, scope prefix. eg:  "your-company/your-image"

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Deletes the given image export from the configuration.

ALIASES
  $ codiac image remove
  $ codiac img remove
  $ codiac image delete
  $ codiac img delete

codiac image list​

Renders the list of container images that are configured as project exports.

USAGE
  $ codiac image list [-h] [-o table|extended|json|csv]

FLAGS
  -h, --help             Show CLI help.
  -o, --output=<option>  [default: table] Format for the response data.
                         <options: table|extended|json|csv>

DESCRIPTION
  Renders the list of container images that are configured as project exports.

ALIASES
  $ codiac image list
  $ codiac img list

codiac image patch IMAGENAME​

Applies the given values to an existing image export configuration. Both registryUrl and environment act as filters to limit the operation. That is, an upsert of registry targets is performed for the given image, based on the given registryUrl and/or environment.

USAGE
  $ codiac image patch IMAGENAME [-h] [-s <value>] [-u <value>]

ARGUMENTS
  IMAGENAME  image name including, scope prefix. eg:  "your-company/your-image"

FLAGS
  -h, --help           Show CLI help.
  -s, --set=<value>    Space-delimited list of key-value pairs tp apply with json-path on the left and the desired value
                       on the right.  (eg:  --set .targets.default.registryUrl=mystuff.azurecr.io)
  -u, --unset=<value>  Space-delimited list of properties to clear, in json-path format.  (eg:  --unset
                       .targets.default)

DESCRIPTION
  Applies the given values to an existing image export configuration.  Both registryUrl and environment act as filters
  to limit the operation.  That is, an upsert of registry targets is performed for the given image, based on the given
  registryUrl and/or environment.

ALIASES
  $ codiac image patch
  $ codiac img patch

codiac image remove IMAGENAME​

Deletes the given image export from the configuration.

USAGE
  $ codiac image remove IMAGENAME [-h]

ARGUMENTS
  IMAGENAME  image name including, scope prefix. eg:  "your-company/your-image"

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Deletes the given image export from the configuration.

ALIASES
  $ codiac image remove
  $ codiac img remove
  $ codiac image delete
  $ codiac img delete

codiac imageRegistry capture​

Upserts the primary and secondary pull secret references for the given container registry.

USAGE
  $ codiac imageRegistry capture [-u <value>] [-p aws|azure|dockerHub|other] [-s <value>] [-l <value>] [-z] [-y    -n
    <value>] [-h]

FLAGS
  -h, --help                    Show CLI help.
  -l, --location=<value>        The data center in which the registry resides (use the code name, eg: in Aws use
                                'us-east-1', NOT 'Virginia, US').
  -n, --name=<value>            The resource name of the container registry within the cloud provider subscription.
  -p, --provider=<option>       The cloud provider hosting the container registry.
                                <options: aws|azure|dockerHub|other>
  -s, --subscriptionId=<value>  The id of the cloud provider account in which the registry resides.
  -u, --url=<value>             The container registry url.
  -y, --silent                  (Optional: defaults to false) Prevents confirmations of user-values that are remembered
                                from prior runs. Requires: registry,storeType,storeName,name
  -z, --toScript                Outputs an assembled command string, NO execution

DESCRIPTION
  Upserts the primary and secondary pull secret references for the given container registry.

ALIASES
  $ codiac pullsecret unset

codiac imageRegistry forget​

Removes the reference to the given container registry for the tenant. Does NOT delete the registry itself.

USAGE
  $ codiac imageRegistry forget [-z] [-y -r <value>] [-h]

FLAGS
  -h, --help              Show CLI help.
  -r, --registry=<value>  The container registry to forget.
  -y, --silent            (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
                          prior runs. Requires: registry
  -z, --toScript          Outputs an assembled command string, NO execution

DESCRIPTION
  Removes the reference to the given container registry for the tenant.  Does NOT delete the registry itself.

codiac imageRegistry pullSecret set​

Upserts the primary and secondary pull secret references for the given container registry.

USAGE
  $ codiac imageRegistry pullSecret set [-f primary|secondary] [-z] [-y [-r <value> | ] -t
    awsKeyVault|azBlob|azKeyVault|etcd|mongoCollection|mongoDocument -s <value> -n <value>] [-h]

FLAGS
  -f, --item=<option>       [default: primary] Applies the command to either the primary (default) or seoncdary secret
                            for the image registry.
                            <options: primary|secondary>
  -h, --help                Show CLI help.
  -n, --name=<value>        The name of the secret within the secret store.
  -r, --registry=<value>    The container registry in which the image exists (defaults to docker hub).
  -s, --storeName=<value>   The name of the secret store containing the actual pull secrets.
  -t, --storeType=<option>  The type of secret store containing the actual pull secrets.
                            <options: awsKeyVault|azBlob|azKeyVault|etcd|mongoCollection|mongoDocument>
  -y, --silent              (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
                            prior runs. Requires: registry,storeType,storeName,name
  -z, --toScript            Outputs an assembled command string, NO execution

DESCRIPTION
  Upserts the primary and secondary pull secret references for the given container registry.

ALIASES
  $ codiac pullsecret

codiac imageRegistry pullSecret unset​

Removes the primary or secondary pull secret reference for the given container registry.

USAGE
  $ codiac imageRegistry pullSecret unset [-f primary|secondary] [-z] [-y [-r <value> | ]   ] [-h]

FLAGS
  -f, --item=<option>     [default: primary] Applies the command to either the primary (default) or seoncdary secret for
                          the image registry.
                          <options: primary|secondary>
  -h, --help              Show CLI help.
  -r, --registry=<value>  The container registry in which the image exists (defaults to docker hub).
  -y, --silent            (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
                          prior runs. Requires: registry,storeType,storeName,name
  -z, --toScript          Outputs an assembled command string, NO execution

DESCRIPTION
  Removes the primary or secondary pull secret reference for the given container registry.

ALIASES
  $ codiac pullsecret unset

codiac images add [IMAGENAME]​

Configures a container image to be built and published by the project.

USAGE
  $ codiac images add [IMAGENAME] [-h] [-i <value>] [-e <value>] [-s <value>] [-y -r <value> -p <value> -f
    <value> -u <value> ] [-b <value>]

ARGUMENTS
  IMAGENAME  image name including, scope prefix. eg:  "your-company/your-image"

FLAGS
  -b, --buildParams=<value>...
      Additional freeform arguments to apply to the Docker build command.

  -e, --environment=<value>
      (optional) Declaration that this registry shall be the target when publishing to the given environment.

  -f, --sourceFile=<value>
      Path and filename of the image definition file, relative to the project root, (eg: "./Dockerfile").  If omitted, the
      build will use an in-memory image definition auto-generated at build time.

  -h, --help
      Show CLI help.

  -i, --infoUrl=<value>
      (Optional) Address on the registry website or portal of the human-readable web page for the image.

  -p, --port=<value>
      Recommended port number to assign, in the toybox template, to an Asset defined by this image.

  -r, --registryUrl=<value>
      [default: https://index.docker.io/v1] (Optional, defaults to Docker Hub) Address of the container registry to which
      the image will be published (without protocol prefix), eg: "yourimages.azurecr.io".  NOTE: This registry will be
      used by the "publish" command, whereas when running in "local" mode, images will instead be registered to the
      built-in image registry on the local machine.  NOTE:  This url shall define the default publishing target, for use
      when publishing for any environment, unless otherwise specified.

  -s, --password=<value>
      (optional) Password credential for the given registry.  WARNING!! these username/password credentials will be stored
      in the codiac config file in this project, and therefore configuring username and password in this manner is not
      recommended!

  -u, --username=<value>
      (optional) Login credential for the given registry.  WARNING!! these username/password credentials will be stored in
      the codiac config file in this project, and therefore configuring username and password in this manner is not
      recommended!

  -y, --silent
      (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior runs. Requires:
      registryUrl,port,sourceFile,username,name

DESCRIPTION
  Configures a container image to be built and published by the project.

ALIASES
  $ codiac image
  $ codiac image add
  $ codiac img
  $ codiac img add

codiac images list​

Renders the list of container images that are configured as project exports.

USAGE
  $ codiac images list [-h] [-o table|extended|json|csv]

FLAGS
  -h, --help             Show CLI help.
  -o, --output=<option>  [default: table] Format for the response data.
                         <options: table|extended|json|csv>

DESCRIPTION
  Renders the list of container images that are configured as project exports.

ALIASES
  $ codiac image list
  $ codiac img list

codiac images patch IMAGENAME​

Applies the given values to an existing image export configuration. Both registryUrl and environment act as filters to limit the operation. That is, an upsert of registry targets is performed for the given image, based on the given registryUrl and/or environment.

USAGE
  $ codiac images patch IMAGENAME [-h] [-s <value>] [-u <value>]

ARGUMENTS
  IMAGENAME  image name including, scope prefix. eg:  "your-company/your-image"

FLAGS
  -h, --help           Show CLI help.
  -s, --set=<value>    Space-delimited list of key-value pairs tp apply with json-path on the left and the desired value
                       on the right.  (eg:  --set .targets.default.registryUrl=mystuff.azurecr.io)
  -u, --unset=<value>  Space-delimited list of properties to clear, in json-path format.  (eg:  --unset
                       .targets.default)

DESCRIPTION
  Applies the given values to an existing image export configuration.  Both registryUrl and environment act as filters
  to limit the operation.  That is, an upsert of registry targets is performed for the given image, based on the given
  registryUrl and/or environment.

ALIASES
  $ codiac image patch
  $ codiac img patch

codiac images remove IMAGENAME​

Deletes the given image export from the configuration.

USAGE
  $ codiac images remove IMAGENAME [-h]

ARGUMENTS
  IMAGENAME  image name including, scope prefix. eg:  "your-company/your-image"

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Deletes the given image export from the configuration.

ALIASES
  $ codiac image remove
  $ codiac img remove
  $ codiac image delete
  $ codiac img delete

codiac images version NAME​

Output the local version a given image. useful for ci/cd automation.

USAGE
  $ codiac images version NAME [-h] [-o stdOut|json]

ARGUMENTS
  NAME  Image name

FLAGS
  -h, --help             Show CLI help.
  -o, --output=<option>  [default: stdOut] Format for the response data.
                         <options: stdOut|json>

DESCRIPTION
  Output the local version a given image. useful for ci/cd automation.

ALIASES
  $ codiac image list
  $ codiac img list

codiac img [IMAGENAME]​

Configures a container image to be built and published by the project.

USAGE
  $ codiac img [IMAGENAME] [-h] [-i <value>] [-e <value>] [-s <value>] [-y -r <value> -p <value> -f
    <value> -u <value> ] [-b <value>]

ARGUMENTS
  IMAGENAME  image name including, scope prefix. eg:  "your-company/your-image"

FLAGS
  -b, --buildParams=<value>...
      Additional freeform arguments to apply to the Docker build command.

  -e, --environment=<value>
      (optional) Declaration that this registry shall be the target when publishing to the given environment.

  -f, --sourceFile=<value>
      Path and filename of the image definition file, relative to the project root, (eg: "./Dockerfile").  If omitted, the
      build will use an in-memory image definition auto-generated at build time.

  -h, --help
      Show CLI help.

  -i, --infoUrl=<value>
      (Optional) Address on the registry website or portal of the human-readable web page for the image.

  -p, --port=<value>
      Recommended port number to assign, in the toybox template, to an Asset defined by this image.

  -r, --registryUrl=<value>
      [default: https://index.docker.io/v1] (Optional, defaults to Docker Hub) Address of the container registry to which
      the image will be published (without protocol prefix), eg: "yourimages.azurecr.io".  NOTE: This registry will be
      used by the "publish" command, whereas when running in "local" mode, images will instead be registered to the
      built-in image registry on the local machine.  NOTE:  This url shall define the default publishing target, for use
      when publishing for any environment, unless otherwise specified.

  -s, --password=<value>
      (optional) Password credential for the given registry.  WARNING!! these username/password credentials will be stored
      in the codiac config file in this project, and therefore configuring username and password in this manner is not
      recommended!

  -u, --username=<value>
      (optional) Login credential for the given registry.  WARNING!! these username/password credentials will be stored in
      the codiac config file in this project, and therefore configuring username and password in this manner is not
      recommended!

  -y, --silent
      (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior runs. Requires:
      registryUrl,port,sourceFile,username,name

DESCRIPTION
  Configures a container image to be built and published by the project.

ALIASES
  $ codiac image
  $ codiac image add
  $ codiac img
  $ codiac img add

codiac img add [IMAGENAME]​

Configures a container image to be built and published by the project.

USAGE
  $ codiac img add [IMAGENAME] [-h] [-i <value>] [-e <value>] [-s <value>] [-y -r <value> -p <value> -f
    <value> -u <value> ] [-b <value>]

ARGUMENTS
  IMAGENAME  image name including, scope prefix. eg:  "your-company/your-image"

FLAGS
  -b, --buildParams=<value>...
      Additional freeform arguments to apply to the Docker build command.

  -e, --environment=<value>
      (optional) Declaration that this registry shall be the target when publishing to the given environment.

  -f, --sourceFile=<value>
      Path and filename of the image definition file, relative to the project root, (eg: "./Dockerfile").  If omitted, the
      build will use an in-memory image definition auto-generated at build time.

  -h, --help
      Show CLI help.

  -i, --infoUrl=<value>
      (Optional) Address on the registry website or portal of the human-readable web page for the image.

  -p, --port=<value>
      Recommended port number to assign, in the toybox template, to an Asset defined by this image.

  -r, --registryUrl=<value>
      [default: https://index.docker.io/v1] (Optional, defaults to Docker Hub) Address of the container registry to which
      the image will be published (without protocol prefix), eg: "yourimages.azurecr.io".  NOTE: This registry will be
      used by the "publish" command, whereas when running in "local" mode, images will instead be registered to the
      built-in image registry on the local machine.  NOTE:  This url shall define the default publishing target, for use
      when publishing for any environment, unless otherwise specified.

  -s, --password=<value>
      (optional) Password credential for the given registry.  WARNING!! these username/password credentials will be stored
      in the codiac config file in this project, and therefore configuring username and password in this manner is not
      recommended!

  -u, --username=<value>
      (optional) Login credential for the given registry.  WARNING!! these username/password credentials will be stored in
      the codiac config file in this project, and therefore configuring username and password in this manner is not
      recommended!

  -y, --silent
      (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior runs. Requires:
      registryUrl,port,sourceFile,username,name

DESCRIPTION
  Configures a container image to be built and published by the project.

ALIASES
  $ codiac image
  $ codiac image add
  $ codiac img
  $ codiac img add

codiac img delete IMAGENAME​

Deletes the given image export from the configuration.

USAGE
  $ codiac img delete IMAGENAME [-h]

ARGUMENTS
  IMAGENAME  image name including, scope prefix. eg:  "your-company/your-image"

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Deletes the given image export from the configuration.

ALIASES
  $ codiac image remove
  $ codiac img remove
  $ codiac image delete
  $ codiac img delete

codiac img list​

Renders the list of container images that are configured as project exports.

USAGE
  $ codiac img list [-h] [-o table|extended|json|csv]

FLAGS
  -h, --help             Show CLI help.
  -o, --output=<option>  [default: table] Format for the response data.
                         <options: table|extended|json|csv>

DESCRIPTION
  Renders the list of container images that are configured as project exports.

ALIASES
  $ codiac image list
  $ codiac img list

codiac img patch IMAGENAME​

Applies the given values to an existing image export configuration. Both registryUrl and environment act as filters to limit the operation. That is, an upsert of registry targets is performed for the given image, based on the given registryUrl and/or environment.

USAGE
  $ codiac img patch IMAGENAME [-h] [-s <value>] [-u <value>]

ARGUMENTS
  IMAGENAME  image name including, scope prefix. eg:  "your-company/your-image"

FLAGS
  -h, --help           Show CLI help.
  -s, --set=<value>    Space-delimited list of key-value pairs tp apply with json-path on the left and the desired value
                       on the right.  (eg:  --set .targets.default.registryUrl=mystuff.azurecr.io)
  -u, --unset=<value>  Space-delimited list of properties to clear, in json-path format.  (eg:  --unset
                       .targets.default)

DESCRIPTION
  Applies the given values to an existing image export configuration.  Both registryUrl and environment act as filters
  to limit the operation.  That is, an upsert of registry targets is performed for the given image, based on the given
  registryUrl and/or environment.

ALIASES
  $ codiac image patch
  $ codiac img patch

codiac img remove IMAGENAME​

Deletes the given image export from the configuration.

USAGE
  $ codiac img remove IMAGENAME [-h]

ARGUMENTS
  IMAGENAME  image name including, scope prefix. eg:  "your-company/your-image"

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Deletes the given image export from the configuration.

ALIASES
  $ codiac image remove
  $ codiac img remove
  $ codiac image delete
  $ codiac img delete

codiac init DIRECTORY​

Declares the given folder as a project root

USAGE
  $ codiac init DIRECTORY [-h] [-c <value>] [-t <value>]

ARGUMENTS
  DIRECTORY  Path to the desired project root, relative to current directory.

FLAGS
  -c, --clone=<value>        (Optional) The git repo from which to hydrate the project folder.
  -h, --help                 Show CLI help.
  -t, --projectType=<value>  (Optional) The type of Codiac project to scaffold.

DESCRIPTION
  Declares the given folder as a project root

See code: src/commands/init.ts

codiac k9s​

Spins up the k9s cli pod viewer

USAGE
  $ codiac k9s [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Spins up the k9s cli pod viewer

ALIASES
  $ codiac view k9s
  $ codiac k9s

codiac kit create [SETTING]​

Creates a new kit from an existing asset.

USAGE
  $ codiac kit create [SETTING] [-h] [-s <value>] [-y -a <value> -e <value> -n <value>     ]

ARGUMENTS
  SETTING  The key for the config setting to add

FLAGS
  -a, --asset=<value>       The enterprise asset from which to create the kit.
  -e, --enterprise=<value>  The name of the enterprise containing the given asset. (defaults to the current enterprise
                            context)
  -h, --help                Show CLI help.
  -n, --name=<value>        Override for the name to give the new kit (Optional: defaults to the asset name).
  -s, --scope=<value>       The globally unique name for the directory in which to register the kit.  This value
                            prefixes the kit name to ensure global uniqueness (Optional: defaults to the public shared
                            library).
  -y, --silent              (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
                            prior runs. Requires:
                            asset,enterprise,name,code,enterprise,port,hasIngress,routedWithoutName

DESCRIPTION
  Creates a new kit from an existing asset.

codiac login​

Codiac system login to authenticate user under a tenant.

USAGE
  $ codiac login [-h] [-t <value>] [-o -u <value> [-i | -p <value>]] [-y  ]

FLAGS
  -h, --help                Show CLI help.
  -i, --passwordIn          Reads the password directly from the standard input stream.  Enables users to avoid
                            explicitly rendering it in a command string. eg:  `cat mypass.txt | cod login -u joecool
                            --passwordIn`.  Invokes `--silent` mode, so interaction will be disabled.
  -o, --tokenOut            Writes the token as the sole stdout content (so that it is available to be piped or
                            redirected elsewhere, eg `cod login > mycodiactoken.txt`).  Leaves stdout empty on errors.
                            Invokes `--silent` mode, so interaction will be disabled.
  -p, --password=<value>    password on Codiac
  -t, --tenantCode=<value>  Human-readable Identifier for the Codiac tenant to log in under (optional: defaults to the
                            tenant code for the current project or prompts you to select one from your profile).
  -u, --username=<value>    Username on Codiac
  -y, --silent              (Optional: defaults to false) Prevents interactive user-interface and throws if interaction
                            is needed. Requires arguments: [--username -u, --passwordIn -i]

DESCRIPTION
  Codiac system login to authenticate user under a tenant.

ALIASES
  $ codiac user login

See code: src/commands/login.ts

codiac logout​

Resets the current user to anonymous and clears any local user cache.

USAGE
  $ codiac logout

DESCRIPTION
  Resets the current user to anonymous and clears any local user cache.

EXAMPLES
  $ codiac logout

See code: src/commands/logout.ts

codiac merge [BRANCH]​

Merges the given branch into the current branch of the main project and on any sourced dependencies.

USAGE
  $ codiac merge [BRANCH] [-h] [-c]

ARGUMENTS
  BRANCH  The branch name to merge into the current one.

FLAGS
  -c, --commit  Commits if merge succeeds.
  -h, --help    Show CLI help.

DESCRIPTION
  Merges the given branch into the current branch of the main project and on any sourced dependencies.

See code: src/commands/merge.ts

codiac noc cluster create [NAME]​

Provisions the physical cluster

USAGE
  $ codiac noc cluster create [NAME] [-h] [-p <value>] [-k <value>] [-u <value>] [-u <value>] [-y <value> -s <value> -g
    <value> -l <value> -n <value> -q <value>] [-t]

ARGUMENTS
  NAME  Proposed name of the cluster

FLAGS
  -g, --resourceGroup=<value>         The Azure resource group to create for the cluster.
  -h, --help                          Show CLI help.
  -k, --subnet=<value>                The resource id of the subnet in which the cluster is to be created.
  -l, --location=<value>              The short name of the azure data center in which the cliuster is to reside.
  -n, --nodeSpec=<value>              The identifier for the type of VM to use for nodes in the cluster.
  -p, --owner=<value>                 Tenant code of the private owner of the cluster
  -q, --nodeQty=<value>               The starting node count with which to create the cluster.
  -s, --providerSubscription=<value>  The Azure subscription Id under which to create the cluster.
  -t, --toScript                      Outputs an assembled command string, NO execution
  -u, --identityUserId=<value>        OPTIONAL. ID of Svc Principal or Managed Identity to execute as. To create k8s
                                      cluster, IP address, and container Pull.  If none supplied Codiac will try to
                                      create one.
  -u, --identityUserName=<value>      OPTIONAL. Name of Svc Principal or Managed Identity to execute as. To create k8s
                                      cluster, IP address, and container Pull.  If none supplied Codiac will try to
                                      create one.
  -y, --silent=<value>                (Optional: defaults to false) Prevents confirmations of user-values. Required:
                                      providerSubscription,resourceGroup,location,nodeSpec,nodeQty

DESCRIPTION
  Provisions the physical cluster

ALIASES
  $ codiac cluster create

codiac noc cluster deinit [NAME]​

Deinitialization of the cluster (uninstalls the ingress controller and tls cert manager services)

USAGE
  $ codiac noc cluster deinit [NAME] [-h] [-p aws|azure|dockerHub|other] [-y -n <value>]

ARGUMENTS
  NAME  Name of existing cluster.

FLAGS
  -h, --help               Show CLI help.
  -n, --name=<value>       Name of the cluster.
  -p, --provider=<option>  Code for the cloud service provider.
                           <options: aws|azure|dockerHub|other>
  -y, --silent             (Optional: defaults to false) Prevents interactive user-interface and throws if interaction
                           is needed. Requires arguments: [--name -n]

DESCRIPTION
  Deinitialization of the cluster (uninstalls the ingress controller and tls cert manager services)

ALIASES
  $ codiac cluster deinit

codiac noc cluster destroy [NAME]​

Kills the physical cluster, but not the Codiac cluster definition record

USAGE
  $ codiac noc cluster destroy [NAME] [-h] [-p] [-i] [-p azure|aws|dockerHub|other] [-y -n <value>]

ARGUMENTS
  NAME  Proposed name of the cluster

FLAGS
  -h, --help               Show CLI help.
  -i, --deleteIdentity     (optional: defaults to false) Ensures that identity security account for the cluster shall
                           also be deleted after the cluster itself is destroyed.
  -n, --name=<value>       Name of the cluster.
  -p, --partials           Include clusters that were never fully created.
  -p, --provider=<option>  Code for the cloud service provider.
                           <options: azure|aws|dockerHub|other>
  -y, --silent             (Optional: defaults to false) Prevents confirmations of user-values. Required: name

DESCRIPTION
  Kills the physical cluster, but not the Codiac cluster definition record

ALIASES
  $ codiac cluster destroy

codiac noc cluster forget​

Permanently removes the record of a cluster. This command does NOT affect any infrastructure; it simply removes the cluster from the Codiac consciousness. Use cod cluster capture to re-acquire an existing but forgotten cluster. You must remove all cabinets and environments in a cluster before forgetting it.

USAGE
  $ codiac noc cluster forget [-y -n <value> -p azure|aws|dockerHub|other]

FLAGS
  -n, --name=<value>       Name of the cluster.
  -p, --provider=<option>  Code for the cloud service provider.
                           <options: azure|aws|dockerHub|other>
  -y, --silent             (Optional: defaults to false) Prevents confirmations of user-values. Required: ["name",
                           "provider"]

DESCRIPTION
  Permanently removes the record of a cluster.  This command does NOT affect any infrastructure; it simply removes the
  cluster from the Codiac consciousness.  Use `cod cluster capture` to re-acquire an existing but forgotten cluster.
  You must remove all cabinets and environments in a cluster before forgetting it.

ALIASES
  $ codiac cluster forget

codiac noc cluster grant [NAME]​

(AWS Only) Provides cluster access to the given user.

USAGE
  $ codiac noc cluster grant [NAME] [-h] [-y -c <value> -u <value>]

ARGUMENTS
  NAME  Proposed name of the cluster

FLAGS
  -c, --cluster=<value>  Name of the cluster.
  -h, --help             Show CLI help.
  -u, --user=<value>     AWS usernames (as email) to add.
  -y, --silent           (Optional: defaults to false) Prevents confirmations of user-values.

DESCRIPTION
  (AWS Only) Provides cluster access to the given user.

ALIASES
  $ codiac cluster grant

codiac noc cluster init [NAME]​

Post-create initialization for the cluster (installs the ingress controller service)

USAGE
  $ codiac noc cluster init [NAME] [-h] [-p azure|aws|dockerHub|other] [-y -n <value>]

ARGUMENTS
  NAME  Name of existing cluster to initialize.

FLAGS
  -h, --help               Show CLI help.
  -n, --name=<value>       Name of the cluster.
  -p, --provider=<option>  Code for the cloud service provider.
                           <options: azure|aws|dockerHub|other>
  -y, --silent             (Optional: defaults to false) Prevents interactive user-interface and throws if interaction
                           is needed. Requires arguments: [--name -n]

DESCRIPTION
  Post-create initialization for the cluster (installs the ingress controller service)

ALIASES
  $ codiac cluster init

codiac noc cluster list​

Shows the list of clusters.

USAGE
  $ codiac noc cluster list [-o text|tree|json|yaml] [-h]

FLAGS
  -h, --help             Displays the help document for this command.
  -o, --output=<option>  [default: tree] format in which to render the data.
                         <options: text|tree|json|yaml>

DESCRIPTION
  Shows the list of clusters.

ALIASES
  $ codiac cluster list

codiac noc cluster recreate [NAME]​

Provisions the physical cluster using the existing ClusterDef record (with any changes provided by the caller).

USAGE
  $ codiac noc cluster recreate [NAME] [-h] [-p <value>] [-s <value>] [-g <value>] [-l <value>] [-k <value>] [-v <value>]
    [-w -n <value> -q <value>] [--identityName <value>] [-y] [-t]

ARGUMENTS
  NAME  Name of an existing cluster to re-create

FLAGS
  -g, --resourceGroup=<value>         The Azure resource group to create for the cluster.
  -h, --help                          Show CLI help.
  -k, --subnet=<value>                The resource id of the subnet in which the cluster is to be created.
  -l, --location=<value>              The short name of the azure data center in which the cliuster is to reside.
  -n, --nodeSpec=<value>              The identifier for the type of VM to use for nodes in the cluster.
  -p, --owner=<value>                 Tenant code of the private owner of the cluster
  -q, --nodeQty=<value>               The starting node count with which to create the cluster.
  -s, --providerSubscription=<value>  The Azure subscription Id under which to create the cluster.
  -t, --toScript                      Outputs an assembled command string, NO execution
  -v, --k8sVersion=<value>            The Kubernetes version for the new cluster.  This must be a supported version from
                                      the cloud provider.
  -w, --windowsSupport                Add a windows nodepool.
  -y, --silent                        (Optional: defaults to false) Prevents confirmations of user-values. Required:
  --identityName=<value>              name of an existing service principal to use for the cluster identity

DESCRIPTION
  Provisions the physical cluster using the existing ClusterDef record (with any changes provided by the caller).

ALIASES
  $ codiac cluster recreate

codiac pkg add [DEFINITIONFILE]​

Configures a package to be built and published by the project.

USAGE
  $ codiac pkg add [DEFINITIONFILE] [-h] [-r <value>] [-e <value>] [-u <value>] [-s <value>]

ARGUMENTS
  DEFINITIONFILE  Path and filename of the package definition file, relative to the codiac project root, (eg:
                  "./package.json")

FLAGS
  -e, --environment=<value>  (optional) Declaration that this registry shall be the target when publishing to the given
                             environment.
  -h, --help                 Show CLI help.
  -r, --registryUrl=<value>  Address of the registry to which the package will be published (without protocol prefix),
                             eg: "yourpackages.azurecr.io".  NOTE: This registry will be used by the "codiac publish"
                             command, whereas when running in "local" mode, packages will instead be registered to the
                             built-in package registry on the local machine.  NOTE:  This url shall define the default
                             publishing target, for use when publishing for any environment, unless otherwise specified.
  -s, --password=<value>     (optional) Password credential for the given registry.  WARNING!! these username/password
                             credentials will be stored in the codiac config file in this project, and therefore
                             configuring username and password in this manner is not recommended!
  -u, --username=<value>     (optional) Login credential for the given registry.  WARNING!! these username/password
                             credentials will be stored in the codiac config file in this project, and therefore
                             configuring username and password in this manner is not recommended!

DESCRIPTION
  Configures a package to be built and published by the project.

codiac pkg delete [PACKAGENAME]​

Deletes the given package export from the configuration.

USAGE
  $ codiac pkg delete [PACKAGENAME] [-h]

ARGUMENTS
  PACKAGENAME  package name including, scope prefix. eg:  "your-company/your-package"

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Deletes the given package export from the configuration.

ALIASES
  $ codiac pkg delete

codiac pkg list​

Renders the list of packages that are configured as project exports.

USAGE
  $ codiac pkg list [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Renders the list of packages that are configured as project exports.

codiac pkg patch PACKAGENAME​

Applies the given values to an existing package export configuration. Both registryUrl and environment act as filters to limit the operation. That is, an upsert of registry targets is performed for the given package, based on the given registryUrl and/or environment.

USAGE
  $ codiac pkg patch PACKAGENAME [-h] [-s <value>] [-u <value>]

ARGUMENTS
  PACKAGENAME  package name including, scope prefix. eg:  "your-company/your-package"

FLAGS
  -h, --help           Show CLI help.
  -s, --set=<value>    Space-delimited list of key-value pairs tp apply with json-path on the left and the desired value
                       on the right.  (eg:  --set .targets.default.registryUrl=mystuff.azurecr.io)
  -u, --unset=<value>  Space-delimited list of properties to clear, in json-path format.  (eg:  --unset
                       .targets.default)

DESCRIPTION
  Applies the given values to an existing package export configuration.  Both registryUrl and environment act as filters
  to limit the operation.  That is, an upsert of registry targets is performed for the given package, based on the given
  registryUrl and/or environment.

codiac pkg remove [PACKAGENAME]​

Deletes the given package export from the configuration.

USAGE
  $ codiac pkg remove [PACKAGENAME] [-h]

ARGUMENTS
  PACKAGENAME  package name including, scope prefix. eg:  "your-company/your-package"

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Deletes the given package export from the configuration.

ALIASES
  $ codiac pkg delete

codiac portal​

Starts the codiac relay services, maintains container instance, and opens the web app.

USAGE
  $ codiac portal

DESCRIPTION
  Starts the codiac relay services, maintains container instance, and opens the web app.

See code: src/commands/portal.ts

codiac publish [NAME]​

Publishes the exports (packages and images) declared in the ProjectConfig.

USAGE
  $ codiac publish [NAME] [-h] [-r] [-l] [-y -i <value> -u <value> -p <value>] [-o] [-i]

ARGUMENTS
  NAME  The official unique name of a currently sourced dependency.  Applies the command to ONLY this sourced
        dependency.

FLAGS
  -h, --help              Show CLI help.
  -i, --image=<value>...  (optional, defaults to all) Limits the list of images to publish.  Value must match the name
                          property of an image export defined in the codiac project file (codiac.json)
  -i, --includeDeps       Also performs the operation on any currently source dependencies.
  -l, --local             Publishes to the local built-in image registry.  NOTE: this setting gets remembered and is
                          used for subsequent calls unless otherwise specified.
  -o, --only              Applies the command only the sourced dependencies selected from a prompt. Quits if no
                          dependencies are currently sourced.
  -p, --password=<value>  (optional, prompts as needed) Password or token at the target registry.
  -r, --remote            Publishes to the remote image registry.  NOTE: this setting gets remembered and is used for
                          subsequent calls unless otherwise specified.
  -u, --username=<value>  (optional, prompts as needed) Username at the target registry.
  -y, --silent            Suppresses user dialogue.

DESCRIPTION
  Publishes the exports (packages and images) declared in the ProjectConfig.

See code: src/commands/publish.ts

codiac pull [NAME]​

Pulls all commits from upstream to local.

USAGE
  $ codiac pull [NAME] [-h] [-o] [-i]

ARGUMENTS
  NAME  The official unique name of a currently sourced dependency.  Applies the command to ONLY this sourced
        dependency.

FLAGS
  -h, --help         Show CLI help.
  -i, --includeDeps  Also performs the operation on any currently source dependencies.
  -o, --only         Applies the command only the sourced dependencies selected from a prompt. Quits if no dependencies
                     are currently sourced.

DESCRIPTION
  Pulls all commits from upstream to local.

See code: src/commands/pull.ts

codiac pullsecret​

Upserts the primary and secondary pull secret references for the given container registry.

USAGE
  $ codiac pullsecret [-f primary|secondary] [-z] [-y [-r <value> | ] -t
    awsKeyVault|azBlob|azKeyVault|etcd|mongoCollection|mongoDocument -s <value> -n <value>] [-h]

FLAGS
  -f, --item=<option>       [default: primary] Applies the command to either the primary (default) or seoncdary secret
                            for the image registry.
                            <options: primary|secondary>
  -h, --help                Show CLI help.
  -n, --name=<value>        The name of the secret within the secret store.
  -r, --registry=<value>    The container registry in which the image exists (defaults to docker hub).
  -s, --storeName=<value>   The name of the secret store containing the actual pull secrets.
  -t, --storeType=<option>  The type of secret store containing the actual pull secrets.
                            <options: awsKeyVault|azBlob|azKeyVault|etcd|mongoCollection|mongoDocument>
  -y, --silent              (Optional: defaults to false) Prevents confirmations of user-values that are remembered from
                            prior runs. Requires: registry,storeType,storeName,name
  -z, --toScript            Outputs an assembled command string, NO execution

DESCRIPTION
  Upserts the primary and secondary pull secret references for the given container registry.

ALIASES
  $ codiac pullsecret

codiac pullsecret unset​

Upserts the primary and secondary pull secret references for the given container registry.

USAGE
  $ codiac pullsecret unset [-u <value>] [-p aws|azure|dockerHub|other] [-s <value>] [-l <value>] [-z] [-y    -n
    <value>] [-h]

FLAGS
  -h, --help                    Show CLI help.
  -l, --location=<value>        The data center in which the registry resides (use the code name, eg: in Aws use
                                'us-east-1', NOT 'Virginia, US').
  -n, --name=<value>            The resource name of the container registry within the cloud provider subscription.
  -p, --provider=<option>       The cloud provider hosting the container registry.
                                <options: aws|azure|dockerHub|other>
  -s, --subscriptionId=<value>  The id of the cloud provider account in which the registry resides.
  -u, --url=<value>             The container registry url.
  -y, --silent                  (Optional: defaults to false) Prevents confirmations of user-values that are remembered
                                from prior runs. Requires: registry,storeType,storeName,name
  -z, --toScript                Outputs an assembled command string, NO execution

DESCRIPTION
  Upserts the primary and secondary pull secret references for the given container registry.

ALIASES
  $ codiac pullsecret unset

codiac push [NAME]​

Pushes all local commits upstream.

USAGE
  $ codiac push [NAME] [-h] [-o] [-i]

ARGUMENTS
  NAME  The official unique name of a currently sourced dependency.  Applies the command to ONLY this sourced
        dependency.

FLAGS
  -h, --help         Show CLI help.
  -i, --includeDeps  Also performs the operation on any currently source dependencies.
  -o, --only         Applies the command only the sourced dependencies selected from a prompt. Quits if no dependencies
                     are currently sourced.

DESCRIPTION
  Pushes all local commits upstream.

See code: src/commands/push.ts

codiac run​

Runs the latest build of the api container locally.

USAGE
  $ codiac run [-b] [-d] [-e <value>] [-h] [-i] [-n <value>] [-m <value>] [-p <value>] [-l <value>] [-w]
    [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>] [--withoutdefaults] [-v]

FLAGS
  -b, --build                 Triggers a new local build beforehand.
  -d, --detach                Run container in background and print the container ID.
  -e, --entrypoint=<value>    Overrides the default container startup command.
  -h, --help                  Renders the help document for this command.
  -i, --interactive           Run the container interactively (in the console; dies with the console).  Use
                              -e|--entrypoint to override the startup command for the container.
  -l, --internalPort=<value>  (default: 5775) The port the application inside the container is listening on.  Sets the
                              port to which map incoming requests on the container.  This port mapping MUST match
                              whatever port number the actual application is listening on.
  -m, --mountFolder=<value>   Mounts a folder on the host as a read-write volume on the container. In format
                              "src=~/my/local/folder,dst=/root/in/container".
  -n, --network=<value>       The docker network to which the container will be attached (defaults to a network named as
                              the company code, which will be created on demand as a bridge network).
  -p, --port=<value>          (default: 5775) Sets the external port to open on the container.  That is, the port on
                              which the api will be listening to calls from outside the container.
  -v, --verbose               Renders additional logging levels (detail, trace, and debug) to the console output.
  -w, --watch                 Forces a detach run and follows log output from the container.
  --as=<value>                Fires this command with an argument list that was previously remembered using the
                              --rememberAs flag.
  --remember                  Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>        Saves the given argument list so that it can be called by name.
  --unremember=<value>        Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that
                              were previously stored under the given name (use "--unRemember default" to clear default
                              argument list memorized with the --remember flag).
  --withoutdefaults           Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Runs the latest build of the api container locally.

See code: src/commands/run.ts

codiac secretStore​

Upserts a reference to an existing secretStore.

USAGE
  $ codiac secretStore [-u <value>] [-p azure|aws|dockerHub|other] [-s <value>] [-l <value>] [-z] [-y    -n
    <value>] [-h]

FLAGS
  -h, --help                    Show CLI help.
  -l, --location=<value>        The region or data center in which the secret store resides (use the code name, eg: in
                                Aws use 'us-east-1', NOT 'Virginia, US').
  -n, --name=<value>            The resource name of the secret store within the cloud provider subscription.
  -p, --provider=<option>       The cloud provider hosting the secret store.
                                <options: azure|aws|dockerHub|other>
  -s, --subscriptionId=<value>  The id of the cloud provider account in which the secret store resides (in Aws, this is
                                the 'AccountId').
  -u, --url=<value>             The container registry url.
  -y, --silent                  (Optional: defaults to false) Prevents confirmations of user-values that are remembered
                                from prior runs. Requires: registry,storeType,storeName,name
  -z, --toScript                Outputs an assembled command string, NO execution

DESCRIPTION
  Upserts a reference to an existing secretStore.

ALIASES
  $ codiac secretStore

codiac secretStore capture​

Upserts a reference to an existing secretStore.

USAGE
  $ codiac secretStore capture [-u <value>] [-p azure|aws|dockerHub|other] [-s <value>] [-l <value>] [-z] [-y    -n
    <value>] [-h]

FLAGS
  -h, --help                    Show CLI help.
  -l, --location=<value>        The region or data center in which the secret store resides (use the code name, eg: in
                                Aws use 'us-east-1', NOT 'Virginia, US').
  -n, --name=<value>            The resource name of the secret store within the cloud provider subscription.
  -p, --provider=<option>       The cloud provider hosting the secret store.
                                <options: azure|aws|dockerHub|other>
  -s, --subscriptionId=<value>  The id of the cloud provider account in which the secret store resides (in Aws, this is
                                the 'AccountId').
  -u, --url=<value>             The container registry url.
  -y, --silent                  (Optional: defaults to false) Prevents confirmations of user-values that are remembered
                                from prior runs. Requires: registry,storeType,storeName,name
  -z, --toScript                Outputs an assembled command string, NO execution

DESCRIPTION
  Upserts a reference to an existing secretStore.

ALIASES
  $ codiac secretStore

codiac secretStore forget​

Removes the reference to the given container registry for the tenant. Does NOT delete the registry itself.

USAGE
  $ codiac secretStore forget [-z] [-y -n <value>] [-h]

FLAGS
  -h, --help          Show CLI help.
  -n, --name=<value>  The name of the secret store to forget.
  -y, --silent        (Optional: defaults to false) Prevents confirmations of user-values that are remembered from prior
                      runs. Requires: name
  -z, --toScript      Outputs an assembled command string, NO execution

DESCRIPTION
  Removes the reference to the given container registry for the tenant.  Does NOT delete the registry itself.

codiac stage [FILES]​

Flags files to be included in the next commit.

USAGE
  $ codiac stage [FILES] [-h] [-A] [-c <value>]

ARGUMENTS
  FILES  Space-separated list of files to stage. Paths are relative to the main project root.

FLAGS
  -A, --all             Include all modified files.
  -c, --commit=message  Commit the staged changes using the given message
  -h, --help            Show CLI help.

DESCRIPTION
  Flags files to be included in the next commit.

See code: src/commands/stage.ts

codiac stash [FILE]​

describe the command here

USAGE
  $ codiac stash [FILE] [-h] [-n <value>] [-f]

ARGUMENTS
  FILE  path to the file to stash.

FLAGS
  -f, --force
  -h, --help          Show CLI help.
  -n, --name=<value>  name to print

DESCRIPTION
  describe the command here

See code: src/commands/stash.ts

codiac status​

Shows the current uncommitted changes in the current branch.

USAGE
  $ codiac status [-h] [-s] [-u]

FLAGS
  -h, --help      Show CLI help.
  -s, --staged    Include the list of staged changes.
  -u, --unstaged  Include the list of unstaged changes.

DESCRIPTION
  Shows the current uncommitted changes in the current branch.

See code: src/commands/status.ts

codiac stop​

Stops the running container for this project

USAGE
  $ codiac stop [-h] [-r]

FLAGS
  -h, --help    Show CLI help.
  -r, --remove  Deletes the container after stopping it

DESCRIPTION
  Stops the running container for this project

See code: src/commands/stop.ts

codiac switch [NAME]​

Changes branch on the main project and any sourced dependencies.

USAGE
  $ codiac switch [NAME] [-h]

ARGUMENTS
  NAME  The name of the branch to switch to (Optional: will prompt the user when missing).

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Changes branch on the main project and any sourced dependencies.

See code: src/commands/switch.ts

codiac sync [NAME]​

Merges the given branch into the current branch.

USAGE
  $ codiac sync [NAME] -b <value> [-h] [-o] [-i]

ARGUMENTS
  NAME  The official unique name of a currently sourced dependency.  Applies the command to ONLY this sourced
        dependency.

FLAGS
  -b, --with=<value>  (required) Branch to merge into this one
  -h, --help          Show CLI help.
  -i, --includeDeps   Also performs the operation on any currently source dependencies.
  -o, --only          Applies the command only the sourced dependencies selected from a prompt. Quits if no dependencies
                      are currently sourced.

DESCRIPTION
  Merges the given branch into the current branch.

See code: src/commands/sync.ts

codiac tenant create [NAME]​

Registers a new tenant with the current user as the administrator.

USAGE
  $ codiac tenant create [NAME] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-y -n <value> -c <value>] [-h]

ARGUMENTS
  NAME  The name of the environment to create

FLAGS
  -c, --code=<value>    (Optional, not recommended) Proposed human readable unique identifier code for the tenant
                        origanization.  This command will fail if the given tenant code is already taken.
  -h, --help            Show CLI help.
  -n, --name=<value>    Full name of the tenant organization.
  -v, --verbose         Renders additional logging levels (detail, trace, and debug) to the console output.
  -y, --silent          Suppresses user interaction.
  --as=<value>          Fires this command with an argument list that was previously remembered using the --rememberAs
                        flag.
  --remember            Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>  Saves the given argument list so that it can be called by name.
  --unremember=<value>  Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that were
                        previously stored under the given name (use "--unRemember default" to clear default argument
                        list memorized with the --remember flag).
  --withoutdefaults     Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Registers a new tenant with the current user as the administrator.

codiac tenant switch [NAME]​

Sets a different tenant context from the current user's list of tenants.

USAGE
  $ codiac tenant switch [NAME] [--as <value>] [--remember] [--rememberAs <value>] [--unremember <value>]
    [--withoutdefaults] [-v] [-h]

ARGUMENTS
  NAME  The name of the environment to create

FLAGS
  -h, --help            Show CLI help.
  -v, --verbose         Renders additional logging levels (detail, trace, and debug) to the console output.
  --as=<value>          Fires this command with an argument list that was previously remembered using the --rememberAs
                        flag.
  --remember            Saves the arguments, so they are invoked as defaults whenever this command gets called.
  --rememberAs=<value>  Saves the given argument list so that it can be called by name.
  --unremember=<value>  Administrative only: DOES NOT fire the actual command.  Simply clears the arguments that were
                        previously stored under the given name (use "--unRemember default" to clear default argument
                        list memorized with the --remember flag).
  --withoutdefaults     Prevents any relevant saved defaults from being invoked for this call.

DESCRIPTION
  Sets a different tenant context from the current user's list of tenants.

codiac token [TOKENNAME]​

Stores an identity token for the current user, for use with a component tool (such as npm). This command acts as an upsert.

USAGE
  $ codiac token [TOKENNAME] -t <value> [-h] [-p npm|azart|other] [-s <value>] [-r <value>] [-g <value> -e
    <value> -f <value>]

ARGUMENTS
  TOKENNAME  (optional) Conventional name (token_for_[provider]_[scope]) for the tokenized identity.  This name will
             also be used for the build environment variable carrying the token.

FLAGS
  -e, --email=<value>         (Azure Artifacts [aka: azart] only) The email address for this identity.  Npm requires for
                              this, but never uses it.
  -f, --feed=<value>          (Azure Artifacts [aka: azart] only) The human readable identifier for the package feed
  -g, --organization=<value>  (Azure Artifacts [aka: azart] only) Human readable identifier for the organization account
                              with the provider.
  -h, --help                  Renders the help document for this command.
  -p, --provider=<option>     [default: npm] The source of the token.
                              <options: npm|azart|other>
  -r, --registryUrl=<value>   The component tool that issued and can consume the token.
  -s, --scope=<value>         The subdivision within the registry for which this token is honored.
  -t, --token=<value>         (required) The actual raw token string itself issued by the provider

DESCRIPTION
  Stores an identity token for the current user, for use with a component tool (such as npm).  This command acts as an
  upsert.

ALIASES
  $ codiac identify
  $ codiac token

codiac token delete [NAME]​

Removes an identity token from storage for the current user.

USAGE
  $ codiac token delete [NAME] [-h]

ARGUMENTS
  NAME  The name of the token to delete.  Use the 'identity:list' command to view the currently stored tokens.

FLAGS
  -h, --help  Displays the help document for this command.

DESCRIPTION
  Removes an identity token from storage for the current user.

ALIASES
  $ codiac identity remove
  $ codiac token delete
  $ codiac token remove

codiac token list​

Lists out the identity tokens currently stored for the current user.

USAGE
  $ codiac token list [-h] [-o table|extended|json|csv]

FLAGS
  -h, --help             Displays the help document for this command.
  -o, --output=<option>  [default: table] Format for the response data.
                         <options: table|extended|json|csv>

DESCRIPTION
  Lists out the identity tokens currently stored for the current user.

ALIASES
  $ codiac token list

codiac token remove [NAME]​

Removes an identity token from storage for the current user.

USAGE
  $ codiac token remove [NAME] [-h]

ARGUMENTS
  NAME  The name of the token to delete.  Use the 'identity:list' command to view the currently stored tokens.

FLAGS
  -h, --help  Displays the help document for this command.

DESCRIPTION
  Removes an identity token from storage for the current user.

ALIASES
  $ codiac identity remove
  $ codiac token delete
  $ codiac token remove

codiac unstage [FILES]​

Flags files to be included in the next commit.

USAGE
  $ codiac unstage [FILES] [-h] [-A]

ARGUMENTS
  FILES  Space-separated list of files to stage. Paths are relative to the main project root.

FLAGS
  -A, --all   Include all modified files.
  -h, --help  Show CLI help.

DESCRIPTION
  Flags files to be included in the next commit.

See code: src/commands/unstage.ts

codiac update [CHANNEL]​

update the codiac CLI

USAGE
  $ codiac 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 codiac CLI

EXAMPLES
  Update to the stable channel:

    $ codiac update stable

  Update to a specific version:

    $ codiac update --version 1.0.0

  Interactively select version:

    $ codiac update --interactive

  See available versions:

    $ codiac update --available

See code: @oclif/plugin-update

codiac user login​

Codiac system login to authenticate user under a tenant.

USAGE
  $ codiac user login [-h] [-t <value>] [-o -u <value> [-i | -p <value>]] [-y  ]

FLAGS
  -h, --help                Show CLI help.
  -i, --passwordIn          Reads the password directly from the standard input stream.  Enables users to avoid
                            explicitly rendering it in a command string. eg:  `cat mypass.txt | cod login -u joecool
                            --passwordIn`.  Invokes `--silent` mode, so interaction will be disabled.
  -o, --tokenOut            Writes the token as the sole stdout content (so that it is available to be piped or
                            redirected elsewhere, eg `cod login > mycodiactoken.txt`).  Leaves stdout empty on errors.
                            Invokes `--silent` mode, so interaction will be disabled.
  -p, --password=<value>    password on Codiac
  -t, --tenantCode=<value>  Human-readable Identifier for the Codiac tenant to log in under (optional: defaults to the
                            tenant code for the current project or prompts you to select one from your profile).
  -u, --username=<value>    Username on Codiac
  -y, --silent              (Optional: defaults to false) Prevents interactive user-interface and throws if interaction
                            is needed. Requires arguments: [--username -u, --passwordIn -i]

DESCRIPTION
  Codiac system login to authenticate user under a tenant.

ALIASES
  $ codiac user login

codiac user show​

Renders the codiac username and its current tenant.

USAGE
  $ codiac user show

DESCRIPTION
  Renders the codiac username and its current tenant.

ALIASES
  $ codiac user show

codiac version​

USAGE
  $ codiac version [--json] [--verbose]

FLAGS
  --verbose  Show additional information about the CLI.

GLOBAL FLAGS
  --json  Format output as json.

FLAG DESCRIPTIONS
  --verbose  Show additional information about the CLI.

    Additionally shows the architecture, node version, operating system, and versions of plugins that the CLI is using.

See code: @oclif/plugin-version

codiac view dash​

Spins up the dashboard for a given cabinet

USAGE
  $ codiac view dash [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Spins up the dashboard for a given cabinet

ALIASES
  $ codiac view dash
  $ codiac dash

codiac view dashboard​

Spins up the dashboard for a given cabinet

USAGE
  $ codiac view dashboard [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Spins up the dashboard for a given cabinet

ALIASES
  $ codiac view dash
  $ codiac dash

codiac view k9s​

Spins up the k9s cli pod viewer

USAGE
  $ codiac view k9s [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Spins up the k9s cli pod viewer

ALIASES
  $ codiac view k9s
  $ codiac k9s

codiac view pods​

Spins up the k9s cli pod viewer

USAGE
  $ codiac view pods [-h]

FLAGS
  -h, --help  Show CLI help.

DESCRIPTION
  Spins up the k9s cli pod viewer

ALIASES
  $ codiac view k9s
  $ codiac k9s

codiac whereami​

Renders the current cabinet context the image project is pointed to. ie: Tenant, Enterprise, Environment, Cabinet.

USAGE
  $ codiac whereami [-h] [-n <value>] [-f]

FLAGS
  -f, --force
  -h, --help          Show CLI help.
  -n, --name=<value>  name to print

DESCRIPTION
  Renders the current cabinet context the image project is pointed to.  ie:  Tenant, Enterprise, Environment, Cabinet.

See code: src/commands/whereami.ts

codiac whoami​

Renders the codiac username and its current tenant.

USAGE
  $ codiac whoami

DESCRIPTION
  Renders the codiac username and its current tenant.

ALIASES
  $ codiac user show

See code: src/commands/whoami.ts