Skip to content

docs: mark launch as opt-in plugin in root README (DX-9744) #2651

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
harshitha-cstk merged 1 commit into from
Jul 23, 2026
+7 −284
Merged

docs: mark launch as opt-in plugin in root README (DX-9744) #2651

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
291 changes: 7 additions & 284 deletions packages/contentstack/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,13 +76,6 @@ USAGE
* [`csdx config:set:rate-limit`](#csdx-configsetrate-limit)
* [`csdx config:set:region [REGION]`](#csdx-configsetregion-region)
* [`csdx help [COMMAND]`](#csdx-help-command)
* [`csdx launch`](#csdx-launch)
* [`csdx launch:deployments`](#csdx-launchdeployments)
* [`csdx launch:environments`](#csdx-launchenvironments)
* [`csdx launch:functions`](#csdx-launchfunctions)
* [`csdx launch:logs`](#csdx-launchlogs)
* [`csdx launch:open`](#csdx-launchopen)
* [`csdx launch:rollback`](#csdx-launchrollback)
* [`csdx login`](#csdx-login)
* [`csdx logout`](#csdx-logout)
* [`csdx plugins`](#csdx-plugins)
Expand Down Expand Up @@ -1681,283 +1674,13 @@ DESCRIPTION

_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.53/src/commands/help.ts)_

## `csdx launch`

Launch related operations

```
USAGE
$ csdx launch [-d <value>] [-c <value>] [--type GitHub|FileUpload] [--framework Gatsby|NextJs|CRA (Create
React App)|CSR (Client-Side Rendered)|Analog|Angular|Nuxt|Astro|VueJs|Remix|Other] [--org <value>] [-n <value>] [-e
<value>] [--branch <value>] [--build-command <value>] [--out-dir <value>] [--server-command <value>]
[--variable-type Import variables from a stack|Manually add custom variables to the list|Import variables from the
.env.local file|Skip adding environment variables...] [-a <value>] [--env-variables <value>] [--redeploy-latest]
[--redeploy-last-upload] [--response-mode buffered|streaming]

FLAGS
-a, --alias=<value> [optional] Alias (name) for the delivery token.
-c, --config=<value> Path to the local '.cs-launch.json' file
-d, --data-dir=<value> Current working directory
-e, --environment=<value> [optional] Environment name for the Launch project.
-n, --name=<value> [optional] Name of the project.
--branch=<value> [optional] GitHub branch name.
--build-command=<value> [optional] Build Command.
--env-variables=<value> [optional] Provide the environment variables in the key:value format, separated by
comma. For example: APP_ENV:prod, TEST_ENV:testVal.
--framework=<option> [optional] Type of framework. <options: Gatsby|NextJS|Other>
<options: Gatsby|NextJs|CRA (Create React App)|CSR (Client-Side
Rendered)|Analog|Angular|Nuxt|Astro|VueJs|Remix|Other>
--org=<value> [optional] Provide the organization UID to create a new project or deployment.
--out-dir=<value> [optional] Output Directory.
--redeploy-last-upload [optional] Redeploy with last file upload
--redeploy-latest [optional] Redeploy latest commit/code
--response-mode=<option> [optional] Provide mode for response. <options: buffered|streaming
<options: buffered|streaming>
--server-command=<value> [optional] Server Command.
--type=<option> [optional] Type of adapters. <options: GitHub|FileUpload>
<options: GitHub|FileUpload>
--variable-type=<option>... [optional] Provide a variable type (can specify multiple times). <options: Import
variables from a stack|Manually add custom variables to the list|Import variables
from the .env.local file|Skip adding environment variables>
<options: Import variables from a stack|Manually add custom variables to the
list|Import variables from the .env.local file|Skip adding environment variables>

DESCRIPTION
Launch related operations

EXAMPLES
$ csdx launch

$ csdx launch --data-dir <path/of/current/working/dir>

$ csdx launch --config <path/to/launch/config/file>

$ csdx launch --type <options: GitHub|FileUpload>

$ csdx launch --data-dir <path/of/current/working/dir> --type <options: GitHub|FileUpload>

$ csdx launch --data-dir <path/of/current/working/dir> --redeploy-latest

$ csdx launch --data-dir <path/of/current/working/dir> --redeploy-last-upload

$ csdx launch --config <path/to/launch/config/file> --type <options: GitHub|FileUpload>

$ csdx launch --environment=<value> --redeploy-latest

$ csdx launch --config <path/to/launch/config/file> --type <options: GitHub|FileUpload> --name=<value> --environment=<value> --branch=<value> --build-command=<value> --framework=<option> --org=<value> --out-dir=<value>

$ csdx launch --config <path/to/launch/config/file> --type <options: GitHub|FileUpload> --name=<value> --environment=<value> --branch=<value> --build-command=<value> --framework=<option> --org=<value> --out-dir=<value> --server-command=<value>

$ csdx launch --config <path/to/launch/config/file> --type <options: GitHub|FileUpload> --name=<value> --environment=<value> --branch=<value> --build-command=<value> --framework=<option> --org=<value> --out-dir=<value> --server-command=<value> --response-mode=streaming

$ csdx launch --config <path/to/launch/config/file> --type <options: GitHub|FileUpload> --name=<value> --environment=<value> --branch=<value> --build-command=<value> --framework=<option> --org=<value> --out-dir=<value> --variable-type="Import variables from a stack" --alias=<value>

$ csdx launch --config <path/to/launch/config/file> --type <options: GitHub|FileUpload> --name=<value> --environment=<value> --branch=<value> --build-command=<value> --framework=<option> --org=<value> --out-dir=<value> --variable-type="Manually add custom variables to the list" --env-variables="APP_ENV:prod, TEST_ENV:testVal"

$ csdx launch --config <path/to/launch/config/file> --type <options: GitHub|FileUpload> --name=<value> --environment=<value> --branch=<value> --build-command=<value> --framework=<option> --org=<value> --out-dir=<value> --variable-type="Import variables from a stack" --variable-type="Manually add custom variables to the list" --alias=<value>
```

_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/index.ts)_

## `csdx launch:deployments`

Show list of deployments for an environment

```
USAGE
$ csdx launch:deployments [-d <value>] [-c <value>] [--org <value>] [--project <value>] [-e <value>]

FLAGS
-c, --config=<value> Path to the local '.cs-launch.json' file
-d, --data-dir=<value> Current working directory
-e, --environment=<value> Environment name or UID
--org=<value> [Optional] Provide the organization UID
--project=<value> [Optional] Provide the project UID

DESCRIPTION
Show list of deployments for an environment

EXAMPLES
$ csdx launch:deployments

$ csdx launch:deployments -d "current working directory"

$ csdx launch:deployments -c "path to the local config file"

$ csdx launch:deployments -e "environment number or uid" --org=<org UID> --project=<Project UID>
```

_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/deployments.ts)_

## `csdx launch:environments`

Show list of environments for a project

```
USAGE
$ csdx launch:environments [-d <value>] [-c <value>] [--org <value>] [--project <value>]

FLAGS
-c, --config=<value> Path to the local '.cs-launch.json' file
-d, --data-dir=<value> Current working directory
--org=<value> [Optional] Provide the organization UID
--project=<value> [Optional] Provide the project UID

DESCRIPTION
Show list of environments for a project

EXAMPLES
$ csdx launch:environments

$ csdx launch:environments -d "current working directory"

$ csdx launch:environments -c "path to the local config file"

$ csdx launch:environments --org=<org UID> --project=<Project UID>
```

_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/environments.ts)_

## `csdx launch:functions`

Serve cloud functions

```
USAGE
$ csdx launch:functions [-p <value>] [-d <value>]

FLAGS
-d, --data-dir=<value> Current working directory
-p, --port=<value> [default: 3000] Port number

DESCRIPTION
Serve cloud functions

EXAMPLES
$ csdx launch:functions

$ csdx launch:functions --port=port

$ csdx launch:functions --data-dir <path/of/current/working/dir>

$ csdx launch:functions --data-dir <path/of/current/working/dir> -p "port number"
```

_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/functions.ts)_

## `csdx launch:logs`

Show deployment or server logs

```
USAGE
$ csdx launch:logs [-d <value>] [-c <value>] [-e <value>] [--deployment <value>] [--type d|s] [--org <value>]
[--project <value>]

FLAGS
-c, --config=<value> Path to the local '.cs-launch.json' file
-d, --data-dir=<value> Current working directory
-e, --environment=<value> Environment name or UID
--deployment=<value> Deployment number or UID
--org=<value> [Optional] Provide the organization UID
--project=<value> [Optional] Provide the project UID
--type=<option> [default: s] Type of flags to show logs. By default, these are server logs. Options [d -
deployment logs, s - server logs]
<options: d|s>

DESCRIPTION
Show deployment or server logs

EXAMPLES
$ csdx launch:logs

$ csdx launch:logs --data-dir <path/of/current/working/dir>

$ csdx launch:logs --data-dir <path/of/current/working/dir> --type <options: d|s>

$ csdx launch:logs --config <path/to/launch/config/file> --type <options: d|s>

$ csdx launch:logs --deployment=deployment

$ csdx launch:logs --environment=environment

$ csdx launch:logs --environment=environment --deployment=deployment

$ csdx launch:logs --environment=environment --type <options: d|s>

$ csdx launch:logs --environment=environment --data-dir <path/of/current/working/dir> --deployment=deployment

$ csdx launch:logs --environment=environment --config <path/to/launch/config/file> --deployment=deployment
```

_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/logs.ts)_

## `csdx launch:open`

Open a website for an environment

```
USAGE
$ csdx launch:open [-d <value>] [-c <value>] [--org <value>] [--project <value>] [-e <value>]

FLAGS
-c, --config=<value> Path to the local '.cs-launch.json' file
-d, --data-dir=<value> Current working directory
-e, --environment=<value> Environment name or UID
--org=<value> [Optional] Provide the organization UID
--project=<value> [Optional] Provide the project UID

DESCRIPTION
Open a website for an environment

EXAMPLES
$ csdx launch:open

$ csdx launch:open --config <path/to/launch/config/file>

$ csdx launch:open --data-dir <path/of/current/working/dir>

$ csdx launch:open --environment=environment

$ csdx launch:open --environment=environment --config <path/to/launch/config/file>

$ csdx launch:open --environment=environment --data-dir <path/of/current/working/dir>
```

_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/open.ts)_

## `csdx launch:rollback`

Roll back to previous deployment

```
USAGE
$ csdx launch:rollback [-d <value>] [-c <value>] [--org <value>] [--project <value>] [-e <value>] [--deployment
<value>] [--reason <value>]

FLAGS
-c, --config=<value> Path to the local '.cs-launch.json' file
-d, --data-dir=<value> Current working directory
-e, --environment=<value> Environment name or UID
--deployment=<value> [Optional] Deployment UID to roll back to
--org=<value> [Optional] Provide the organization UID
--project=<value> [Optional] Provide the project UID
--reason=<value> [Optional] Reason for the rollback (saved to audit log)

DESCRIPTION
Roll back to previous deployment

EXAMPLES
$ csdx launch:rollback

$ csdx launch:rollback -d "current working directory"

$ csdx launch:rollback -c "path to the local config file"

$ csdx launch:rollback -e "environment number or uid" --deployment=<deployment UID> --org=<org UID> --project=<Project UID> --reason="restoring previous build"
```

_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/rollback.ts)_
> **Note:** The `launch` commands are provided by the opt-in [`@contentstack/cli-launch`](https://github.com/contentstack/launch-cli) plugin and are **not bundled** with `@contentstack/cli`. Install the plugin before using them:
>
> ```sh-session
> $ csdx plugins:add @contentstack/cli-launch
> ```
>
> For the full list of `launch` commands and their flags, see the [`@contentstack/cli-launch` README](https://github.com/contentstack/launch-cli#readme).

## `csdx login`

Expand Down
Loading