Codiac CLI Command Reference

A comprehensive list of the commands, flags, features, and examples for the Codiac CLI tool.

tip

The codiac command is automatically aliased to cod to save typing. For example, you can type cod -h instead of codiac -h.

Install

See our CLI Setup guide to learn how to install and manage the Codiac CLI.

Help

Use the -h flag to view the help documentation for the CLI commands. For example:

codiac -h
codiac asset -h
codiac asset view -h

codiac asset

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

USAGE $ codiac asset COMMAND

TOPICS
  asset probe   Declares the implementation of a health or readiness probe for an asset.
  asset volume  Declares a named path for mounting a volume to instances of the asset.

COMMANDS
  asset create      Creates a new asset in the given enterprise from an image that exists in a
                    container registry.
  asset get         Renders a selected type of content for an asset
  asset list        Shows the list of assets in a given enterprise.
  asset mon         Renders a selected type of content for an asset
  asset monitor     Renders a selected type of content for an asset
  asset new         Creates a new asset in the given enterprise from an image that exists in a
                    container registry.
  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.
  asset recycle     Deploys a given asset to a given cabinet.  Defaults to current version.
  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.
  asset view        Renders a selected type of content for an asset
  asset where       Shows the cabinets to which the given asset is currently deployed and which version
                    is where.

codiac asset create

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

codiac asset deploy

codiac asset deploy

Deploys a given asset to a given cabinet.

USAGE
  $ codiac asset deploy [-h] [-e <value>] [-m any|all|none [-t <value> | -c <value>]] [-u
    <value> -a <value>] [-n <value>] [-p <value>] [--take-defaults | [--silent | --echo |
    --to-script]]

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.

  -m, --tagMatch=<option>
      (Optional: Defaults to any) Declares the logic that will be used to select cabinets from the given
      tags.
      <options: any|all|none>

  -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

  -t, --tag=<value>...
      Cabinet tags with which to declare the target cabinet (instead of by name).

  -u, --version=<value>
      Search string for the version of the asset to deploy  (use ? or ?? to be prompted).

  --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.

codiac asset edit

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)
  -n, --name=<value>        The name of the asset to edit.
  --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

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'

COMMANDS
  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)).
  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)).

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'

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

codiac asset helm

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

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 obliterate

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

codiac asset probe create

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 undeploy

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] [-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.

codiac asset view

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 env|filestore|footprint|helm|annotation|label|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: env|filestore|footprint|helm|annotation|label|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 volume add

codiac asset volume add [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 volume delete

codiac asset vol delete 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 volume list

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 where

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

codiac auth

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 COMMAND

TOPICS
  auth cabinet
      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).

  auth enterprise
      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).

  auth environment
      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).

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

  auth user
      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.

COMMANDS
  auth register  Create your own user account.

codiac auth environment

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 COMMAND

TOPICS
  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).

COMMANDS
  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).
  auth environment allowed  Shows permissions for each security role on the given environment entity.

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

COMMANDS
  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).

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

codiac auth cabinet

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 COMMAND

COMMANDS
  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).
  auth cabinet allowed  Shows permissions for each security role on the given cabinet entity.

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

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

codiac auth enterprise

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 COMMAND

TOPICS
  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).

COMMANDS
  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).
  auth enterprise allowed  Shows permissions for each security role on the given enterprise entity.

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

COMMANDS
  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).

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

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

codiac auth role

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

USAGE $ codiac auth role COMMAND

COMMANDS auth role allowed Renders the privileges granted to an existing Role on each enterprise, environment, and cabinet. auth role assign Applies a Role to a user or group within the current tenant security context. auth role create 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. auth role delete 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. auth role list Retrieves the existing Roles within the current tenant security context. auth role unassign Removes a Role from a user or group within the current tenant security context.

codiac auth role allowed

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

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

codiac auth role create

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

codiac auth role delete

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

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

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

codiac auth user

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 COMMAND

COMMANDS
  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.

  auth user list
      Retrieves the existing users within the current tenant security context.

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

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

codiac autocomplete

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

codiac branch

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.

COMMANDS
  branch current  Renders the name of the current branch (for the main project and for any sourced
                  dependencies).
  branch list     Lists out existing branches for the project repo.

