@ably/cli

{ "commands": { "config": { "aliases": [], "args": {}, "description": "Open the Ably config file in the default text editor", "examples": [ "<%= config.bin %> <%= command.id %> edit" ], "flags": { "access-token": { "description": "Overrides any configured access token used for the Control API", "name": "access-token", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "api-key": { "description": "Overrides any configured API key used for the product APIs", "name": "api-key", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "client-id": { "description": "Overrides any default client ID when using API authentication. Use \"none\" to explicitly set no client ID. Not applicable when using token authentication.", "name": "client-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "control-host": { "description": "Override the host endpoint for the control API, which defaults to control.ably.net", "hidden": true, "name": "control-host", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env": { "description": "Override the environment for all product API calls", "name": "env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "endpoint": { "description": "Override the endpoint for all product API calls", "env": "ABLY_ENDPOINT", "name": "endpoint", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "host": { "description": "Override the host endpoint for all product API calls", "name": "host", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "port": { "description": "Override the port for product API calls", "hidden": true, "name": "port", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tlsPort": { "description": "Override the TLS port for product API calls", "hidden": true, "name": "tlsPort", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tls": { "description": "Use TLS for product API calls (default is true)", "hidden": true, "name": "tls", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "json": { "description": "Output in JSON format", "exclusive": [ "pretty-json" ], "name": "json", "allowNo": false, "type": "boolean" }, "pretty-json": { "description": "Output in colorized JSON format", "exclusive": [ "json" ], "name": "pretty-json", "allowNo": false, "type": "boolean" }, "token": { "description": "Authenticate using an Ably Token or JWT Token instead of an API key", "name": "token", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "char": "v", "description": "Output verbose logs", "name": "verbose", "required": false, "allowNo": false, "type": "boolean" }, "web-cli-help": { "description": "Show help formatted for the web CLI", "hidden": true, "name": "web-cli-help", "allowNo": false, "type": "boolean" }, "editor": { "char": "e", "description": "Text editor to use (defaults to $EDITOR environment variable)", "name": "editor", "hasDynamicHelp": false, "multiple": false, "type": "option" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "config", "pluginAlias": "@ably/cli", "pluginName": "@ably/cli", "pluginType": "core", "globalFlags": { "access-token": { "description": "Overrides any configured access token used for the Control API", "input": [], "multiple": false, "type": "option" }, "api-key": { "description": "Overrides any configured API key used for the product APIs", "input": [], "multiple": false, "type": "option" }, "client-id": { "description": "Overrides any default client ID when using API authentication. Use \"none\" to explicitly set no client ID. Not applicable when using token authentication.", "input": [], "multiple": false, "type": "option" }, "control-host": { "description": "Override the host endpoint for the control API, which defaults to control.ably.net", "hidden": true, "input": [], "multiple": false, "type": "option" }, "env": { "description": "Override the environment for all product API calls", "input": [], "multiple": false, "type": "option" }, "endpoint": { "description": "Override the endpoint for all product API calls", "env": "ABLY_ENDPOINT", "input": [], "multiple": false, "type": "option" }, "host": { "description": "Override the host endpoint for all product API calls", "input": [], "multiple": false, "type": "option" }, "port": { "description": "Override the port for product API calls", "hidden": true, "input": [], "multiple": false, "type": "option" }, "tlsPort": { "description": "Override the TLS port for product API calls", "hidden": true, "input": [], "multiple": false, "type": "option" }, "tls": { "description": "Use TLS for product API calls (default is true)", "hidden": true, "input": [], "multiple": false, "type": "option" }, "json": { "description": "Output in JSON format", "exclusive": [ "pretty-json" ], "allowNo": false, "type": "boolean" }, "pretty-json": { "description": "Output in colorized JSON format", "exclusive": [ "json" ], "allowNo": false, "type": "boolean" }, "token": { "description": "Authenticate using an Ably Token or JWT Token instead of an API key", "input": [], "multiple": false, "type": "option" }, "verbose": { "char": "v", "default": false, "description": "Output verbose logs", "required": false, "allowNo": false, "type": "boolean" }, "web-cli-help": { "description": "Show help formatted for the web CLI", "hidden": true, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "src", "commands", "config.js" ] }, "help": { "aliases": [], "args": { "commands": { "description": "Command to show help for", "name": "commands", "required": false } }, "description": "Display help for ably", "examples": [ "$ ably help", "$ ably help channels", "$ ably help channels publish" ], "flags": { "web-cli-help": { "description": "Show help formatted for the web CLI", "hidden": true, "name": "web-cli-help", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "help", "pluginAlias": "@ably/cli", "pluginName": "@ably/cli", "pluginType": "core", "strict": false, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "src", "commands", "help.js" ] }, "interactive": { "aliases": [], "args": {}, "description": "Launch interactive Ably shell (ALPHA - experimental feature)", "flags": {}, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "interactive", "pluginAlias": "@ably/cli", "pluginName": "@ably/cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "EXIT_CODE_USER_EXIT": 42, "isESM": true, "relativePath": [ "dist", "src", "commands", "interactive.js" ] }, "login": { "aliases": [], "args": { "token": { "description": "Access token (if not provided, will prompt for it)", "name": "token", "required": false } }, "description": "Log in to your Ably account (alias for \"ably accounts login\")", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --alias mycompany" ], "flags": { "access-token": { "description": "Overrides any configured access token used for the Control API", "name": "access-token", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "api-key": { "description": "Overrides any configured API key used for the product APIs", "name": "api-key", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "client-id": { "description": "Overrides any default client ID when using API authentication. Use \"none\" to explicitly set no client ID. Not applicable when using token authentication.", "name": "client-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "control-host": { "description": "Override the host endpoint for the control API, which defaults to control.ably.net", "hidden": true, "name": "control-host", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env": { "description": "Override the environment for all product API calls", "name": "env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "endpoint": { "description": "Override the endpoint for all product API calls", "env": "ABLY_ENDPOINT", "name": "endpoint", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "host": { "description": "Override the host endpoint for all product API calls", "name": "host", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "port": { "description": "Override the port for product API calls", "hidden": true, "name": "port", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tlsPort": { "description": "Override the TLS port for product API calls", "hidden": true, "name": "tlsPort", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tls": { "description": "Use TLS for product API calls (default is true)", "hidden": true, "name": "tls", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "json": { "description": "Output in JSON format", "exclusive": [ "pretty-json" ], "name": "json", "allowNo": false, "type": "boolean" }, "pretty-json": { "description": "Output in colorized JSON format", "exclusive": [ "json" ], "name": "pretty-json", "allowNo": false, "type": "boolean" }, "token": { "description": "Authenticate using an Ably Token or JWT Token instead of an API key", "name": "token", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "char": "v", "description": "Output verbose logs", "name": "verbose", "required": false, "allowNo": false, "type": "boolean" }, "web-cli-help": { "description": "Show help formatted for the web CLI", "hidden": true, "name": "web-cli-help", "allowNo": false, "type": "boolean" }, "alias": { "char": "a", "description": "Alias for this account (default account if not specified)", "name": "alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-browser": { "description": "Do not open a browser", "name": "no-browser", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "login", "pluginAlias": "@ably/cli", "pluginName": "@ably/cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "src", "commands", "login.js" ] }, "status": { "aliases": [], "args": {}, "description": "Check the status of the Ably service", "examples": [ "<%= config.bin %> <%= command.id %>" ], "flags": { "help": { "char": "h", "description": "Show CLI help.", "name": "help", "allowNo": false, "type": "boolean" }, "open": { "char": "o", "description": "Open the Ably status page in a browser", "name": "open", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "status", "pluginAlias": "@ably/cli", "pluginName": "@ably/cli", "pluginType": "core", "strict": true, "enableJsonFlag": false, "isESM": true, "relativePath": [ "dist", "src", "commands", "status.js" ] }, "version": { "aliases": [], "args": {}, "description": "Display CLI version information", "examples": [ "<%= config.bin %> version", "<%= config.bin %> version --json" ], "flags": { "access-token": { "description": "Overrides any configured access token used for the Control API", "name": "access-token", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "api-key": { "description": "Overrides any configured API key used for the product APIs", "name": "api-key", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "client-id": { "description": "Overrides any default client ID when using API authentication. Use \"none\" to explicitly set no client ID. Not applicable when using token authentication.", "name": "client-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "control-host": { "description": "Override the host endpoint for the control API, which defaults to control.ably.net", "hidden": true, "name": "control-host", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env": { "description": "Override the environment for all product API calls", "name": "env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "endpoint": { "description": "Override the endpoint for all product API calls", "env": "ABLY_ENDPOINT", "name": "endpoint", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "host": { "description": "Override the host endpoint for all product API calls", "name": "host", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "port": { "description": "Override the port for product API calls", "hidden": true, "name": "port", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tlsPort": { "description": "Override the TLS port for product API calls", "hidden": true, "name": "tlsPort", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tls": { "description": "Use TLS for product API calls (default is true)", "hidden": true, "name": "tls", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "json": { "description": "Output in JSON format", "exclusive": [ "pretty-json" ], "name": "json", "allowNo": false, "type": "boolean" }, "pretty-json": { "description": "Output in colorized JSON format", "exclusive": [ "json" ], "name": "pretty-json", "allowNo": false, "type": "boolean" }, "token": { "description": "Authenticate using an Ably Token or JWT Token instead of an API key", "name": "token", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "char": "v", "description": "Output verbose logs", "name": "verbose", "required": false, "allowNo": false, "type": "boolean" }, "web-cli-help": { "description": "Show help formatted for the web CLI", "hidden": true, "name": "web-cli-help", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hidden": true, "hiddenAliases": [], "id": "version", "pluginAlias": "@ably/cli", "pluginName": "@ably/cli", "pluginType": "core", "globalFlags": { "access-token": { "description": "Overrides any configured access token used for the Control API", "input": [], "multiple": false, "type": "option" }, "api-key": { "description": "Overrides any configured API key used for the product APIs", "input": [], "multiple": false, "type": "option" }, "client-id": { "description": "Overrides any default client ID when using API authentication. Use \"none\" to explicitly set no client ID. Not applicable when using token authentication.", "input": [], "multiple": false, "type": "option" }, "control-host": { "description": "Override the host endpoint for the control API, which defaults to control.ably.net", "hidden": true, "input": [], "multiple": false, "type": "option" }, "env": { "description": "Override the environment for all product API calls", "input": [], "multiple": false, "type": "option" }, "endpoint": { "description": "Override the endpoint for all product API calls", "env": "ABLY_ENDPOINT", "input": [], "multiple": false, "type": "option" }, "host": { "description": "Override the host endpoint for all product API calls", "input": [], "multiple": false, "type": "option" }, "port": { "description": "Override the port for product API calls", "hidden": true, "input": [], "multiple": false, "type": "option" }, "tlsPort": { "description": "Override the TLS port for product API calls", "hidden": true, "input": [], "multiple": false, "type": "option" }, "tls": { "description": "Use TLS for product API calls (default is true)", "hidden": true, "input": [], "multiple": false, "type": "option" }, "json": { "description": "Output in JSON format", "exclusive": [ "pretty-json" ], "allowNo": false, "type": "boolean" }, "pretty-json": { "description": "Output in colorized JSON format", "exclusive": [ "json" ], "allowNo": false, "type": "boolean" }, "token": { "description": "Authenticate using an Ably Token or JWT Token instead of an API key", "input": [], "multiple": false, "type": "option" }, "verbose": { "char": "v", "default": false, "description": "Output verbose logs", "required": false, "allowNo": false, "type": "boolean" }, "web-cli-help": { "description": "Show help formatted for the web CLI", "hidden": true, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "src", "commands", "version.js" ] }, "accounts:current": { "aliases": [], "args": {}, "description": "Show the current Ably account", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --json", "<%= config.bin %> <%= command.id %> --pretty-json" ], "flags": { "access-token": { "description": "Overrides any configured access token used for the Control API", "name": "access-token", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "api-key": { "description": "Overrides any configured API key used for the product APIs", "name": "api-key", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "client-id": { "description": "Overrides any default client ID when using API authentication. Use \"none\" to explicitly set no client ID. Not applicable when using token authentication.", "name": "client-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "control-host": { "description": "Override the host endpoint for the control API, which defaults to control.ably.net", "hidden": true, "name": "control-host", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env": { "description": "Override the environment for all product API calls", "name": "env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "endpoint": { "description": "Override the endpoint for all product API calls", "env": "ABLY_ENDPOINT", "name": "endpoint", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "host": { "description": "Override the host endpoint for all product API calls", "name": "host", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "port": { "description": "Override the port for product API calls", "hidden": true, "name": "port", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tlsPort": { "description": "Override the TLS port for product API calls", "hidden": true, "name": "tlsPort", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tls": { "description": "Use TLS for product API calls (default is true)", "hidden": true, "name": "tls", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "json": { "description": "Output in JSON format", "exclusive": [ "pretty-json" ], "name": "json", "allowNo": false, "type": "boolean" }, "pretty-json": { "description": "Output in colorized JSON format", "exclusive": [ "json" ], "name": "pretty-json", "allowNo": false, "type": "boolean" }, "token": { "description": "Authenticate using an Ably Token or JWT Token instead of an API key", "name": "token", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "char": "v", "description": "Output verbose logs", "name": "verbose", "required": false, "allowNo": false, "type": "boolean" }, "web-cli-help": { "description": "Show help formatted for the web CLI", "hidden": true, "name": "web-cli-help", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "accounts:current", "pluginAlias": "@ably/cli", "pluginName": "@ably/cli", "pluginType": "core", "globalFlags": { "access-token": { "description": "Overrides any configured access token used for the Control API", "input": [], "multiple": false, "type": "option" }, "api-key": { "description": "Overrides any configured API key used for the product APIs", "input": [], "multiple": false, "type": "option" }, "client-id": { "description": "Overrides any default client ID when using API authentication. Use \"none\" to explicitly set no client ID. Not applicable when using token authentication.", "input": [], "multiple": false, "type": "option" }, "control-host": { "description": "Override the host endpoint for the control API, which defaults to control.ably.net", "hidden": true, "input": [], "multiple": false, "type": "option" }, "env": { "description": "Override the environment for all product API calls", "input": [], "multiple": false, "type": "option" }, "endpoint": { "description": "Override the endpoint for all product API calls", "env": "ABLY_ENDPOINT", "input": [], "multiple": false, "type": "option" }, "host": { "description": "Override the host endpoint for all product API calls", "input": [], "multiple": false, "type": "option" }, "port": { "description": "Override the port for product API calls", "hidden": true, "input": [], "multiple": false, "type": "option" }, "tlsPort": { "description": "Override the TLS port for product API calls", "hidden": true, "input": [], "multiple": false, "type": "option" }, "tls": { "description": "Use TLS for product API calls (default is true)", "hidden": true, "input": [], "multiple": false, "type": "option" }, "json": { "description": "Output in JSON format", "exclusive": [ "pretty-json" ], "allowNo": false, "type": "boolean" }, "pretty-json": { "description": "Output in colorized JSON format", "exclusive": [ "json" ], "allowNo": false, "type": "boolean" }, "token": { "description": "Authenticate using an Ably Token or JWT Token instead of an API key", "input": [], "multiple": false, "type": "option" }, "verbose": { "char": "v", "default": false, "description": "Output verbose logs", "required": false, "allowNo": false, "type": "boolean" }, "web-cli-help": { "description": "Show help formatted for the web CLI", "hidden": true, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "src", "commands", "accounts", "current.js" ] }, "accounts": { "aliases": [], "args": {}, "description": "Manage Ably accounts and your configured access tokens", "examples": [ "$ ably accounts login", "$ ably accounts list", "$ ably accounts current", "$ ably accounts logout", "$ ably accounts switch my-account", "$ ably accounts stats" ], "flags": {}, "hasDynamicHelp": false, "hiddenAliases": [], "id": "accounts", "pluginAlias": "@ably/cli", "pluginName": "@ably/cli", "pluginType": "core", "strict": false, "isESM": true, "relativePath": [ "dist", "src", "commands", "accounts", "index.js" ] }, "accounts:list": { "aliases": [], "args": {}, "description": "List locally configured Ably accounts", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --json", "<%= config.bin %> <%= command.id %> --pretty-json" ], "flags": { "access-token": { "description": "Overrides any configured access token used for the Control API", "name": "access-token", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "api-key": { "description": "Overrides any configured API key used for the product APIs", "name": "api-key", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "client-id": { "description": "Overrides any default client ID when using API authentication. Use \"none\" to explicitly set no client ID. Not applicable when using token authentication.", "name": "client-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "control-host": { "description": "Override the host endpoint for the control API, which defaults to control.ably.net", "hidden": true, "name": "control-host", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env": { "description": "Override the environment for all product API calls", "name": "env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "endpoint": { "description": "Override the endpoint for all product API calls", "env": "ABLY_ENDPOINT", "name": "endpoint", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "host": { "description": "Override the host endpoint for all product API calls", "name": "host", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "port": { "description": "Override the port for product API calls", "hidden": true, "name": "port", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tlsPort": { "description": "Override the TLS port for product API calls", "hidden": true, "name": "tlsPort", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tls": { "description": "Use TLS for product API calls (default is true)", "hidden": true, "name": "tls", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "json": { "description": "Output in JSON format", "exclusive": [ "pretty-json" ], "name": "json", "allowNo": false, "type": "boolean" }, "pretty-json": { "description": "Output in colorized JSON format", "exclusive": [ "json" ], "name": "pretty-json", "allowNo": false, "type": "boolean" }, "token": { "description": "Authenticate using an Ably Token or JWT Token instead of an API key", "name": "token", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "char": "v", "description": "Output verbose logs", "name": "verbose", "required": false, "allowNo": false, "type": "boolean" }, "web-cli-help": { "description": "Show help formatted for the web CLI", "hidden": true, "name": "web-cli-help", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "accounts:list", "pluginAlias": "@ably/cli", "pluginName": "@ably/cli", "pluginType": "core", "globalFlags": { "access-token": { "description": "Overrides any configured access token used for the Control API", "input": [], "multiple": false, "type": "option" }, "api-key": { "description": "Overrides any configured API key used for the product APIs", "input": [], "multiple": false, "type": "option" }, "client-id": { "description": "Overrides any default client ID when using API authentication. Use \"none\" to explicitly set no client ID. Not applicable when using token authentication.", "input": [], "multiple": false, "type": "option" }, "control-host": { "description": "Override the host endpoint for the control API, which defaults to control.ably.net", "hidden": true, "input": [], "multiple": false, "type": "option" }, "env": { "description": "Override the environment for all product API calls", "input": [], "multiple": false, "type": "option" }, "endpoint": { "description": "Override the endpoint for all product API calls", "env": "ABLY_ENDPOINT", "input": [], "multiple": false, "type": "option" }, "host": { "description": "Override the host endpoint for all product API calls", "input": [], "multiple": false, "type": "option" }, "port": { "description": "Override the port for product API calls", "hidden": true, "input": [], "multiple": false, "type": "option" }, "tlsPort": { "description": "Override the TLS port for product API calls", "hidden": true, "input": [], "multiple": false, "type": "option" }, "tls": { "description": "Use TLS for product API calls (default is true)", "hidden": true, "input": [], "multiple": false, "type": "option" }, "json": { "description": "Output in JSON format", "exclusive": [ "pretty-json" ], "allowNo": false, "type": "boolean" }, "pretty-json": { "description": "Output in colorized JSON format", "exclusive": [ "json" ], "allowNo": false, "type": "boolean" }, "token": { "description": "Authenticate using an Ably Token or JWT Token instead of an API key", "input": [], "multiple": false, "type": "option" }, "verbose": { "char": "v", "default": false, "description": "Output verbose logs", "required": false, "allowNo": false, "type": "boolean" }, "web-cli-help": { "description": "Show help formatted for the web CLI", "hidden": true, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "src", "commands", "accounts", "list.js" ] }, "accounts:login": { "aliases": [], "args": { "token": { "description": "Access token (if not provided, will prompt for it)", "name": "token", "required": false } }, "description": "Log in to your Ably account", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> --alias mycompany", "<%= config.bin %> <%= command.id %> --json", "<%= config.bin %> <%= command.id %> --pretty-json" ], "flags": { "access-token": { "description": "Overrides any configured access token used for the Control API", "name": "access-token", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "api-key": { "description": "Overrides any configured API key used for the product APIs", "name": "api-key", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "client-id": { "description": "Overrides any default client ID when using API authentication. Use \"none\" to explicitly set no client ID. Not applicable when using token authentication.", "name": "client-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "control-host": { "description": "Override the host endpoint for the control API, which defaults to control.ably.net", "hidden": true, "name": "control-host", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env": { "description": "Override the environment for all product API calls", "name": "env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "endpoint": { "description": "Override the endpoint for all product API calls", "env": "ABLY_ENDPOINT", "name": "endpoint", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "host": { "description": "Override the host endpoint for all product API calls", "name": "host", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "port": { "description": "Override the port for product API calls", "hidden": true, "name": "port", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tlsPort": { "description": "Override the TLS port for product API calls", "hidden": true, "name": "tlsPort", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tls": { "description": "Use TLS for product API calls (default is true)", "hidden": true, "name": "tls", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "json": { "description": "Output in JSON format", "exclusive": [ "pretty-json" ], "name": "json", "allowNo": false, "type": "boolean" }, "pretty-json": { "description": "Output in colorized JSON format", "exclusive": [ "json" ], "name": "pretty-json", "allowNo": false, "type": "boolean" }, "token": { "description": "Authenticate using an Ably Token or JWT Token instead of an API key", "name": "token", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "verbose": { "char": "v", "description": "Output verbose logs", "name": "verbose", "required": false, "allowNo": false, "type": "boolean" }, "web-cli-help": { "description": "Show help formatted for the web CLI", "hidden": true, "name": "web-cli-help", "allowNo": false, "type": "boolean" }, "alias": { "char": "a", "description": "Alias for this account (default account if not specified)", "name": "alias", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "no-browser": { "description": "Do not open a browser", "name": "no-browser", "allowNo": false, "type": "boolean" } }, "hasDynamicHelp": false, "hiddenAliases": [], "id": "accounts:login", "pluginAlias": "@ably/cli", "pluginName": "@ably/cli", "pluginType": "core", "globalFlags": { "access-token": { "description": "Overrides any configured access token used for the Control API", "input": [], "multiple": false, "type": "option" }, "api-key": { "description": "Overrides any configured API key used for the product APIs", "input": [], "multiple": false, "type": "option" }, "client-id": { "description": "Overrides any default client ID when using API authentication. Use \"none\" to explicitly set no client ID. Not applicable when using token authentication.", "input": [], "multiple": false, "type": "option" }, "control-host": { "description": "Override the host endpoint for the control API, which defaults to control.ably.net", "hidden": true, "input": [], "multiple": false, "type": "option" }, "env": { "description": "Override the environment for all product API calls", "input": [], "multiple": false, "type": "option" }, "endpoint": { "description": "Override the endpoint for all product API calls", "env": "ABLY_ENDPOINT", "input": [], "multiple": false, "type": "option" }, "host": { "description": "Override the host endpoint for all product API calls", "input": [], "multiple": false, "type": "option" }, "port": { "description": "Override the port for product API calls", "hidden": true, "input": [], "multiple": false, "type": "option" }, "tlsPort": { "description": "Override the TLS port for product API calls", "hidden": true, "input": [], "multiple": false, "type": "option" }, "tls": { "description": "Use TLS for product API calls (default is true)", "hidden": true, "input": [], "multiple": false, "type": "option" }, "json": { "description": "Output in JSON format", "exclusive": [ "pretty-json" ], "allowNo": false, "type": "boolean" }, "pretty-json": { "description": "Output in colorized JSON format", "exclusive": [ "json" ], "allowNo": false, "type": "boolean" }, "token": { "description": "Authenticate using an Ably Token or JWT Token instead of an API key", "input": [], "multiple": false, "type": "option" }, "verbose": { "char": "v", "default": false, "description": "Output verbose logs", "required": false, "allowNo": false, "type": "boolean" }, "web-cli-help": { "description": "Show help formatted for the web CLI", "hidden": true, "allowNo": false, "type": "boolean" } }, "isESM": true, "relativePath": [ "dist", "src", "commands", "accounts", "login.js" ] }, "accounts:logout": { "aliases": [], "args": { "alias": { "description": "Alias of the account to log out from (defaults to current account)", "name": "alias", "required": false } }, "description": "Log out from an Ably account", "examples": [ "<%= config.bin %> <%= command.id %>", "<%= config.bin %> <%= command.id %> mycompany", "<%= config.bin %> <%= command.id %> --json", "<%= config.bin %> <%= command.id %> --pretty-json" ], "flags": { "access-token": { "description": "Overrides any configured access token used for the Control API", "name": "access-token", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "api-key": { "description": "Overrides any configured API key used for the product APIs", "name": "api-key", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "client-id": { "description": "Overrides any default client ID when using API authentication. Use \"none\" to explicitly set no client ID. Not applicable when using token authentication.", "name": "client-id", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "control-host": { "description": "Override the host endpoint for the control API, which defaults to control.ably.net", "hidden": true, "name": "control-host", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "env": { "description": "Override the environment for all product API calls", "name": "env", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "endpoint": { "description": "Override the endpoint for all product API calls", "env": "ABLY_ENDPOINT", "name": "endpoint", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "host": { "description": "Override the host endpoint for all product API calls", "name": "host", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "port": { "description": "Override the port for product API calls", "hidden": true, "name": "port", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tlsPort": { "description": "Override the TLS port for product API calls", "hidden": true, "name": "tlsPort", "hasDynamicHelp": false, "multiple": false, "type": "option" }, "tls": { "description": "Use TLS for product API calls (defa