Skip to main content

CLI commands

This page contains a list of CLI commands that you can use within the tools package context.

Generators​

pnpm nx g @shipfast/tools:webapp-lib​

Generates a project structure for a new webapp library that you can import from other webapp libraries or webapp package.

Example usage
pnpm nx g @shipfast/tools:webapp-lib --directory webapp-libs mylib

To learn more about creating a new webapp library check out the How to create a new webapp library package? guide.

Other commands​

pnpm nx run tools:upload-version SERVICES​

caution

This command is designed to run on CI

Command run on the upload version deployment pipeline step. It will collect information about deployed application state like: environment name, version, built time along with passed services argument and save the data on the S3 bucket that is accessed by the Version matrix tool.

Arguments:

  • SERVICES: comma separated list of services that are deployed during environment update
Example usage
pnpm nx run tools:upload-version migrations,api,workers,webapp

pnpm nx run tools:upload-service-version SERVICE [ADDITIONAL_DATA]​

caution

This command is designed to run on CI

Command run on the end of the application service deployment. It will collect information about deployed application service state like: service name, version, built time and save the data on the S3 bucket that is accessed by the Version matrix tool.

Arguments:

  • SERVICE: name of the service that is updated
  • ADDITIONAL_DATA: (Optional) argument used to pass additional data about deployment in format: arg_name=arg_value. Used for example to pass the url data of the deployed service
Example usage
pnpm nx run tools:upload-service-version workers