From 968e40238f09cb258e6ee5bb8f3b650e980f9a6a Mon Sep 17 00:00:00 2001 From: raj pandey Date: Wed, 5 Aug 2026 17:59:05 +0530 Subject: [PATCH 1/3] docs(cli): replace oclif command dump with concise README and plugin index (v2) Reduces packages/contentstack/README.md from 1129 lines to ~65. Replaces the auto-generated full command reference with: - Bundled plugins table (12 plugins) reflecting v2 plugin set - Installable plugins table (7 opt-in plugins) with cli-launch now opt-in - cli-cm-bulk-publish and cli-cm-migrate-rte removed (not in v2) - cli-bulk-operations promoted to bundled Co-Authored-By: Claude Sonnet 4.6 --- packages/contentstack/README.md | 1150 ++----------------------------- 1 file changed, 43 insertions(+), 1107 deletions(-) diff --git a/packages/contentstack/README.md b/packages/contentstack/README.md index e31be1d0d0..91fc7a76f9 100644 --- a/packages/contentstack/README.md +++ b/packages/contentstack/README.md @@ -1,1129 +1,65 @@ # @contentstack/cli -Use Contentstack Command-line Interface to command Contentstack for executing a set of operations from the terminal. To get started with CLI, refer to the [CLI’s documentation](https://www.contentstack.com/docs/headless-cms/cli) +Use Contentstack Command-line Interface (CLI) to interact with Contentstack directly from your terminal. [![License](https://img.shields.io/npm/l/@contentstack/cli)](https://github.com/contentstack/cli/blob/main/LICENSE) +[![npm](https://img.shields.io/npm/v/@contentstack/cli)](https://www.npmjs.com/package/@contentstack/cli) - -* [@contentstack/cli](#contentstackcli) -* [Usage](#usage) -* [Commands](#commands) - +## Requirements -# Usage +Node.js v22 or higher — download from [nodejs.org](https://nodejs.org/). - -```sh-session -$ npm install -g @contentstack/cli -$ csdx COMMAND -running command... -$ csdx (--version|-v) -@contentstack/cli/2.0.0-beta.30 darwin-arm64 node-v24.18.0 -$ csdx --help [COMMAND] -USAGE - $ csdx COMMAND -... -``` - - -# Commands - - -* [`csdx auth:login`](#csdx-authlogin) -* [`csdx auth:logout`](#csdx-authlogout) -* [`csdx auth:tokens`](#csdx-authtokens) -* [`csdx auth:tokens:add [-a ] [--delivery] [--management] [-e ] [-k ] [-y] [--token ]`](#csdx-authtokensadd--a-value---delivery---management--e-value--k-value--y---token-value) -* [`csdx auth:tokens:list`](#csdx-authtokenslist) -* [`csdx auth:tokens:remove`](#csdx-authtokensremove) -* [`csdx auth:whoami`](#csdx-authwhoami) -* [`csdx config:get:base-branch`](#csdx-configgetbase-branch) -* [`csdx config:get:ea-header`](#csdx-configgetea-header) -* [`csdx config:get:early-access-header`](#csdx-configgetearly-access-header) -* [`csdx config:get:log`](#csdx-configgetlog) -* [`csdx config:get:proxy`](#csdx-configgetproxy) -* [`csdx config:get:rate-limit`](#csdx-configgetrate-limit) -* [`csdx config:get:region`](#csdx-configgetregion) -* [`csdx config:remove:base-branch`](#csdx-configremovebase-branch) -* [`csdx config:remove:ea-header`](#csdx-configremoveea-header) -* [`csdx config:remove:early-access-header`](#csdx-configremoveearly-access-header) -* [`csdx config:remove:proxy`](#csdx-configremoveproxy) -* [`csdx config:remove:rate-limit`](#csdx-configremoverate-limit) -* [`csdx config:set:base-branch`](#csdx-configsetbase-branch) -* [`csdx config:set:ea-header`](#csdx-configsetea-header) -* [`csdx config:set:early-access-header`](#csdx-configsetearly-access-header) -* [`csdx config:set:log`](#csdx-configsetlog) -* [`csdx config:set:proxy`](#csdx-configsetproxy) -* [`csdx config:set:rate-limit`](#csdx-configsetrate-limit) -* [`csdx config:set:region [REGION]`](#csdx-configsetregion-region) -* [`csdx help [COMMAND]`](#csdx-help-command) -* [`csdx login`](#csdx-login) -* [`csdx logout`](#csdx-logout) -* [`csdx plugins`](#csdx-plugins) -* [`csdx plugins:add PLUGIN`](#csdx-pluginsadd-plugin) -* [`csdx plugins:inspect PLUGIN...`](#csdx-pluginsinspect-plugin) -* [`csdx plugins:install PLUGIN`](#csdx-pluginsinstall-plugin) -* [`csdx plugins:link PATH`](#csdx-pluginslink-path) -* [`csdx plugins:remove [PLUGIN]`](#csdx-pluginsremove-plugin) -* [`csdx plugins:reset`](#csdx-pluginsreset) -* [`csdx plugins:uninstall [PLUGIN]`](#csdx-pluginsuninstall-plugin) -* [`csdx plugins:unlink [PLUGIN]`](#csdx-pluginsunlink-plugin) -* [`csdx plugins:update`](#csdx-pluginsupdate) -* [`csdx whoami`](#csdx-whoami) - -## `csdx auth:login` - -User sessions login - -``` -USAGE - $ csdx auth:login [-u | --oauth] [-p | ] - -FLAGS - -p, --password= Password of your Contentstack app. - -u, --username= Email address of your Contentstack account. - --oauth Enables single sign-on (SSO) in Contentstack CLI. - -DESCRIPTION - User sessions login - -ALIASES - $ csdx login - -EXAMPLES - $ csdx auth:login - - $ csdx auth:login -u - - $ csdx auth:login -u -p - - $ csdx auth:login --username - - $ csdx auth:login --username --password -``` - -_See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/main/packages/contentstack-auth/src/commands/auth/login.ts)_ - -## `csdx auth:logout` - -User session logout - -``` -USAGE - $ csdx auth:logout [-y] - -FLAGS - -y, --yes Force log out by skipping the confirmation. - -DESCRIPTION - User session logout - -ALIASES - $ csdx logout - -EXAMPLES - $ csdx auth:logout - - $ csdx auth:logout -y - - $ csdx auth:logout --yes -``` - -_See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/main/packages/contentstack-auth/src/commands/auth/logout.ts)_ - -## `csdx auth:tokens` - -Manage authentication tokens for API access - -``` -USAGE - $ csdx auth:tokens [--columns ] [--sort ] [--filter ] [--csv] [--no-truncate] - [--no-header] [--output csv|json|yaml] - -TABLE FLAGS - --columns= Specify columns to display, comma-separated. - --csv Output results in CSV format. - --filter= Filter rows by a column value (e.g., name=foo). - --no-header Hide table headers in output. - --no-truncate Prevent truncation of long text in columns. - --output=