0.0.8-2 • Published 5 years ago

codiac-cli v0.0.8-2

Weekly downloads
-
License
ISC
Repository
github
Last release
5 years ago

toyhauler-cli

Local interface for registering and maintaining Toyhauler assets and pipelines

oclif Version Downloads/week License

Usage

$ npm install -g codiac-cli
$ codiac COMMAND
running command...
$ codiac (-v|--version|version)
codiac-cli/0.0.8-2 win32-x64 node-v12.16.2
$ codiac --help [COMMAND]
USAGE
  $ codiac COMMAND
...
$ npm install -g codiac-cli
$ codiac COMMAND
running command...
$ codiac (-v|--version|version)
codiac-cli/0.0.8-0 darwin-x64 node-v10.15.0
$ codiac --help [COMMAND]
USAGE
  $ codiac COMMAND
...

Commands

codiac adhoc [FILE]

describe the command here

USAGE
  $ codiac adhoc [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src\commands\adhoc.ts

codiac api:client:create

describe the command here

USAGE
  $ codiac api:client:create

OPTIONS
  -h, --help  show CLI help

codiac branch [NAME]

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

USAGE
  $ codiac branch [NAME]

ARGUMENTS
  NAME  The name of the branch to create.

OPTIONS
  -h, --help  show CLI help

See code: src\commands\branch.ts

codiac branch:current

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

USAGE
  $ codiac branch:current

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ codiac branches:current

See code: src\commands\branch\current.ts

codiac branch:list

Lists out existing branches for the project repo.

USAGE
  $ codiac branch:list

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

ALIASES
  $ codiac branches:list

See code: src\commands\branch\list.ts

codiac build [BUILDDEF]

Builds the project and the docker container

USAGE
  $ codiac build [BUILDDEF]

ARGUMENTS
  BUILDDEF  Pipe (|) separated build cmds. Replaces the default [tsc] build.

OPTIONS
  -M, --major                              Increments the version by one Major version number (using Major.Minor.Patch).
  -b, --buildDef                           Replaces the default tsc with a custom process(es).
  -c, --clear                              Completely deletes the output folder before building.

  -f, --frameworkVersion=frameworkVersion  (Future) Explicitly sets the version of the Toyhauler base image to use
                                           (default: latest).

  -h, --help                               show CLI help

  -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=(images|packages)             (optional) Prevents the building of any declared container images or
                                           packages.

  -v, --verbose                            Renders additional logging levels (detail, trace, and debug) to the console
                                           output.

  --as=as                                  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=rememberAs                  Saves the given argument list so that it can be called by name.

  --unremember=unremember                  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=version                        Overwrites the full version for the build (using Major.Minor.Patch).

  --withoutdefaults                        Prevents any relevant saved defaults from being invoked for this call.

See code: src\commands\build.ts

codiac cabinet:create CABINET

Initializes a cabinet for a given enterprise and environment. Overwrites any existing if forced, otherwise returns an error if the cabinet already exists.

USAGE
  $ codiac cabinet:create CABINET

ARGUMENTS
  CABINET  The name of the cabinet to create

OPTIONS
  -e, --environment=environment  (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=as                        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=rememberAs        Saves the given argument list so that it can be called by name.

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

ALIASES
  $ codiac cab:create

See code: src\commands\cabinet\create.ts

codiac cabinet:obliterate CABINET

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

USAGE
  $ codiac cabinet:obliterate CABINET

ARGUMENTS
  CABINET  The name of the cabinet

OPTIONS
  -e, --environment=environment  (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

  -p, --deleteIpAddress          (optional, defaults to false) Specifies that the ingress IP Address should also be
                                 deleted with the cabinet.

  -v, --verbose                  Renders additional logging levels (detail, trace, and debug) to the console output.

  --as=as                        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=rememberAs        Saves the given argument list so that it can be called by name.

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

ALIASES
  $ codiac cab:obliterate

See code: src\commands\cabinet\obliterate.ts

codiac cli

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

USAGE
  $ codiac cli

OPTIONS
  -h, --help     Show the help docs for this command.

  -s, --set=set  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.

See code: src\commands\cli.ts

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]

ARGUMENTS
  MESSAGE  The description to include in this particular commit.

OPTIONS
  -h, --help  show CLI help

See code: src\commands\commit.ts

codiac config:add [SETTING]

Adds a key value pair to the app config

USAGE
  $ codiac config:add [SETTING]

ARGUMENTS
  SETTING  The key for the config setting to add

OPTIONS
  -c, --cabinet=cabinet          The name of the cabinet to which this value is to apply.
  -e, --environment=environment  The name of the environment to which this value is to apply.
  -h, --help                     show CLI help
  -n, --enterprise=enterprise    The name of the enterprise to which this value is to apply.
  -s, --setting=setting          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.

ALIASES
  $ codiac cfg:add

See code: src\commands\config\add.ts

codiac config:delete [SETTING]

Removes the given keys from the app config

USAGE
  $ codiac config:delete [SETTING]

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

OPTIONS
  -c, --cabinet=cabinet          The name of the cabinet to which this value is to apply.
  -e, --environment=environment  The name of the environment to which this value is to apply.
  -h, --help                     show CLI help
  -n, --enterprise=enterprise    The name of the enterprise to which this value is to apply.
  -s, --setting=setting          The config key (in dotpath/JSONPath), relative to the root of the config.

ALIASES
  $ codiac cfg:delete

See code: src\commands\config\delete.ts

codiac config:view [SETTING]

Shows the values that are explicitly set in the given config

USAGE
  $ codiac config:view [SETTING]

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

OPTIONS
  -c, --cabinet=cabinet  The name of the cabinet to assemble the configuration for.

  -f, --file=file        [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

  -p, --prompt           Invokes a prompt to select from the existing settings.

ALIASES
  $ codiac cfg:view

EXAMPLES
  $ thaul config:view
  $ thaul config:view port
  $ thaul config:view -p

See code: src\commands\config\view.ts

codiac dep [NAME]

Installs a package into current project.

USAGE
  $ codiac dep [NAME]

ARGUMENTS
  NAME  The official unique name of the package to install.

OPTIONS
  -h, --help             show CLI help
  -v, --version=version  version of the package to install

See code: src\commands\dep.ts

codiac dep:create [URL]

Sources a new dependency into the project from an existing repo url, initializes it with the package repository, and publishes the initial version if it is not already. If the package repository is already initialized, the latest package version is used.

USAGE
  $ codiac dep:create [URL]

ARGUMENTS
  URL  The official clone url for the repository.

OPTIONS
  -h, --help             show CLI help
  -v, --version=version  Version to apply to the dependency package if it has not yet been initialized.

See code: src\commands\dep\create.ts

codiac dep:install

installs any missing dependency packages into the local project folder.

USAGE
  $ codiac dep:install

OPTIONS
  -h, --help  show CLI help

See code: src\commands\dep\install.ts

codiac dep:list

Shows the dependencies for the project.

USAGE
  $ codiac dep:list

OPTIONS
  -h, --help  show CLI help

See code: src\commands\dep\list.ts

codiac dep:remove [NAME]

Removes a dependency from the project.

USAGE
  $ codiac dep:remove [NAME]

ARGUMENTS
  NAME  The official unique name of the dependency package.

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

See code: src\commands\dep\remove.ts

codiac dep:source [NAME]

Loads the source code for the given dependency

USAGE
  $ codiac dep:source [NAME]

ARGUMENTS
  NAME  The official unique name of the dependency package.

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ codiac dep:src

See code: src\commands\dep\source.ts

codiac dep:syncup [DEPENDENCY]

Publishes the dependency in its current state and upgrades to it in the main project.

USAGE
  $ codiac dep:syncup [DEPENDENCY]

ARGUMENTS
  DEPENDENCY  The package name of the dependency to sync up into the main project

OPTIONS
  -h, --help  show CLI help

See code: src\commands\dep\syncup.ts

codiac dep:unsource [NAME]

Exits source mode for the given dependency by physically removing its source code folder from the project, and points the project dependency back to the package version it previously depended on.

USAGE
  $ codiac dep:unsource [NAME]

ARGUMENTS
  NAME  The official unique name of the dependency package.

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

ALIASES
  $ codiac dep:unsrc

See code: src\commands\dep\unsource.ts

codiac dep:upgrade [DEPENDENCY]

describe the command here

USAGE
  $ codiac dep:upgrade [DEPENDENCY]

ARGUMENTS
  DEPENDENCY  The dependency to upgrade

OPTIONS
  -h, --help             show CLI help
  -v, --version=version  version of the package to install

See code: src\commands\dep\upgrade.ts

codiac deploy

describe the command here

USAGE
  $ codiac deploy

OPTIONS
  -h, --help  show CLI help

See code: src\commands\deploy.ts

codiac hello [FILE]

describe the command here

USAGE
  $ codiac hello [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

EXAMPLE
  $ oclif-example hello
  hello world from ./src/hello.ts!

codiac help [COMMAND]

display help for codiac

USAGE
  $ codiac help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

codiac identity [TOKENNAME]

Stores an identity token for the current user, for use with a component tool (such as npm). This command acts as an upsert.

USAGE
  $ codiac identity [TOKENNAME]

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.

OPTIONS
  -e, --email=email                 (Azure Artifacts [aka: azart] only) The email address for this identity.  Npm
                                    requires for this, but never uses it.

  -f, --feed=feed                   (Azure Artifacts [aka: azart] only) The human readable identifier for the package
                                    feed

  -g, --organization=organization   (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=(npm|azart|other)  [default: npm] The source of the token.

  -r, --registryUrl=registryUrl     The component tool that issued and can consume the token.

  -s, --scope=scope                 The subdivision within the registry for which this token is honored.

  -t, --token=token                 (required) The actual raw token string itself issued by the provider

ALIASES
  $ codiac identify
  $ codiac token

See code: src\commands\identity.ts

codiac identity:delete [NAME]

Removes an identity token from storage for the current user.

USAGE
  $ codiac identity:delete [NAME]

ARGUMENTS
  NAME  The name of the token to delete.  Use the 'identity:list' command to view the currently stored tokens.

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

ALIASES
  $ codiac identity:remove
  $ codiac token:delete
  $ codiac token:remove

See code: src\commands\identity\delete.ts

codiac identity:list

Lists out the identity tokens currently stored for the current user.

USAGE
  $ codiac identity:list

OPTIONS
  -h, --help                              Displays the help document for this command.
  -o, --output=(table|extended|json|csv)  [default: table] Format for the response data.

ALIASES
  $ codiac token:list

See code: src\commands\identity\list.ts

codiac images:add IMAGENAME

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

USAGE
  $ codiac images:add IMAGENAME

ARGUMENTS
  IMAGENAME  image name including, scope prefix. eg:  "your-company/your-image"

OPTIONS
  -e, --environment=environment
      (optional) Declaration that this registry shall be the target when publishing to the given environment.

  -f, --sourceFile=sourceFile
      Path and filename of the image definition file, relative to the thaul project root, (eg: "./Dockerfile")

  -h, --help
      show CLI help

  -i, --infoUrl=infoUrl
      (Optional) Address on the registry website or portal of the human-readable web page for the image.

  -p, --port=port
      Recommended port number to assign, in the toybox template, to an Asset defined by this image.

  -r, --readonly
      (optional) Declares that the image already exists in a registry and is not to be built or published from this 
      project.  (eg: use this to add a mongo asset to the enterprise)

  -r, --registryUrl=registryUrl
      [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 "thaul 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=password
      (optional) Password credential for the given registry.  WARNING!! these username/password credentials will be stored 
      in the thaul config file in this project, and therefore configuring username and password in this manner is not 
      recommended!

  -u, --username=username
      (optional) Login credential for the given registry.  WARNING!! these username/password credentials will be stored in 
      the thaul config file in this project, and therefore configuring username and password in this manner is not 
      recommended!

  -w, --overwrite=(never|always|asneeded)
      (Optional, defaults to "never") Declares when the image build shall automatically create or overwrite the physical 
      definitionFile with auto-generated content.  Only applicable when definitionFile is set.

ALIASES
  $ codiac image:add
  $ codiac img:add

See code: src\commands\images\add.ts

codiac images:list [HELLO]

Renders the list of container images that are configured as project exports.

USAGE
  $ codiac images:list [HELLO]

OPTIONS
  -h, --help                              show CLI help
  -o, --output=(table|extended|json|csv)  [default: table] Format for the response data.

ALIASES
  $ codiac image:list
  $ codiac img:list

See code: src\commands\images\list.ts

codiac images:patch IMAGENAME

Applies the given values to an existing image export configuration. Both registryUrl and environment act as filters to limit the operation. That is, an upsert of registry targets is performed for the given image, based on the given registryUrl and/or environment.

USAGE
  $ codiac images:patch IMAGENAME

ARGUMENTS
  IMAGENAME  image name including, scope prefix. eg:  "your-company/your-image"

OPTIONS
  -h, --help         show CLI help

  -s, --set=set      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=unset  Space-delimited list of properties to clear, in json-path format.  (eg:  --unset .targets.default)

ALIASES
  $ codiac image:patch
  $ codiac img:patch

See code: src\commands\images\patch.ts

codiac images:remove IMAGENAME

Deletes the given image export from the configuration.

USAGE
  $ codiac images:remove IMAGENAME

ARGUMENTS
  IMAGENAME  image name including, scope prefix. eg:  "your-company/your-image"

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ codiac image:remove
  $ codiac img:remove
  $ codiac image:delete
  $ codiac img:delete

See code: src\commands\images\remove.ts

codiac init DIRECTORY

Declares the given folder as a project root

USAGE
  $ codiac init DIRECTORY

ARGUMENTS
  DIRECTORY  Path to the desired project root, relative to current directory.

OPTIONS
  -c, --clone=clone  (Optional) The git repo from which to hydrate the project folder.
  -h, --help         show CLI help

See code: src\commands\init.ts

codiac login

Dialog with user to authenticate under a tenant.

USAGE
  $ codiac login

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ codiac user:login

See code: src\commands\login.ts

codiac merge [BRANCH]

Merges the given branch into the current branch of the main project and on any sourced dependencies.

USAGE
  $ codiac merge [BRANCH]

ARGUMENTS
  BRANCH  The branch name to merge into the current one.

OPTIONS
  -c, --commit  Commits if merge succeeds.
  -h, --help    show CLI help

See code: src\commands\merge.ts

codiac pkg:add [DEFINITIONFILE]

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

USAGE
  $ codiac pkg:add [DEFINITIONFILE]

ARGUMENTS
  DEFINITIONFILE  Path and filename of the package definition file, relative to the codiac project root, (eg:
                  "./package.json")

OPTIONS
  -e, --environment=environment
      (optional) Declaration that this registry shall be the target when publishing to the given environment.

  -h, --help
      show CLI help

  -r, --registryUrl=registryUrl
      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=password
      (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=username
      (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!

See code: src\commands\pkg\add.ts

codiac pkg:list [HELLO]

Renders the list of packages that are configured as project exports.

USAGE
  $ codiac pkg:list [HELLO]

OPTIONS
  -h, --help  show CLI help

See code: src\commands\pkg\list.ts

codiac pkg:patch PACKAGENAME

Applies the given values to an existing package export configuration. Both registryUrl and environment act as filters to limit the operation. That is, an upsert of registry targets is performed for the given package, based on the given registryUrl and/or environment.

USAGE
  $ codiac pkg:patch PACKAGENAME

ARGUMENTS
  PACKAGENAME  package name including, scope prefix. eg:  "your-company/your-package"

OPTIONS
  -h, --help         show CLI help

  -s, --set=set      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=unset  Space-delimited list of properties to clear, in json-path format.  (eg:  --unset .targets.default)

See code: src\commands\pkg\patch.ts

codiac pkg:remove [PACKAGENAME]

Deletes the given package export from the configuration.

USAGE
  $ codiac pkg:remove [PACKAGENAME]

ARGUMENTS
  PACKAGENAME  package name including, scope prefix. eg:  "your-company/your-package"

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ codiac pkg:delete

See code: src\commands\pkg\remove.ts

codiac publish [NAME]

Publishes the exports (packages and images) declared in the codiac.json.

USAGE
  $ codiac publish [NAME]

ARGUMENTS
  NAME  The official unique name of a currently sourced dependency.  Applies the command to ONLY this sourced
        dependency.

OPTIONS
  -h, --help         show CLI help
  -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.

  -r, --remote       Publishes to the remote image registry.  NOTE: this setting gets remembered and is used for
                     subsequent calls unless otherwise specified.

See code: src\commands\publish.ts

codiac pull [NAME]

Pulls all commits from upstream to local.

USAGE
  $ codiac pull [NAME]

ARGUMENTS
  NAME  The official unique name of a currently sourced dependency.  Applies the command to ONLY this sourced
        dependency.

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

See code: src\commands\pull.ts

codiac push [NAME]

Pushes all local commits upstream.

USAGE
  $ codiac push [NAME]

ARGUMENTS
  NAME  The official unique name of a currently sourced dependency.  Applies the command to ONLY this sourced
        dependency.

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

See code: src\commands\push.ts

codiac run

Runs the latest build of the api container locally.

USAGE
  $ codiac run

OPTIONS
  -b, --build                  Triggers a new local build beforehand.
  -d, --detach                 Run container in background and print the container ID.
  -e, --entrypoint=entrypoint  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.

  -n, --network=network        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=port              (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=as                      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=rememberAs      Saves the given argument list so that it can be called by name.

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

See code: src\commands\run.ts

codiac stage [FILES]

Flags files to be included in the next commit.

USAGE
  $ codiac stage [FILES]

ARGUMENTS
  FILES  Space-separated list of files to stage. Paths are relative to the main project root.

OPTIONS
  -A, --all             Include all modified files.
  -c, --commit=message  Commit the staged changes using the given message
  -h, --help            show CLI help

See code: src\commands\stage.ts

codiac stash [FILE]

describe the command here

USAGE
  $ codiac stash [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src\commands\stash.ts

codiac status

Shows the current uncommitted changes in the current branch.

USAGE
  $ codiac status

OPTIONS
  -h, --help      show CLI help
  -s, --staged    Include the list of staged changes.
  -u, --unstaged  Include the list of unstaged changes.

See code: src\commands\status.ts

codiac stop

Stops the api container

USAGE
  $ codiac stop

OPTIONS
  -h, --help    show CLI help
  -r, --remove  Deletes the container after stopping it

See code: src\commands\stop.ts

codiac switch [NAME]

Changes branch on the main project and any sourced dependencies.

USAGE
  $ codiac switch [NAME]

ARGUMENTS
  NAME  The name of the branch to switch to (Optional: will prompt the user when missing).

OPTIONS
  -h, --help  show CLI help

See code: src\commands\switch.ts

codiac sync [NAME]

Merges the given branch into the current branch.

USAGE
  $ codiac sync [NAME]

ARGUMENTS
  NAME  The official unique name of a currently sourced dependency.  Applies the command to ONLY this sourced
        dependency.

OPTIONS
  -b, --with=with    (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.

See code: src\commands\sync.ts

codiac unstage [FILES]

Flags files to be included in the next commit.

USAGE
  $ codiac unstage [FILES]

ARGUMENTS
  FILES  Space-separated list of files to stage. Paths are relative to the main project root.

OPTIONS
  -A, --all   Include all modified files.
  -h, --help  show CLI help

See code: src\commands\unstage.ts

codiac view:services

View pods, deployments, services, and namespaces of one or all image assets.

USAGE
  $ codiac view:services

OPTIONS
  -c, --component=component  View info for a single image asset.
  -h, --help                 show CLI help

See code: src\commands\view\services.ts

codiac whoami

Renders the codiac username and its current tenant.

USAGE
  $ codiac whoami

OPTIONS
  -h, --help                show CLI help
  -o, --output=(text|json)  [default: text] Format for the response data.

ALIASES
  $ codiac user:show

See code: src\commands\whoami.ts

codiac adhoc [FILE]

describe the command here

USAGE
  $ codiac adhoc [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/adhoc.ts

codiac api:client:create

describe the command here

USAGE
  $ codiac api:client:create

OPTIONS
  -h, --help  show CLI help

codiac branch [NAME]

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

USAGE
  $ codiac branch [NAME]

ARGUMENTS
  NAME  The name of the branch to create.

OPTIONS
  -h, --help  show CLI help

See code: src/commands/branch.ts

codiac branch:current

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

USAGE
  $ codiac branch:current

OPTIONS
  -h, --help  show CLI help

ALIASES
  $ codiac branches:current

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

codiac branch:list

Lists out existing branches for the project repo.

USAGE
  $ codiac branch:list

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

ALIASES
  $ codiac branches:list

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

codiac build

Builds the project and the docker container

USAGE
  $ codiac build

OPTIONS
  -M, --major                              Increments the version by one Major version number (using Major.Minor.Patch).
  -c, --clear                              Completely deletes the output folder before building.

  -f, --frameworkVersion=frameworkVersion  (Future) Explicitly sets the version of the Toyhauler base image to use
                                           (default: latest).

  -h, --help                               show CLI help

  -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=(images|packages)             (optional) Prevents the building of any declared container images or
                                           packages.

  -v, --verbose                            Renders additional logging levels (detail, trace, and debug) to the console
                                           output.

  --as=as                                  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=rememberAs                  Saves the given argument list so that it can be called by name.

  --unremember=unremember                  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=version                        Overwrites the full version for the build (using Major.Minor.Patch).

  --withoutdefaults                        Prevents any relevant saved defaults from being invoked for this call.

See code: src/commands/build.ts

codiac cabinet:create CABINET

Initializes a cabinet for a given enterprise and environment. Overwrites any existing if forced, otherwise returns an error if the cabinet already exists.

USAGE
  $ codiac cabinet:create CABINET

ARGUMENTS
  CABINET  The name of the cabinet to create

OPTIONS
  -e, --environment=environment  (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=as                        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=rememberAs        Saves the given argument list so that it can be called by name.

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

ALIASES
  $ codiac cab:create

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

codiac cabinet:obliterate CABINET

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

USAGE
  $ codiac cabinet:obliterate CABINET

ARGUMENTS
  CABINET  The name of the cabinet

OPTIONS
  -e, --environment=environment  (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

  -p, --deleteIpAddress          (optional, defaults to false) Specifies that the ingress IP Address should also be
                                 deleted with the cabinet.

  -v, --verbose                  Renders additional logging levels (detail, trace, and debug) to the console output.

  --as=as                        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=rememberAs        Saves the given argument list so that it can be called by name.

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

ALIASES
  $ codiac cab:obliterate

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

codiac cli

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

USAGE
  $ codiac cli

OPTIONS
  -h, --help     Show the help docs for this command.

  -s, --set=set  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.

See code: src/commands/cli.ts

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]

ARGUMENTS
  MESSAGE  The description to include in this particular commit.

OPTIONS
  -h, --help  show CLI help

See code: src/commands/commit.ts

codiac config:add [SETTING]

Adds a key value pair to the app config

USAGE
  $ codiac config:add [SETTING]

ARGUMENTS
  SETTING  The key for the config setting to add

OPTIONS
  -c, --cabinet=cabinet          The name of the cabinet to which this value is to apply.
  -e, --environment=environment  The name of the environment to which this value is to apply.
  -h, --help                     show CLI help
  -n, --enterprise=enterprise    The name of the enterprise to which this value is to apply.
  -s, --setting=setting          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.

ALIASES
  $ codiac cfg:add

See code: src/commands/config/add.ts

codiac config:delete [SETTING]

Removes the given keys from the app config

USAGE
  $ codiac config:delete [SETTING]

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

OPTIONS
  -c, --cabinet=cabinet          The name of the cabinet to which this value is to apply.
  -e, --environment=environment  The name of the environment to which this value is to apply.
  -h, --help                     show CLI help
  -n, --enterprise=enterprise    The name of the enterprise to which this value is to apply.
  -s, --setting=setting          The config key (in dotpath/JSONPath), relative to the root of the config.

ALIASES
  $ codiac cfg:delete

See code: src/commands/config/delete.ts

codiac config:view [SETTING]

Shows the values that are explicitly set in the app-config

USAGE
  $ codiac config:view [SETTING]

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

OPTIONS
  -c, --cabinet=cabinet  The name of the cabinet to assemble the configuration for.

  -f, --file=file        [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

  -p, --prompt           Invokes a prompt to select from the existing settings.

ALIASES
  $ codiac cfg:view

EXAMPLES
  $ thaul config:view
  $ thaul config:view port
  $ thaul config:view -p

See code: src/commands/config/view.ts

codiac dep [NAME]

Installs a package into current project.

USAGE
  $ codiac dep [NAME]

ARGUMENTS
  NAME  The official unique name of the package to install.

OPTIONS
  -h, --help             show CLI help
  -v, --version=version  version of the package to install

See code: src/commands/dep.ts

codiac dep:create [URL]

Sources a new dependency into the project from an existing repo url, initializes it with the package repository, and publishes the initial version if it is not already. If the package repository is already initialized, the latest package version is used.

USAGE
  $ codiac dep:create [URL]

ARGUMENTS
  URL  The official clone url for the repository.

OPTIONS
  -h, --help             show CLI help
  -v, --version=version  Version to apply to the dependency package if it has not yet been initialized.

See code: src/commands/dep/create.ts

codiac dep:install

installs any missing dependency packages into the local project folder.

USAGE
  $ codiac dep:install

OPTIONS
  -h, --help  show CLI help

See code: src/commands/dep/install.ts

codiac dep:list

Shows the dependencies for the project.

USAGE
  $ codiac dep:list

OPTIONS
  -h, --help  show CLI help

See code: src/commands/dep/list.ts

codiac dep:remove [NAME]

Removes a dependency from the project.

USAGE
  $ codiac dep:remove [NAME]

ARGUMENTS
  NAME  The official unique name of the dependency package.

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

See code: src/commands/dep/remove.ts

codiac dep:source [NAME]

Loads the source code for the given dependency

USAGE
  $ codiac dep:source [NAME]

ARGUMENTS
  NAME  The official unique name of the dependency package.

OPTIONS
  -h, --help  show CLI help

See code: src/commands/dep/source.ts

codiac dep:syncup [FILE]

describe the command here

USAGE
  $ codiac dep:syncup [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

See code: src/commands/dep/syncup.ts

codiac dep:unsource [NAME]

Exits source mode for the given dependency by physically removing its source code folder from the project, and points the project dependency back to the package version it previously depended on.

USAGE
  $ codiac dep:unsource [NAME]

ARGUMENTS
  NAME  The official unique name of the dependency package.

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

See code: src/commands/dep/unsource.ts

codiac dep:upgrade [DEPENDENCY]

describe the command here

USAGE
  $ codiac dep:upgrade [DEPENDENCY]

ARGUMENTS
  DEPENDENCY  The dependency to upgrade

OPTIONS
  -h, --help             show CLI help
  -v, --version=version  version of the package to install

See code: src/commands/dep/upgrade.ts

codiac deploy

describe the command here

USAGE
  $ codiac deploy

OPTIONS
  -h, --help  show CLI help

See code: src/commands/deploy.ts

codiac hello [FILE]

describe the command here

USAGE
  $ codiac hello [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

EXAMPLE
  $ oclif-example hello
  hello world from ./src/hello.ts!

codiac help [COMMAND]

display help for codiac

USAGE
  $ codiac help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

codiac identity [TOKENNAME]

Stores an identity token for the current user, for use with a component tool (such as npm). This command acts as an upsert.

USAGE
  $ codiac identity [TOKENNAME]

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.

OPTIONS
  -e, --email=email                 (Azure Artifacts [aka: azart] only) The email address for this identity.  Npm
                                    requires for this, but never uses it.

  -f, --feed=feed                   (Azure Artifacts [aka: azart] only) The human readable identifier for the package
                                    feed

  -g, --organization=organization   (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=(npm|azart|other)  [default: npm] The source of the token.

  -r, --registryUrl=registryUrl     The component tool that issued and can consume the token.

  -s, --scope=scope                 The subdivision within the registry for which this token is honored.

  -t, --token=token                 (required) The actual raw token string itself issued by the provider

ALIASES
  $ codiac identify
  $ codiac token

See code: src/commands/identity.ts

codiac identity:delete [NAME]

Removes an identity token from storage for the current user.

USAGE
  $ codiac identity:delete [NAME]

ARGUMENTS
  NAME  The name of the token to delete.  Use the 'identity:list' command to view the currently stored tokens.

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

ALIASES
  $ codiac identity:remove
  $ codiac token:delete
  $ codiac token:remove

See code: src/commands/identity/delete.ts

codiac identity:list

Lists out the identity tokens currently stored for the current user.

USAGE
  $ codiac identity:list

OPTIONS
  -h, --help                              Displays the help document for this command.
  -o, --output=(table|extended|json|csv)  [default: table] Format for the response data.

ALIASES
  $ codiac token:list

See code: src/commands/identity/list.ts

codiac images:add IMAGENAME

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

USAGE
  $ codiac images:add IMAGENAME

ARGUMENTS
  IMAGENAME  image name including, scope prefix. eg:  "your-company/your-image"

OPTIONS
  -e, --environment=environment
      (optional) Declaration that this registry shall be the target when publishing to the given environment.

  -f, --sourceFile=sourceFile
      Path and filename of the image definition file, relative to the thaul project root, (eg: "./Dockerfile")

  -h, --help
      show CLI help

  -i, --infoUrl=infoUrl
      (Optional) Address on the registry website or portal of the human-readable web page for the image.

  -p, --port=port
      Recommended port number to assign, in the toybox template, to an Asset defined by this image.

  -r, --readonly
      (optional) Declares that the image already exists in a registry and is not to be built or published from this 
      project.  (eg: use this to add a mongo asset to the enterprise)

  -r, --registryUrl=registryUrl
      [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 "thaul 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=password
      (optional) Password credential for the given registry.  WARNING!! these username/password credentials will be stored 
      in the thaul config file in this project, and therefore configuring username and password in this manner is not 
      recommended!

  -u, --username=username
      (optional) Login credential for the given registry.  WARNING!! these username/password credentials will be stored in 
      the thaul config file in this project, and therefore configuring username and password in this manner is not 
      recommended!

  -w, --overwrite=(never|always|asneeded)
      (Optional, defaults to "never") Declares when the image build shall automatically create or overwrite the physical 
      definitionFile with auto-generated content.  Only applicable when definitionFile is set.

ALIASES
  $ codiac image:add
  $ codiac img:add

See code: src/commands/images/add.ts

codiac images:list [HELLO]

Renders the list of

codiac
@azure/arm-network@azure/ms-rest-nodeauth@codiac.io/codiac-cli-common@codiac.io/codiac-cmd-lib@codiac.io/openapi-codegen-plugin@mfreydl/toyhauler-api-framework@oclif/command@oclif/config@oclif/plugin-help@types/ini@types/rimrafcasechalkcli-uxcodiac-api-clientcodiac-domaincomment-jsonescape-string-regexpfigletiniinquirerjsonpath-pluskubernetes-clientreflect-metadatarimrafrxjstoyhauler-commontslib
0.0.8-2

5 years ago

0.0.1

5 years ago