@contentstack/cli-auth
Advanced tools
Readme
It is Contentstack’s CLI plugin to perform authentication-related activities. To get started with authentication, refer to the CLI’s Authentication documentation
$ npm install -g @contentstack/cli-auth
$ csdx COMMAND
running command...
$ csdx (--version)
@contentstack/cli-auth/1.3.17 linux-x64 node-v18.18.2
$ csdx --help [COMMAND]
USAGE
$ csdx COMMAND
...
csdx auth:logincsdx auth:logoutcsdx auth:tokenscsdx auth:tokens:add [-a <value>] [--delivery] [--management] [-e <value>] [-k <value>] [-y] [--token <value>]csdx auth:tokens:removecsdx auth:whoamicsdx logincsdx logoutcsdx tokenscsdx whoamicsdx auth:loginUser sessions login
USAGE
$ csdx auth:login [-u <value> | --oauth] [-p <value> | ]
FLAGS
-p, --password=<value> Password
-u, --username=<value> User name
--oauth Enables single sign-on (SSO) in Contentstack CLI
DESCRIPTION
User sessions login
ALIASES
$ csdx login
EXAMPLES
$ csdx auth:login
$ csdx auth:login -u <username>
$ csdx auth:login -u <username> -p <password>
$ csdx auth:login --username <username>
$ csdx auth:login --username <username> --password <password>
See code: src/commands/auth/login.ts
csdx auth:logoutUser 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: src/commands/auth/logout.ts
csdx auth:tokensLists all existing tokens added to the session
USAGE
$ csdx auth:tokens [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
Lists all existing tokens added to the session
ALIASES
$ csdx tokens
EXAMPLES
$ csdx auth:tokens
See code: src/commands/auth/tokens/index.ts
csdx auth:tokens:add [-a <value>] [--delivery] [--management] [-e <value>] [-k <value>] [-y] [--token <value>]Adds management/delivery tokens to your session to use it with other CLI commands
USAGE
$ csdx auth:tokens:add [-a <value>] [--delivery] [--management] [-e <value>] [-k <value>] [-y] [--token <value>]
FLAGS
-a, --alias=<value> Name of the token alias
-d, --delivery Set this flag to save delivery token
-e, --environment=<value> Environment name for delivery token
-k, --stack-api-key=<value> Stack API Key
-m, --management Set this flag to save management token
-t, --token=<value> Add the token name
-y, --yes Use this flag to skip confirmation
DESCRIPTION
Adds management/delivery tokens to your session to use it with other CLI commands
EXAMPLES
$ csdx auth:tokens:add
$ csdx auth:tokens:add -a <alias>
$ csdx auth:tokens:add -k <stack api key>
$ csdx auth:tokens:add --delivery
$ csdx auth:tokens:add --management
$ csdx auth:tokens:add -e <environment>
$ csdx auth:tokens:add --token <token>
$ csdx auth:tokens:add -a <alias> -k <stack api key> --management --token <management token>
$ csdx auth:tokens:add -a <alias> -k <stack api key> --delivery -e <environment> --token <delivery token>
$ csdx auth:tokens:add --alias <alias> --stack-api-key <stack api key> --management --token <management token>
$ csdx auth:tokens:add --alias <alias> --stack-api-key <stack api key> --delivery -e <environment> --token <delivery token>
See code: src/commands/auth/tokens/add.ts
csdx auth:tokens:removeRemoves selected tokens
USAGE
$ csdx auth:tokens:remove [-a <value>] [-i]
FLAGS
-a, --alias=<value> Token alias
-i, --ignore Ignore
DESCRIPTION
Removes selected tokens
EXAMPLES
$ csdx auth:tokens:remove
$ csdx auth:tokens:remove -a <alias>
See code: src/commands/auth/tokens/remove.ts
csdx auth:whoamiDisplay current users email address
USAGE
$ csdx auth:whoami
DESCRIPTION
Display current users email address
ALIASES
$ csdx whoami
EXAMPLES
$ csdx auth:whoami
See code: src/commands/auth/whoami.ts
csdx loginUser sessions login
USAGE
$ csdx login [-u <value> | --oauth] [-p <value> | ]
FLAGS
-p, --password=<value> Password
-u, --username=<value> User name
--oauth Enables single sign-on (SSO) in Contentstack CLI
DESCRIPTION
User sessions login
ALIASES
$ csdx login
EXAMPLES
$ csdx auth:login
$ csdx auth:login -u <username>
$ csdx auth:login -u <username> -p <password>
$ csdx auth:login --username <username>
$ csdx auth:login --username <username> --password <password>
csdx logoutUser session logout
USAGE
$ csdx 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
csdx tokensLists all existing tokens added to the session
USAGE
$ csdx tokens [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
[--csv | --no-truncate]] [--no-header | ]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
Lists all existing tokens added to the session
ALIASES
$ csdx tokens
EXAMPLES
$ csdx auth:tokens
csdx whoamiDisplay current users email address
USAGE
$ csdx whoami
DESCRIPTION
Display current users email address
ALIASES
$ csdx whoami
EXAMPLES
$ csdx auth:whoami
FAQs
Contentstack CLI plugin for authentication activities
The npm package @contentstack/cli-auth receives a total of 1,315 weekly downloads. As such, @contentstack/cli-auth popularity was classified as popular.
We found that @contentstack/cli-auth demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 12 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.