Skip to content

Latest commit

 

History

History
88 lines (58 loc) · 2.08 KB

README.md

File metadata and controls

88 lines (58 loc) · 2.08 KB

Launch CLI plugin

oclif

With Launch CLI, you can interact with the Contentstack Launch platform using the terminal to create, manage and deploy Launch projects.

Installation steps

GitHub installation steps:
$ git clone clone <repo url>
$ npm install
$ npm run build
$ csdx plugins:link <plugin path>

NPM installation steps:
$ csdx plugins:install @contentstack/cli-launch
$ csdx launch

Commands

$ csdx launch
start with launch flow <GitHub|FileUpload>
$ csdx launch:logs
To see server logs
$ csdx launch:logs --type d
To see deployment logs
$ csdx launch:functions
Run cloud functions locally

How to do development Locally?

  • Branch out from development for development.
  • Install npm: @contentstack/cli
  • Set region and log in using csdx config:set:region & csdx login

node bin/dev <command-name>

OR

npm run prepack

node bin/run <command-name>

OR

npm run prepack

csdx plugins:link <plugin local path>

csdx <command-name>

How to run tests Locally?

Step 1:- csdx config:set:region Mentioned project should exists in provided org

Step 2:- csdx login

Step 3:- Create env on root level (refer: example.env file)

Step 4:- run test cases (npm run test:unit or npm run test:unit:report)

How will changes be reflected in the CLI ?

If a patch or minor version of the launch is released, users will need to update or install the latest CLI version, which will automatically include the latest launch version. npm i -g @contentstack/cli OR npm update -g @contentstack/cli

However, if a major version of the launch is released, a version bump is also required in CLI(Steps will be like this launch version bump -> cli version bump -> testing -> release).