codiac branch current

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

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 build

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

codiac cabinet

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

USAGE
  $ codiac cabinet COMMAND

COMMANDS
  cabinet contents    Renders the list of asset versions that are currently deployed to the given
                      cabinet.
  cabinet create      Initializes a cabinet for a given enterprise and environment. Returns an error if
                      the cabinet already exists.
  cabinet list        Shows the list of cabinets and environment.
  cabinet obliterate  Hard-deletes an entire cabinet and everything in it; makes it as if the cabinet
                      itself never existed.

codiac cabinet contents

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

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

codiac cabinet create

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 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 cabinet list

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

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 cli

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).

codiac 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 COMMAND

COMMANDS
  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.
  cluster connect   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.
  cluster create    Provisions the physical cluster
  cluster deinit    Deinitialization of the cluster (uninstalls the ingress controller and tls cert
                    manager services)
  cluster destroy   Kills the physical cluster, but not the Codiac cluster definition record
  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.
  cluster grant     (AWS Only) Provides cluster access to the given user.
  cluster init      Post-create initialization for the cluster (installs the ingress controller
                    service)
  cluster journal   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.
  cluster list      Shows the list of clusters.
  cluster recreate  Provisions the physical cluster using the existing ClusterDef record (with any
                    changes provided by the caller).

codiac cluster capture

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 COMMAND

COMMANDS
  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.
  cluster connect   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.
  cluster create    Provisions the physical cluster
  cluster deinit    Deinitialization of the cluster (uninstalls the ingress controller and tls cert
                    manager services)
  cluster destroy   Kills the physical cluster, but not the Codiac cluster definition record
  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.
  cluster grant     (AWS Only) Provides cluster access to the given user.
  cluster init      Post-create initialization for the cluster (installs the ingress controller
                    service)
  cluster journal   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.
  cluster list      Shows the list of clusters.
  cluster recreate  Provisions the physical cluster using the existing ClusterDef record (with any
                    changes provided by the caller).

codiac cluster create

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

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

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

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

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

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 journal

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

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

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

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.

codiac config

Adds a key value pair to the app config

USAGE
  $ codiac config COMMAND

TOPICS
  config settings  Shows the list of clusters.

COMMANDS
  config add     Adds a key value pair to the app config
  config delete  Removes the given keys from the app config
  config deploy  Deploys a given asset to a given cabinet.  Defaults to current version.
  config import  Adds a key value pair to the app config
  config set     Adds a key value pair to the app config
  config view    Shows the values that are explicitly set in the given config

codiac config add

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

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

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

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

