https://github.com/contentstack/launch-cli
With Launch CLI, you can interact with the Contentstack Launch platform using the terminal to create, manage and deploy Launch projects.
https://github.com/contentstack/launch-cli
Last synced: about 1 month ago
JSON representation
With Launch CLI, you can interact with the Contentstack Launch platform using the terminal to create, manage and deploy Launch projects.
- Host: GitHub
- URL: https://github.com/contentstack/launch-cli
- Owner: contentstack
- License: mit
- Created: 2024-12-20T12:30:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2026-02-05T06:25:03.000Z (about 2 months ago)
- Last Synced: 2026-02-05T18:48:43.420Z (about 2 months ago)
- Language: TypeScript
- Homepage:
- Size: 1.19 MB
- Stars: 1
- Watchers: 7
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Agents: AGENTS.md
Awesome Lists containing this project
README
# Launch CLI plugin
[](https://oclif.io)
With Launch CLI, you can interact with the Contentstack Launch platform using the terminal to create, manage and deploy Launch projects.
* [Launch CLI plugin](#launch-cli-plugin)
* [Installation steps](#installation-steps)
* [Commands](#commands)
* [How to do development Locally?](#how-to-do-development-locally)
* [How to run tests Locally?](#how-to-run-tests-locally)
# Installation steps
```sh-session
GitHub installation steps:
$ git clone clone
$ npm install
$ npm run build
$ csdx plugins:link
NPM installation steps:
$ csdx plugins:install @contentstack/cli-launch
$ csdx launch
```
# Commands
```sh-session
$ csdx launch
start with launch flow
$ 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 `
OR
`npm run prepack`
`node bin/run `
OR
```
npm run prepack
csdx plugins:link
csdx
```
# 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).