@contentstack/cli-auth/oclif.manifest.json

Contentstack CLI plugin for authentication activities

{
  "commands": {
    "auth:login": {
      "aliases": [
        "login"
      ],
      "args": {},
      "description": "User sessions 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>"
      ],
      "flags": {
        "username": {
          "char": "u",
          "description": "Email address of your Contentstack account.",
          "exclusive": [
            "oauth"
          ],
          "name": "username",
          "required": false,
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "password": {
          "char": "p",
          "description": "Password of your Contentstack app.",
          "exclusive": [
            "oauth"
          ],
          "name": "password",
          "required": false,
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "oauth": {
          "description": "Enables single sign-on (SSO) in Contentstack CLI.",
          "exclusive": [
            "username",
            "password"
          ],
          "name": "oauth",
          "required": false,
          "allowNo": false,
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "auth:login",
      "pluginAlias": "@contentstack/cli-auth",
      "pluginName": "@contentstack/cli-auth",
      "pluginType": "core",
      "strict": true,
      "isESM": false,
      "relativePath": [
        "lib",
        "commands",
        "auth",
        "login.js"
      ]
    },
    "auth:logout": {
      "aliases": [
        "logout"
      ],
      "args": {},
      "description": "User session logout",
      "examples": [
        "$ csdx auth:logout",
        "$ csdx auth:logout -y",
        "$ csdx auth:logout --yes"
      ],
      "flags": {
        "yes": {
          "char": "y",
          "description": "Force log out by skipping the confirmation.",
          "name": "yes",
          "required": false,
          "allowNo": false,
          "type": "boolean"
        },
        "force": {
          "char": "f",
          "description": "Force log out by skipping the confirmation.",
          "hidden": true,
          "name": "force",
          "required": false,
          "allowNo": false,
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "auth:logout",
      "pluginAlias": "@contentstack/cli-auth",
      "pluginName": "@contentstack/cli-auth",
      "pluginType": "core",
      "strict": true,
      "isESM": false,
      "relativePath": [
        "lib",
        "commands",
        "auth",
        "logout.js"
      ]
    },
    "auth:whoami": {
      "aliases": [
        "whoami"
      ],
      "args": {},
      "description": "Display current users email address",
      "examples": [
        "$ csdx auth:whoami"
      ],
      "flags": {},
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "auth:whoami",
      "pluginAlias": "@contentstack/cli-auth",
      "pluginName": "@contentstack/cli-auth",
      "pluginType": "core",
      "strict": true,
      "isESM": false,
      "relativePath": [
        "lib",
        "commands",
        "auth",
        "whoami.js"
      ]
    },
    "auth:tokens:add": {
      "aliases": [],
      "args": {},
      "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>"
      ],
      "flags": {
        "alias": {
          "char": "a",
          "description": "Alias (name) you want to assign to the token",
          "name": "alias",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "delivery": {
          "char": "d",
          "description": "Set this flag to save delivery token",
          "exclusive": [
            "management"
          ],
          "name": "delivery",
          "allowNo": false,
          "type": "boolean"
        },
        "management": {
          "char": "m",
          "description": "Set this flag to save management token",
          "exclusive": [
            "delivery",
            "environment"
          ],
          "name": "management",
          "allowNo": false,
          "type": "boolean"
        },
        "environment": {
          "char": "e",
          "description": "Environment name for delivery token",
          "exclusive": [
            "management"
          ],
          "name": "environment",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "stack-api-key": {
          "char": "k",
          "description": "Stack API Key",
          "name": "stack-api-key",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "yes": {
          "char": "y",
          "description": "Use this flag to skip confirmation",
          "name": "yes",
          "allowNo": false,
          "type": "boolean"
        },
        "token": {
          "char": "t",
          "description": "Add the token name",
          "env": "TOKEN",
          "name": "token",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "api-key": {
          "description": "API Key",
          "hidden": true,
          "name": "api-key",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "force": {
          "char": "f",
          "description": "Force adding",
          "hidden": true,
          "name": "force",
          "allowNo": false,
          "type": "boolean"
        },
        "branch": {
          "description": "Branch name",
          "hidden": true,
          "name": "branch",
          "required": false,
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "auth:tokens:add",
      "pluginAlias": "@contentstack/cli-auth",
      "pluginName": "@contentstack/cli-auth",
      "pluginType": "core",
      "strict": true,
      "usage": "auth:tokens:add [-a <value>] [--delivery] [--management] [-e <value>] [-k <value>] [-y] [--token <value>]",
      "isESM": false,
      "relativePath": [
        "lib",
        "commands",
        "auth",
        "tokens",
        "add.js"
      ]
    },
    "auth:tokens": {
      "aliases": [
        "tokens"
      ],
      "args": {},
      "description": "Lists all existing tokens added to the session",
      "examples": [
        "$ csdx auth:tokens"
      ],
      "flags": {
        "columns": {
          "description": "Specify columns to display, comma-separated.",
          "helpGroup": "TABLE",
          "name": "columns",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "sort": {
          "description": "Sort the table by a column. Use \"-\" for descending.",
          "helpGroup": "TABLE",
          "name": "sort",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "filter": {
          "description": "Filter rows by a column value (e.g., name=foo).",
          "helpGroup": "TABLE",
          "name": "filter",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "csv": {
          "description": "Output results in CSV format.",
          "helpGroup": "TABLE",
          "name": "csv",
          "allowNo": false,
          "type": "boolean"
        },
        "no-truncate": {
          "description": "Prevent truncation of long text in columns.",
          "helpGroup": "TABLE",
          "name": "no-truncate",
          "allowNo": false,
          "type": "boolean"
        },
        "no-header": {
          "description": "Hide table headers in output.",
          "helpGroup": "TABLE",
          "name": "no-header",
          "allowNo": false,
          "type": "boolean"
        },
        "output": {
          "description": "Specify output format: csv, json, or yaml.",
          "helpGroup": "TABLE",
          "name": "output",
          "hasDynamicHelp": false,
          "multiple": false,
          "options": [
            "csv",
            "json",
            "yaml"
          ],
          "type": "option"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "auth:tokens",
      "pluginAlias": "@contentstack/cli-auth",
      "pluginName": "@contentstack/cli-auth",
      "pluginType": "core",
      "strict": true,
      "isESM": false,
      "relativePath": [
        "lib",
        "commands",
        "auth",
        "tokens",
        "index.js"
      ]
    },
    "auth:tokens:remove": {
      "aliases": [],
      "args": {},
      "description": "Removes selected tokens",
      "examples": [
        "$ csdx auth:tokens:remove",
        "$ csdx auth:tokens:remove -a <alias>"
      ],
      "flags": {
        "alias": {
          "char": "a",
          "description": "Alias (name) of the token to delete.",
          "name": "alias",
          "hasDynamicHelp": false,
          "multiple": false,
          "type": "option"
        },
        "ignore": {
          "char": "i",
          "description": "Ignores if the token is not present.",
          "name": "ignore",
          "allowNo": false,
          "type": "boolean"
        }
      },
      "hasDynamicHelp": false,
      "hiddenAliases": [],
      "id": "auth:tokens:remove",
      "pluginAlias": "@contentstack/cli-auth",
      "pluginName": "@contentstack/cli-auth",
      "pluginType": "core",
      "strict": true,
      "isESM": false,
      "relativePath": [
        "lib",
        "commands",
        "auth",
        "tokens",
        "remove.js"
      ]
    }
  },
  "version": "1.6.0"
}