diff --git a/README.md b/README.md index 6b922e41eb..b98bd98abc 100644 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ CLI supports content management scripts through which you can perform the follow ## Installing CLI ### Prerequisites Contentstack account -Node.js version 16 or above +Node.js version 22 or above ### Installation To install CLI on your system, run the below command in your terminal: @@ -54,7 +54,7 @@ $ csdx --help ## Namespaces **auth**: To perform [authentication-related](/packages/contentstack-auth) activities -**cm**: To perform content management activities such as [bulk publish](/packages/contentstack-bulk-publish), [import](/packages/contentstack-import), and [export](/packages/contentstack-export), [export-to-csv] (/packages/contentstack-export-to-csv), [seed] (/packages/contentstack-seed) +**cm**: To perform content management activities such as [bulk operations](/packages/contentstack-bulk-operations), [import](/packages/contentstack-import), and [export](/packages/contentstack-export), [export-to-csv](/packages/contentstack-export-to-csv), [seed](/packages/contentstack-seed) **help**: To list the helpful commands in CLI @@ -62,8 +62,8 @@ $ csdx --help ## Documentation -To get a more detailed documentation for every command, visit the [CLI section](https://www.contentstack.com/docs/developers/cli) in our docs. +To get a more detailed documentation for every command, visit the [CLI section](https://www.contentstack.com/docs/headless-cms/cli) in our docs. ## Useful Plugins -- [Generate TypeScript typings from a Stack](https://github.com/Contentstack-Solutions/contentstack-cli-tsgen) +- [Generate TypeScript typings from a Stack](https://github.com/contentstack/cli-plugins/tree/main/packages/contentstack-cli-tsgen) diff --git a/packages/contentstack-auth/README.md b/packages/contentstack-auth/README.md index 61f0f8814d..c0329efa68 100644 --- a/packages/contentstack-auth/README.md +++ b/packages/contentstack-auth/README.md @@ -1,6 +1,6 @@ # @contentstack/cli-auth -It is Contentstack’s CLI plugin to perform authentication-related activities. To get started with authentication, refer to the [CLI’s Authentication documentation](https://www.contentstack.com/docs/developers/cli/authentication) +It is Contentstack’s CLI plugin to perform authentication-related activities. To get started with authentication, refer to the [CLI’s Authentication documentation](https://www.contentstack.com/docs/headless-cms/cli/authentication) [![License](https://img.shields.io/npm/l/@contentstack/cli)](https://github.com/contentstack/cli/blob/main/LICENSE) @@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli-auth $ csdx COMMAND running command... $ csdx (--version) -@contentstack/cli-auth/2.0.0-beta.10 darwin-arm64 node-v22.13.1 +@contentstack/cli-auth/2.0.0-beta.15 darwin-arm64 node-v22.21.1 $ csdx --help [COMMAND] USAGE $ csdx COMMAND @@ -33,11 +33,11 @@ USAGE * [`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 login`](#csdx-login) * [`csdx logout`](#csdx-logout) -* [`csdx tokens`](#csdx-tokens) * [`csdx whoami`](#csdx-whoami) ## `csdx auth:login` @@ -102,7 +102,7 @@ _See code: [src/commands/auth/logout.ts](https://github.com/contentstack/cli/blo ## `csdx auth:tokens` -Lists all existing tokens added to the session +Manage authentication tokens for API access ``` USAGE @@ -120,13 +120,14 @@ TABLE FLAGS --sort= Sort the table by a column. Use "-" for descending. DESCRIPTION - Lists all existing tokens added to the session - -ALIASES - $ csdx tokens + Manage authentication tokens for API access EXAMPLES - $ csdx auth:tokens + $ csdx auth:tokens:list + + $ csdx auth:tokens:add --alias mytoken + + $ csdx auth:tokens:remove --alias mytoken ``` _See code: [src/commands/auth/tokens/index.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-auth/src/commands/auth/tokens/index.ts)_ @@ -177,17 +178,44 @@ EXAMPLES _See code: [src/commands/auth/tokens/add.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-auth/src/commands/auth/tokens/add.ts)_ +## `csdx auth:tokens:list` + +Lists all existing tokens added to the session + +``` +USAGE + $ csdx auth:tokens:list [--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=