todo

WARNING

It is highly recommended to checkout the Guide first, to learn a lot about how Showcase works.

Commands Reference

There are different groups of commands which you can call locally or remotely. Most Showcase Commands will run for all registered clients one by one automatically, if you don't pass any further options.

You can use the --env=client_XXX option in order to run a command just for a specific client where XXX is the name of the client.

Client Related Commands

todo

Build Whats New Information

This command is used to generate Human Readable HTML coming from API/docs/whats-new.md and CLIENT_CONFIG/docs/whats-new.md. It combines System News with Configuration News to build a list of things which have changed for the user.

php artisan sc2:client:build-whats-new

Description:
  Converts Markdown Information to a whats-new file

Usage:
  sc2:client:build-whats-new

Options:
  -h, --help            Display this help message
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi            Force ANSI output
      --no-ansi         Disable ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Deployment Commands

todo

Update Deployment

This is a convenience command as it just executes the correct internal command based on the container we are currently in. It executes php artisan sc2-deployment:update-api [--env=CLIENT_xxx] if we are in an API container or php artisan sc2-deployment:update-runner [--env=CLIENT_xxx] if the container is a runner.

Description:
  Update the given deployment (guesses the correct commands)

Usage:
  sc2-deployment:update

Options:
  -h, --help            Display this help message
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi            Force ANSI output
      --no-ansi         Disable ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Update API Deployment

This command will run a sequence of other commands to make sure to update the API deployment to its latest state. It is usually called after a new client has been created or configuration of a client has changed.

This command will run for all clients by default...

It runs a sequence of the following commands:

• php artisan sc2:client:pull-config [--env=client_XXX]
• php artisan sc2:client:migrate [--env=client_XXX]
• php artisan sc2:client:link [--env=client_XXX]
• php artisan sc2:client:build-whats-new [--env=client_XXX]

php artisan sc2-deployment:update-api

Description:
  Updates the API Deployment

Usage:
  sc2-deployment:update-api

Options:
  -h, --help            Display this help message
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi            Force ANSI output
      --no-ansi         Disable ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Update RUNNER Deployment

This command will run a sequence of other commands to make sure to update the RUNNER deployment to its latest state. It is usually called after a new client has been created or configuration of a client has changed.

This command will run for all clients by default...

It runs a sequence of the following commands:

• php artisan sc2:client:pull-config [--env=client_XXX]
• php artisan sc2:client:link [--env=client_XXX]
• php artisan sc2:client:update-supervisor [--env=client_XXX]

php artisan sc2-deployment:update-runner

Description:
  Updates the RUNNER Deployment

Usage:
  sc2-deployment:update-api

Options:
  -h, --help            Display this help message
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi            Force ANSI output
      --no-ansi         Disable ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug

Run System Migrations

This commands iterates through clients and runs system migrations (from db/migrations).

This command will run for all clients by default...

php artisan sc2-deployment:migrate

Description:
  Iterates through clients and migrate API Migrations

Usage:
  sc2-deployment:migrate

Options:
  -h, --help            Display this help message
  -q, --quiet           Do not output any message
  -V, --version         Display this application version
      --ansi            Force ANSI output
      --no-ansi         Disable ANSI output
  -n, --no-interaction  Do not ask any interactive question
      --env[=ENV]       The environment the command should run under
  -v|vv|vvv, --verbose  Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug