toyhauler-cli v0.0.8-0

toyhauler-cli

Local interface for registering and maintaining Toyhauler assets and pipelines

• Usage
• Commands

Usage

$ npm install -g toyhauler-cli
$ thaul COMMAND
running command...
$ thaul (-v|--version|version)
toyhauler-cli/0.0.8-0 darwin-x64 node-v10.15.0
$ thaul --help [COMMAND]
USAGE
  $ thaul COMMAND
...

Commands

• thaul build
• thaul config:add [SETTING]
• thaul config:delete [SETTING]
• thaul config:view [SETTING]
• thaul help [COMMAND]
• thaul init
• thaul run
• thaul stop

thaul build

Builds the project and the docker container

USAGE
  $ thaul build

OPTIONS
  -M, --major                              Increments the version by one Major version number (using Major.Minor.Patch).

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

  -v, --version=version                    Overwrites the full version for the build (using Major.Minor.Patch).

See code: src/commands/build.ts

thaul config:add [SETTING]

Adds a key value pair to the app config

USAGE
  $ thaul config:add [SETTING]

ARGUMENTS
  SETTING  The key for the config setting to add

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

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

thaul config:delete [SETTING]

Removes the given keys from the app config

USAGE
  $ thaul 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
  -h, --help  show CLI help

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

thaul config:view [SETTING]

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

USAGE
  $ thaul config:view [SETTING]

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

OPTIONS
  -h, --help    show CLI help
  -p, --prompt  Invokes a prompt to select from the existing settings.

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

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

thaul help [COMMAND]

display help for thaul

USAGE
  $ thaul help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

thaul init

Declares the current folder as a Toyhauler project root

USAGE
  $ thaul init

OPTIONS
  -h, --help     show CLI help
  -v, --verbose  render stdout for each command

See code: src/commands/init.ts

thaul run

Runs the latest build of the api container locally.

USAGE
  $ thaul 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                   show CLI help

  -i, --interactive            Run the container interactively (in the console; dies with the console).  Use
                               -e|--entrypoint to override the startup command for the container.

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

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

  -w, --watch                  Forces a detach run and follows log output from the container.

See code: src/commands/run.ts

thaul stop

Stops the api container

USAGE
  $ thaul stop

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

See code: src/commands/stop.ts