Skip to content

Commit a577aa9

Browse files
harshitha-cstkharshitha-cstk
authored
Merge pull request #2651 from contentstack/fix/dx-9744-readme-cleanup
docs: mark launch as opt-in plugin in root README (DX-9744)
2 parents 7b3efc5 + cd6cca9 commit a577aa9

1 file changed

Lines changed: 7 additions & 284 deletions

File tree

‎packages/contentstack/README.md‎

Lines changed: 7 additions & 284 deletions
Original file line numberDiff line numberDiff line change
@@ -76,13 +76,6 @@ USAGE
7676
* [`csdx config:set:rate-limit`](#csdx-configsetrate-limit)
7777
* [`csdx config:set:region [REGION]`](#csdx-configsetregion-region)
7878
* [`csdx help [COMMAND]`](#csdx-help-command)
79-
* [`csdx launch`](#csdx-launch)
80-
* [`csdx launch:deployments`](#csdx-launchdeployments)
81-
* [`csdx launch:environments`](#csdx-launchenvironments)
82-
* [`csdx launch:functions`](#csdx-launchfunctions)
83-
* [`csdx launch:logs`](#csdx-launchlogs)
84-
* [`csdx launch:open`](#csdx-launchopen)
85-
* [`csdx launch:rollback`](#csdx-launchrollback)
8679
* [`csdx login`](#csdx-login)
8780
* [`csdx logout`](#csdx-logout)
8881
* [`csdx plugins`](#csdx-plugins)
@@ -1681,283 +1674,13 @@ DESCRIPTION
16811674

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

1684-
## `csdx launch`
1685-
1686-
Launch related operations
1687-
1688-
```
1689-
USAGE
1690-
$ csdx launch [-d <value>] [-c <value>] [--type GitHub|FileUpload] [--framework Gatsby|NextJs|CRA (Create
1691-
React App)|CSR (Client-Side Rendered)|Analog|Angular|Nuxt|Astro|VueJs|Remix|Other] [--org <value>] [-n <value>] [-e
1692-
<value>] [--branch <value>] [--build-command <value>] [--out-dir <value>] [--server-command <value>]
1693-
[--variable-type Import variables from a stack|Manually add custom variables to the list|Import variables from the
1694-
.env.local file|Skip adding environment variables...] [-a <value>] [--env-variables <value>] [--redeploy-latest]
1695-
[--redeploy-last-upload] [--response-mode buffered|streaming]
1696-
1697-
FLAGS
1698-
-a, --alias=<value> [optional] Alias (name) for the delivery token.
1699-
-c, --config=<value> Path to the local '.cs-launch.json' file
1700-
-d, --data-dir=<value> Current working directory
1701-
-e, --environment=<value> [optional] Environment name for the Launch project.
1702-
-n, --name=<value> [optional] Name of the project.
1703-
--branch=<value> [optional] GitHub branch name.
1704-
--build-command=<value> [optional] Build Command.
1705-
--env-variables=<value> [optional] Provide the environment variables in the key:value format, separated by
1706-
comma. For example: APP_ENV:prod, TEST_ENV:testVal.
1707-
--framework=<option> [optional] Type of framework. <options: Gatsby|NextJS|Other>
1708-
<options: Gatsby|NextJs|CRA (Create React App)|CSR (Client-Side
1709-
Rendered)|Analog|Angular|Nuxt|Astro|VueJs|Remix|Other>
1710-
--org=<value> [optional] Provide the organization UID to create a new project or deployment.
1711-
--out-dir=<value> [optional] Output Directory.
1712-
--redeploy-last-upload [optional] Redeploy with last file upload
1713-
--redeploy-latest [optional] Redeploy latest commit/code
1714-
--response-mode=<option> [optional] Provide mode for response. <options: buffered|streaming
1715-
<options: buffered|streaming>
1716-
--server-command=<value> [optional] Server Command.
1717-
--type=<option> [optional] Type of adapters. <options: GitHub|FileUpload>
1718-
<options: GitHub|FileUpload>
1719-
--variable-type=<option>... [optional] Provide a variable type (can specify multiple times). <options: Import
1720-
variables from a stack|Manually add custom variables to the list|Import variables
1721-
from the .env.local file|Skip adding environment variables>
1722-
<options: Import variables from a stack|Manually add custom variables to the
1723-
list|Import variables from the .env.local file|Skip adding environment variables>
1724-
1725-
DESCRIPTION
1726-
Launch related operations
1727-
1728-
EXAMPLES
1729-
$ csdx launch
1730-
1731-
$ csdx launch --data-dir <path/of/current/working/dir>
1732-
1733-
$ csdx launch --config <path/to/launch/config/file>
1734-
1735-
$ csdx launch --type <options: GitHub|FileUpload>
1736-
1737-
$ csdx launch --data-dir <path/of/current/working/dir> --type <options: GitHub|FileUpload>
1738-
1739-
$ csdx launch --data-dir <path/of/current/working/dir> --redeploy-latest
1740-
1741-
$ csdx launch --data-dir <path/of/current/working/dir> --redeploy-last-upload
1742-
1743-
$ csdx launch --config <path/to/launch/config/file> --type <options: GitHub|FileUpload>
1744-
1745-
$ csdx launch --environment=<value> --redeploy-latest
1746-
1747-
$ 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>
1748-
1749-
$ 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>
1750-
1751-
$ 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
1752-
1753-
$ 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>
1754-
1755-
$ 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"
1756-
1757-
$ 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>
1758-
```
1759-
1760-
_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/index.ts)_
1761-
1762-
## `csdx launch:deployments`
1763-
1764-
Show list of deployments for an environment
1765-
1766-
```
1767-
USAGE
1768-
$ csdx launch:deployments [-d <value>] [-c <value>] [--org <value>] [--project <value>] [-e <value>]
1769-
1770-
FLAGS
1771-
-c, --config=<value> Path to the local '.cs-launch.json' file
1772-
-d, --data-dir=<value> Current working directory
1773-
-e, --environment=<value> Environment name or UID
1774-
--org=<value> [Optional] Provide the organization UID
1775-
--project=<value> [Optional] Provide the project UID
1776-
1777-
DESCRIPTION
1778-
Show list of deployments for an environment
1779-
1780-
EXAMPLES
1781-
$ csdx launch:deployments
1782-
1783-
$ csdx launch:deployments -d "current working directory"
1784-
1785-
$ csdx launch:deployments -c "path to the local config file"
1786-
1787-
$ csdx launch:deployments -e "environment number or uid" --org=<org UID> --project=<Project UID>
1788-
```
1789-
1790-
_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/deployments.ts)_
1791-
1792-
## `csdx launch:environments`
1793-
1794-
Show list of environments for a project
1795-
1796-
```
1797-
USAGE
1798-
$ csdx launch:environments [-d <value>] [-c <value>] [--org <value>] [--project <value>]
1799-
1800-
FLAGS
1801-
-c, --config=<value> Path to the local '.cs-launch.json' file
1802-
-d, --data-dir=<value> Current working directory
1803-
--org=<value> [Optional] Provide the organization UID
1804-
--project=<value> [Optional] Provide the project UID
1805-
1806-
DESCRIPTION
1807-
Show list of environments for a project
1808-
1809-
EXAMPLES
1810-
$ csdx launch:environments
1811-
1812-
$ csdx launch:environments -d "current working directory"
1813-
1814-
$ csdx launch:environments -c "path to the local config file"
1815-
1816-
$ csdx launch:environments --org=<org UID> --project=<Project UID>
1817-
```
1818-
1819-
_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/environments.ts)_
1820-
1821-
## `csdx launch:functions`
1822-
1823-
Serve cloud functions
1824-
1825-
```
1826-
USAGE
1827-
$ csdx launch:functions [-p <value>] [-d <value>]
1828-
1829-
FLAGS
1830-
-d, --data-dir=<value> Current working directory
1831-
-p, --port=<value> [default: 3000] Port number
1832-
1833-
DESCRIPTION
1834-
Serve cloud functions
1835-
1836-
EXAMPLES
1837-
$ csdx launch:functions
1838-
1839-
$ csdx launch:functions --port=port
1840-
1841-
$ csdx launch:functions --data-dir <path/of/current/working/dir>
1842-
1843-
$ csdx launch:functions --data-dir <path/of/current/working/dir> -p "port number"
1844-
```
1845-
1846-
_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/functions.ts)_
1847-
1848-
## `csdx launch:logs`
1849-
1850-
Show deployment or server logs
1851-
1852-
```
1853-
USAGE
1854-
$ csdx launch:logs [-d <value>] [-c <value>] [-e <value>] [--deployment <value>] [--type d|s] [--org <value>]
1855-
[--project <value>]
1856-
1857-
FLAGS
1858-
-c, --config=<value> Path to the local '.cs-launch.json' file
1859-
-d, --data-dir=<value> Current working directory
1860-
-e, --environment=<value> Environment name or UID
1861-
--deployment=<value> Deployment number or UID
1862-
--org=<value> [Optional] Provide the organization UID
1863-
--project=<value> [Optional] Provide the project UID
1864-
--type=<option> [default: s] Type of flags to show logs. By default, these are server logs. Options [d -
1865-
deployment logs, s - server logs]
1866-
<options: d|s>
1867-
1868-
DESCRIPTION
1869-
Show deployment or server logs
1870-
1871-
EXAMPLES
1872-
$ csdx launch:logs
1873-
1874-
$ csdx launch:logs --data-dir <path/of/current/working/dir>
1875-
1876-
$ csdx launch:logs --data-dir <path/of/current/working/dir> --type <options: d|s>
1877-
1878-
$ csdx launch:logs --config <path/to/launch/config/file> --type <options: d|s>
1879-
1880-
$ csdx launch:logs --deployment=deployment
1881-
1882-
$ csdx launch:logs --environment=environment
1883-
1884-
$ csdx launch:logs --environment=environment --deployment=deployment
1885-
1886-
$ csdx launch:logs --environment=environment --type <options: d|s>
1887-
1888-
$ csdx launch:logs --environment=environment --data-dir <path/of/current/working/dir> --deployment=deployment
1889-
1890-
$ csdx launch:logs --environment=environment --config <path/to/launch/config/file> --deployment=deployment
1891-
```
1892-
1893-
_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/logs.ts)_
1894-
1895-
## `csdx launch:open`
1896-
1897-
Open a website for an environment
1898-
1899-
```
1900-
USAGE
1901-
$ csdx launch:open [-d <value>] [-c <value>] [--org <value>] [--project <value>] [-e <value>]
1902-
1903-
FLAGS
1904-
-c, --config=<value> Path to the local '.cs-launch.json' file
1905-
-d, --data-dir=<value> Current working directory
1906-
-e, --environment=<value> Environment name or UID
1907-
--org=<value> [Optional] Provide the organization UID
1908-
--project=<value> [Optional] Provide the project UID
1909-
1910-
DESCRIPTION
1911-
Open a website for an environment
1912-
1913-
EXAMPLES
1914-
$ csdx launch:open
1915-
1916-
$ csdx launch:open --config <path/to/launch/config/file>
1917-
1918-
$ csdx launch:open --data-dir <path/of/current/working/dir>
1919-
1920-
$ csdx launch:open --environment=environment
1921-
1922-
$ csdx launch:open --environment=environment --config <path/to/launch/config/file>
1923-
1924-
$ csdx launch:open --environment=environment --data-dir <path/of/current/working/dir>
1925-
```
1926-
1927-
_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/open.ts)_
1928-
1929-
## `csdx launch:rollback`
1930-
1931-
Roll back to previous deployment
1932-
1933-
```
1934-
USAGE
1935-
$ csdx launch:rollback [-d <value>] [-c <value>] [--org <value>] [--project <value>] [-e <value>] [--deployment
1936-
<value>] [--reason <value>]
1937-
1938-
FLAGS
1939-
-c, --config=<value> Path to the local '.cs-launch.json' file
1940-
-d, --data-dir=<value> Current working directory
1941-
-e, --environment=<value> Environment name or UID
1942-
--deployment=<value> [Optional] Deployment UID to roll back to
1943-
--org=<value> [Optional] Provide the organization UID
1944-
--project=<value> [Optional] Provide the project UID
1945-
--reason=<value> [Optional] Reason for the rollback (saved to audit log)
1946-
1947-
DESCRIPTION
1948-
Roll back to previous deployment
1949-
1950-
EXAMPLES
1951-
$ csdx launch:rollback
1952-
1953-
$ csdx launch:rollback -d "current working directory"
1954-
1955-
$ csdx launch:rollback -c "path to the local config file"
1956-
1957-
$ csdx launch:rollback -e "environment number or uid" --deployment=<deployment UID> --org=<org UID> --project=<Project UID> --reason="restoring previous build"
1958-
```
1959-
1960-
_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/rollback.ts)_
1677+
> **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:
1678+
>
1679+
> ```sh-session
1680+
> $ csdx plugins:add @contentstack/cli-launch
1681+
> ```
1682+
>
1683+
> For the full list of `launch` commands and their flags, see the [`@contentstack/cli-launch` README](https://github.com/contentstack/launch-cli#readme).
19611684
19621685
## `csdx login`
19631686

0 commit comments

Comments
 (0)