codiac config set [SETTING]

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
    env|filestore|footprint|helm|annotation|label|probing | -f <value>]] [--value <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: env|filestore|footprint|helm|annotation|label|probing>

  --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 view

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

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 COMMAND

COMMANDS
  csp login   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.
  csp logout  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.

codiac csp login

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

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

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

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.

COMMANDS
  dep create    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.
  dep install   installs any missing dependency packages into the local project folder.
  dep list      Shows the dependencies for the project.
  dep remove    Removes a dependency from the project.
  dep source    Loads the source code for the given dependency
  dep syncup    Publishes the dependency in its current state and upgrades to it in the main project.
  dep unsource  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.
  dep upgrade   describe the command here

codiac dep create

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

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

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

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

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 syncup

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

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 upgrade

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] [-m any|all|none [-t <value> | -c <value>]] [-a <value>] [-u
    <value>] [-w <value>] [-n <value>] [-p <value>] [-y -e <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.
  -m, --tagMatch=<option>         (Optional: Defaults to any) Declares the logic that will be used to
                                  select cabinets from the given tags.
                                  <options: any|all|none>
  -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
  -t, --tag=<value>...            Cabinet tags with which to declare the target cabinet (instead of by
                                  name).
  -u, --version=<value>           Search string for the version of the asset to deploy  (use ? or ?? to
                                  be prompted).
  -w, --tagAsset=<value>...       Tags to apply to the selected asset version.
  -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 domain map

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 enterprise

Creates a new enterprise under the current tenant.

USAGE
  $ codiac enterprise COMMAND

COMMANDS
  enterprise create  Creates a new enterprise under the current tenant.
  enterprise list    Shows the list of enterprises.

codiac enterprise create

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

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

Adds a key value pair to the app config

USAGE
  $ codiac env COMMAND

COMMANDS
  env add  Adds a key value pair to the app config

codiac environment

Includes the given cluster within the given environment. DOES NOT modify any infrastructure; only creates an association within Codiac.

USAGE
  $ codiac environment COMMAND

TOPICS
  environment cluster  Includes the given cluster within the given environment.  DOES NOT modify any
                       infrastructure; only creates an association within Codiac.

COMMANDS
  environment create  Create a new environment for a given enterprise. Returns an error if the
                      environment already exists.
  environment list    Shows the list of environments.

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 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 environment create

codiac environment add [SETTING]

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

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 environment list

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 filestore

Creates a reference point in the given enterprise for an existing filestore instance in a cloud provider subscription.

USAGE
  $ codiac filestore COMMAND

COMMANDS
  filestore capture  Creates a reference point in the given enterprise for an existing filestore
                     instance in a cloud provider subscription.
  filestore forget   Un-captures an existing filestore instance.  Does NOT delete the physical
                     filestore infrastructure itself; only the reference to it in Codiac.
  filestore list     Retrieves the list of existing file stores captured for a given enterprise.

codiac filestore 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 filestore forget

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

codiac filestore list

codiac filestore list

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

USAGE
  $ codiac filestore list [-e <value>] [-t
    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: 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

codiac help

Local command line interface for managing enterprise assets and environments.

VERSION @codiac.io/codiac-cli/1.3.60 linux-x64 node-v20.13.1

USAGE
  $ codiac [COMMAND]

TOPICS
  asset          Creates a new asset in the given enterprise from an image that exists in a container
                 registry.
  auth           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).
  branch         Creates a new branch for the parent project and any sourced dependencies.
  cabinet        Renders the list of asset versions that are currently deployed to the given cabinet.
  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.
  config         Adds a key value pair to the app config
  csp            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.
  dep            Installs a package into current project.
  enterprise     Creates a new enterprise under the current tenant.
  env            Adds a key value pair to the app config
  environment    Includes the given cluster within the given environment.  DOES NOT modify any
                 infrastructure; only creates an association within Codiac.
  filestore      Creates a reference point in the given enterprise for an existing filestore instance
                 in a cloud provider subscription.
  host           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.
  identity       Stores an identity token for the current user, for use with a component tool (such as
                 npm).  This command acts as an upsert.
  imageRegistry  Upserts the primary and secondary pull secret references for the given container
                 registry.
  images         Configures a container image to be built and published by the project.
  kit            Creates a new kit from an existing asset.
  noc            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.
  pkg            Configures a package to be built and published by the project.
  secretStore    Upserts a reference to an existing secretStore.
  tenant         Registers a new tenant with the current user as the administrator.
  version

COMMANDS
  autocomplete   display autocomplete installation instructions
  branch         Creates a new branch for the parent project and any sourced dependencies.
  build          Builds the project and the docker container
  cli            Applies settings to the Codiac CLI itself (scoped to the local machine).
  commit         Commits the currently staged changes on the current branch of the main project and on
                 any sourced dependencies.
  dep            Installs a package into current project.
  deploy         Deploys a given asset to a given cabinet.  Defaults to current version.
  help           Display help for codiac.
  identify       Stores an identity token for the current user, for use with a component tool (such as
                 npm).  This command acts as an upsert.
  identity       Stores an identity token for the current user, for use with a component tool (such as
                 npm).  This command acts as an upsert.
  image          Configures a container image to be built and published by the project.
  img            Configures a container image to be built and published by the project.
  init           Declares the given folder as a project root
  login          Codiac system login to authenticate user under a tenant.
  logout         Resets the current user to anonymous and clears any local user cache.
  merge          Merges the given branch into the current branch of the main project and on any sourced
                 dependencies.
  portal         Starts the codiac relay services, maintains container instance, and opens the web app.
  publish        Publishes the exports (packages and images) declared in the ProjectConfig.
  pull           Pulls all commits from upstream to local.
  pullsecret     Upserts the primary and secondary pull secret references for the given container
                 registry.
  push           Pushes all local commits upstream.
  relay-version  Outputs the version of the relay container used by this version of the cli.
  run            Runs the latest build of the api container locally.
  secretStore    Upserts a reference to an existing secretStore.
  stage          Flags files to be included in the next commit.
  stash          describe the command here
  status         Shows the current uncommitted changes in the current branch.
  stop           Stops the running container for this project
  switch         Changes branch on the main project and any sourced dependencies.
  sync           Merges the given branch into the current branch.
  token          Stores an identity token for the current user, for use with a component tool (such as
                 npm).  This command acts as an upsert.
  unstage        Flags files to be included in the next commit.
  update         update the codiac CLI
  version
  whereami       Renders the current cabinet context the image project is pointed to.  ie:  Tenant,
                 Enterprise, Environment, Cabinet.
  whoami         Renders the codiac username and its current tenant.

codiac host

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 COMMAND

COMMANDS
  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.
  host list    Retrieves the list of host mapping strategies defined on a given enterprise.
  host map     Declares a strategy for mapping assets to ingress routes for a domain name.
  host view    Retrieves the overall map of domain routes for the given enterprise, resulting from the
               current host mapping strategies, environments, and assets.

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_slash_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_se
      rvice|cab_dot_domain_slash_service|domain_slash_service|globally_shared_domain_slash_service|service_
      dot_domain|shared_ingress_ip|svc_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

codiac host list

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

codiac host map

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 host view

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

codiac identify

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

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

COMMANDS
  identity delete  Removes an identity token from storage for the current user.
  identity list    Lists out the identity tokens currently stored for the current user.

codiac identity delete

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

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 images

Configures a container image to be built and published by the project.

USAGE
  $ codiac images COMMAND

TOPICS
  images version  Output the local version a given image. useful for ci/cd automation.

COMMANDS
  images add      Configures a container image to be built and published by the project.
  images list     Renders the list of container images that are configured as project exports.
  images patch    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.
  images remove   Deletes the given image export from the configuration.
  images version  Output the local version a given image. useful for ci/cd automation.

codiac images add

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 (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".  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

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

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

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

COMMANDS
  images version bump  Output the local version a given image. useful for ci/cd automation.

codiac imageRegistry

Upserts the primary and secondary pull secret references for the given container registry.

USAGE
  $ codiac imageRegistry COMMAND

TOPICS
  imageRegistry pullSecret  Upserts the primary and secondary pull secret references for the given
                            container registry.

COMMANDS
  imageRegistry capture  Upserts the primary and secondary pull secret references for the given
                         container registry.
  imageRegistry forget   Removes the reference to the given container registry for the tenant.  Does
                         NOT delete the registry itself.

codiac imageRegistry capture

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

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

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

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 init

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

codiac kit

Creates a new kit from an existing asset.

USAGE
  $ codiac kit COMMAND

COMMANDS
  kit create  Creates a new kit from an existing asset.

codiac kit create

Creates a new kit from an existing asset.

USAGE
  $ codiac kit create [SETTING] [-h] [-y -a <value> -e <value> -n <value> -s <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,scope

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

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

codiac merge

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.

codiac noc

The codiac noc commands are deprecated. Please use the codiac cluster commands instead.

codiac pkg

Configures a package to be built and published by the project.

USAGE
  $ codiac pkg COMMAND

COMMANDS
  pkg add     Configures a package to be built and published by the project.
  pkg delete  Deletes the given package export from the configuration.
  pkg list    Renders the list of packages that are configured as project exports.
  pkg patch   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.
  pkg remove  Deletes the given package export from the configuration.

codiac pkg add

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

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

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

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

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.

codiac publish

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.

codiac pull

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.

codiac pullsecret

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

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

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.

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.

codiac secretStore

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

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

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 secretStore list

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

codiac stage

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.

codiac stash

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

codiac status

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.

codiac stop

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

codiac switch

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.

codiac sync

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.

codiac tenant

Registers a new tenant with the current user as the administrator.

USAGE
  $ codiac tenant COMMAND

COMMANDS
  tenant create  Registers a new tenant with the current user as the administrator.
  tenant switch  Sets a different tenant context from the current user's list of tenants.

codiac tenant create

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

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

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

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

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

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

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.

codiac update

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

codiac user

codiac user login

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

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

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.

codiac whereami

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.

codiac whoami

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