{ "version": "0.1.18", "commands": { "log": { "id": "log", "description": "Show PagerDuty Domain Log Entries", "strict": true, "usage": "log", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "since": { "name": "since", "type": "option", "description": "The start of the date range over which you want to search.", "multiple": false, "default": "30 days ago" }, "until": { "name": "until", "type": "option", "description": "The end of the date range over which you want to search.", "multiple": false }, "overview": { "name": "overview", "type": "boolean", "char": "O", "description": "Get only `overview` log entries", "allowNo": false }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "auth:add": { "id": "auth:add", "description": "Add an authenticated PagerDuty domain", "strict": true, "usage": "auth add", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [ "auth:set" ], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "token": { "name": "token", "type": "option", "char": "t", "description": "A PagerDuty API token", "multiple": false }, "alias": { "name": "alias", "type": "option", "char": "a", "description": "The alias to use for this token. Defaults to the name of the PD subdomain", "multiple": false }, "default": { "name": "default", "type": "boolean", "char": "d", "description": "Use this token as the default for all PD commands", "allowNo": true }, "refresh_token": { "name": "refresh_token", "type": "option", "char": "r", "description": "OAuth2 refresh token", "multiple": false, "dependsOn": [ "token", "expires_at" ] }, "expires_at": { "name": "expires_at", "type": "option", "char": "e", "description": "Expiration date for token. Required if using --refresh_token", "multiple": false, "dependsOn": [ "refresh_token", "token" ] } }, "args": {} }, "auth:delete": { "id": "auth:delete", "description": "Delete a PagerDuty domain authentication", "strict": true, "usage": "auth delete", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "alias": { "name": "alias", "type": "option", "char": "a", "description": "The alias of the PD domain authentication to delete", "required": true, "multiple": false } }, "args": {} }, "auth:get": { "id": "auth:get", "description": "Get the current authenticated PagerDuty domain", "strict": true, "usage": "auth get", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false } }, "args": {} }, "auth:list": { "id": "auth:list", "description": "List authenticated PagerDuty domains", "strict": true, "usage": "auth list", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false } }, "args": {} }, "auth:use": { "id": "auth:use", "description": "Choose a saved authenticated PagerDuty domain to use with all pd commands", "strict": true, "usage": "auth use", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "alias": { "name": "alias", "type": "option", "char": "a", "description": "The alias of the PD domain to use", "required": true, "multiple": false } }, "args": {} }, "auth:web": { "id": "auth:web", "description": "Authenticate with PagerDuty in the browser", "strict": true, "usage": "auth web", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [ "login" ], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "alias": { "name": "alias", "type": "option", "char": "a", "description": "The alias to use for this token. Defaults to the name of the PD subdomain", "multiple": false }, "default": { "name": "default", "type": "boolean", "char": "d", "description": "Use this token as the default for all PD commands", "allowNo": true } }, "args": {} }, "bs:create": { "id": "bs:create", "description": "Create a PagerDuty Business Service", "strict": true, "usage": "bs create", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "The service's name", "required": true, "multiple": false }, "description": { "name": "description", "type": "option", "char": "d", "description": "The service's description", "multiple": false }, "contact": { "name": "contact", "type": "option", "char": "c", "description": "The owner of the Business Service.", "multiple": false }, "team_id": { "name": "team_id", "type": "option", "char": "t", "description": "The ID of the team that owns the Business Service.", "multiple": false, "exclusive": [ "team_name" ] }, "team_name": { "name": "team_name", "type": "option", "char": "T", "description": "The name team that owns the Business Service.", "multiple": false, "exclusive": [ "team_id" ] }, "open": { "name": "open", "type": "boolean", "char": "o", "description": "Open the new service in the browser", "allowNo": false }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print the service ID only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "open" ] } }, "args": {} }, "bs:list": { "id": "bs:list", "description": "List PagerDuty Business Services", "strict": true, "usage": "bs list", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Select <%= command.pdObjectNamePlural || \"objects\" %> whose names contain the given text", "multiple": false }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "limit": { "name": "limit", "type": "option", "description": "Return no more than this many entries. This option turns off table filtering options.", "multiple": false, "exclusive": [ "filter", "sort" ] }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print <%= command.pdObjectName || \"object\" %> ID's only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "columns", "sort", "csv", "extended", "json" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {}, "pdObjectName": "business service", "pdObjectNamePlural": "business services" }, "ep:copy": { "id": "ep:copy", "description": "Make a copy of a PagerDuty Escalation Policy", "strict": true, "usage": "ep copy", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "The name of the escalation policy to copy.", "multiple": false, "exclusive": [ "id" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "The ID of the escalation policy to copy.", "multiple": false, "exclusive": [ "name" ] }, "destination": { "name": "destination", "type": "option", "char": "d", "description": "The name for the new escalation policy", "multiple": false }, "open": { "name": "open", "type": "boolean", "char": "o", "description": "Open the new escalation policy in the browser", "allowNo": false }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print the new escalation policy ID only to stdout, for use with pipes.", "allowNo": false } }, "args": {} }, "ep:create": { "id": "ep:create", "description": "Create a PagerDuty Escalation Policy with a single level. You can add levels and targets later with ep:level and ep:target", "strict": true, "usage": "ep create", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "The name of the escalation policy to add.", "required": true, "multiple": false }, "delay": { "name": "delay", "type": "option", "char": "d", "description": "Delay in minutes before unacknowledged incidents escalate away from this level", "multiple": false, "default": 30 }, "description": { "name": "description", "type": "option", "description": "The description of the escalation policy", "multiple": false }, "repeat": { "name": "repeat", "type": "option", "char": "r", "description": "Number of times to repeat this level", "multiple": false, "default": 0 }, "user_ids": { "name": "user_ids", "type": "option", "char": "u", "description": "Add a target user with this ID. Specify multiple times for multiple targets.", "multiple": true }, "user_emails": { "name": "user_emails", "type": "option", "char": "U", "description": "Add a target user with this email. Specify multiple times for multiple targets.", "multiple": true }, "schedule_ids": { "name": "schedule_ids", "type": "option", "char": "s", "description": "Add a target schedule with this ID. Specify multiple times for multiple targets.", "multiple": true }, "schedule_names": { "name": "schedule_names", "type": "option", "char": "S", "description": "Add a target schedule with this name. Specify multiple times for multiple targets.", "multiple": true }, "open": { "name": "open", "type": "boolean", "char": "o", "description": "Open the new escalation policy in the browser", "allowNo": false }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print the escalation policy ID only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "open" ] } }, "args": {} }, "ep:list": { "id": "ep:list", "description": "List PagerDuty Escalation Policies", "strict": true, "usage": "ep list", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Select <%= command.pdObjectNamePlural || \"objects\" %> whose names contain the given text", "multiple": false }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "limit": { "name": "limit", "type": "option", "description": "Return no more than this many entries. This option turns off table filtering options.", "multiple": false, "exclusive": [ "filter", "sort" ] }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print <%= command.pdObjectName || \"object\" %> ID's only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "columns", "sort", "csv", "extended", "json" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {}, "pdObjectName": "escalation policy", "pdObjectNamePlural": "escalation policies" }, "ep:listdeletedusers": { "id": "ep:listdeletedusers", "description": "List deleted users in all PagerDuty Escalation Policies", "strict": true, "usage": "ep listdeletedusers", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "ep:oncall": { "id": "ep:oncall", "description": "List a PagerDuty Escalation Policy's on call shifts.", "strict": true, "usage": "ep oncall", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "Show oncalls for the EP with this ID.", "multiple": false, "exclusive": [ "email", "me" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Show oncalls for the EP with this name.", "multiple": false, "exclusive": [ "id" ] }, "since": { "name": "since", "type": "option", "description": "The start of the date range over which you want to search.", "multiple": false }, "until": { "name": "until", "type": "option", "description": "The end of the date range over which you want to search.", "multiple": false }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "ep:open": { "id": "ep:open", "description": "Open PagerDuty Escalation policies in the browser", "strict": true, "usage": "ep open", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Open escalation policies whose names match this string.", "multiple": false, "exclusive": [ "ids", "pipe" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "The IDs of escalation policies to open.", "multiple": true, "exclusive": [ "name", "pipe" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read escalation policy ID's from stdin.", "allowNo": false, "exclusive": [ "ids", "name" ] } }, "args": {} }, "event:alert": { "id": "event:alert", "description": "Send an Alert to PagerDuty", "strict": true, "usage": "event alert", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "routing_key": { "name": "routing_key", "type": "option", "char": "r", "description": "The integration key to send to", "required": true, "multiple": false }, "dedup_key": { "name": "dedup_key", "type": "option", "char": "d", "description": "Deduplication key for correlating triggers and resolves. The maximum permitted length of this property is 255 characters.", "multiple": false }, "action": { "name": "action", "type": "option", "char": "a", "description": "The type of event.", "multiple": false, "options": [ "trigger", "acknowledge", "resolve" ], "default": "trigger" }, "summary": { "name": "summary", "type": "option", "description": "A brief text summary of the event, used to generate the summaries/titles of any associated alerts. The maximum permitted length of this property is 1024 characters.", "required": true, "multiple": false }, "source": { "name": "source", "type": "option", "description": "The unique location of the affected system, preferably a hostname or FQDN.", "required": true, "multiple": false }, "severity": { "name": "severity", "type": "option", "description": "The perceived severity of the status the event is describing with respect to the affected system.", "multiple": false, "options": [ "critical", "error", "warning", "info" ], "default": "critical" }, "timestamp": { "name": "timestamp", "type": "option", "description": "The time at which the emitting tool detected or generated the event.", "multiple": false }, "component": { "name": "component", "type": "option", "description": "Component of the source machine that is responsible for the event, for example mysql or eth0", "multiple": false }, "group": { "name": "group", "type": "option", "description": "Logical grouping of components of a service, for example app-stack", "multiple": false }, "class": { "name": "class", "type": "option", "description": "The class/type of the event, for example ping failure or cpu load", "multiple": false }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Custom details keys to set. JSON paths OK. Specify multiple times to set multiple keys.", "multiple": true }, "values": { "name": "values", "type": "option", "char": "v", "description": "Custom details values to set. JSON OK. To set multiple key/values, specify multiple times in the same order as the keys.", "multiple": true }, "image_srcs": { "name": "image_srcs", "type": "option", "char": "I", "description": "The source URL of an image to include. Multiple times for multiple images.", "multiple": true }, "image_hrefs": { "name": "image_hrefs", "type": "option", "char": "H", "description": "A clickable link URL for included images. Specify in the same order as the image URLs.", "multiple": true }, "image_alts": { "name": "image_alts", "type": "option", "char": "A", "description": "Alternate text for included images. Specify in the same order as the image URLs.", "multiple": true }, "link_hrefs": { "name": "link_hrefs", "type": "option", "char": "L", "description": "A clickable link URL for included links.", "multiple": true }, "link_texts": { "name": "link_texts", "type": "option", "char": "T", "description": "Link text for included links. Specify in the same order as the link URLs.", "multiple": true }, "client": { "name": "client", "type": "option", "char": "c", "description": "A human-readable description of the system that is sending the alert", "multiple": false }, "client_url": { "name": "client_url", "type": "option", "char": "u", "description": "A URL to the system that is sending the alert", "multiple": false }, "endpoint": { "name": "endpoint", "type": "option", "char": "e", "description": "Send the event to an alternate HTTPS endpoint, for example when using with PDaltagent.", "multiple": false }, "jsonvalues": { "name": "jsonvalues", "type": "boolean", "description": "Interpret values as JSON [default: true]", "allowNo": true }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "Output PagerDuty response as JSON", "allowNo": false, "exclusive": [ "pipe" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print dedup key only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "json" ] } }, "args": {} }, "event:change": { "id": "event:change", "description": "Send a Change Event to PagerDuty", "strict": true, "usage": "event change", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "routing_key": { "name": "routing_key", "type": "option", "char": "r", "description": "The integration key to send to", "required": true, "multiple": false }, "summary": { "name": "summary", "type": "option", "description": "A brief text summary of the event, used to generate the summaries/titles of any associated alerts. The maximum permitted length of this property is 1024 characters.", "required": true, "multiple": false }, "source": { "name": "source", "type": "option", "description": "The unique location of the affected system, preferably a hostname or FQDN.", "multiple": false }, "timestamp": { "name": "timestamp", "type": "option", "description": "The time at which the emitting tool detected or generated the event.", "multiple": false }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Custom details keys to set. JSON paths OK. Specify multiple times to set multiple keys.", "multiple": true }, "values": { "name": "values", "type": "option", "char": "v", "description": "Custom details values to set. JSON OK. To set multiple key/values, specify multiple times in the same order as the keys.", "multiple": true }, "link_hrefs": { "name": "link_hrefs", "type": "option", "char": "L", "description": "A clickable link URL for included links.", "multiple": true }, "link_texts": { "name": "link_texts", "type": "option", "char": "T", "description": "Link text for included links. Specify in the same order as the link URLs.", "multiple": true }, "endpoint": { "name": "endpoint", "type": "option", "char": "e", "description": "Send the event to an alternate HTTPS endpoint, for example when using with PDaltagent.", "multiple": false }, "jsonvalues": { "name": "jsonvalues", "type": "boolean", "description": "Interpret values as JSON [default: true]", "allowNo": true }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "Output PagerDuty response as JSON", "allowNo": false, "exclusive": [ "pipe" ] } }, "args": {} }, "field:create": { "id": "field:create", "description": "Create a PagerDuty Custom Field", "strict": true, "usage": "field create", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "An identifier for the field intended primarily for scripting or other programmatic use.", "required": true, "multiple": false }, "display_name": { "name": "display_name", "type": "option", "char": "N", "description": "A human readable name for the field", "required": true, "multiple": false }, "description": { "name": "description", "type": "option", "char": "d", "description": "A human readable description for the field", "multiple": false }, "type": { "name": "type", "type": "option", "char": "t", "description": "The data type of the field", "multiple": false, "options": [ "string", "integer", "float", "boolean", "datetime", "url" ] }, "multi": { "name": "multi", "type": "boolean", "char": "m", "description": "Multi-value field. Specify to create a field that can contain a list of values.", "allowNo": false }, "fixed": { "name": "fixed", "type": "boolean", "char": "f", "description": "Fixed-options field. Specify to create a field that can only take on specific values defined in a list.", "allowNo": false }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print the field ID only to stdout, for use with pipes.", "allowNo": false } }, "args": {} }, "field:list": { "id": "field:list", "description": "List PagerDuty Custom Fields", "strict": true, "usage": "field list", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print field ID's only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "columns", "sort", "csv", "extended", "json" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "incident:ack": { "id": "incident:ack", "description": "Acknowledge PagerDuty Incidents", "strict": true, "usage": "incident ack", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [ "incident:acknowledge" ], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "me": { "name": "me", "type": "boolean", "char": "m", "description": "Acknowledge all incidents assigned to me", "allowNo": false, "exclusive": [ "ids", "pipe" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Incident ID's to acknowledge. Specify multiple times for multiple incidents.", "multiple": true, "exclusive": [ "me", "pipe" ] }, "from": { "name": "from", "type": "option", "char": "F", "description": "Login email of a PD user account for the \"From:\" header. Use only with legacy API tokens.", "multiple": false }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read incident ID's from stdin.", "allowNo": false, "exclusive": [ "me", "ids" ] }, "snooze": { "name": "snooze", "type": "option", "char": "z", "description": "Also snooze selected incidents for the specified amount of time (5m, '1 hour', default unit is seconds).", "multiple": false } }, "args": {} }, "incident:alerts": { "id": "incident:alerts", "description": "Show Alerts in PagerDuty Incidents", "strict": true, "usage": "incident alerts", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "me": { "name": "me", "type": "boolean", "char": "m", "description": "Show alerts for all incidents assigned to me", "allowNo": false, "exclusive": [ "ids", "pipe" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Show alerts for these Incident ID's. Specify multiple times for multiple incidents.", "multiple": true, "exclusive": [ "me", "pipe" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read incident ID's from stdin.", "allowNo": false, "exclusive": [ "me", "ids" ] }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "incident:analytics": { "id": "incident:analytics", "description": "Get Incident analytics", "strict": true, "usage": "incident analytics", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Incident ID's to look at. Specify multiple times for multiple incidents.", "multiple": true, "exclusive": [ "pipe" ] }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read incident ID's from stdin.", "allowNo": false, "exclusive": [ "ids" ] }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "incident:assign": { "id": "incident:assign", "description": "Assign/Reassign PagerDuty Incidents", "strict": true, "usage": "incident assign", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [ "incident:reassign" ], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "me": { "name": "me", "type": "boolean", "char": "m", "description": "Reassign all incidents that are currently assigned to me", "allowNo": false, "exclusive": [ "ids", "pipe" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Incident ID's to assign. Specify multiple times for multiple incidents.", "multiple": true, "exclusive": [ "me", "pipe" ] }, "assign_to_user_ids": { "name": "assign_to_user_ids", "type": "option", "char": "u", "description": "User ID's to assign incidents to. Specify multiple times for multiple assignees.", "multiple": true, "exclusive": [ "assign_to_ep_id", "assign_to_ep_name" ] }, "assign_to_user_emails": { "name": "assign_to_user_emails", "type": "option", "char": "U", "description": "User emails to assign incidents to. Specify multiple times for multiple assignees.", "multiple": true, "exclusive": [ "assign_to_ep_id", "assign_to_ep_name" ] }, "assign_to_ep_id": { "name": "assign_to_ep_id", "type": "option", "char": "e", "description": "Escalation policy ID to assign incidents to.", "multiple": false, "exclusive": [ "assign_to_ep_name" ] }, "assign_to_ep_name": { "name": "assign_to_ep_name", "type": "option", "char": "E", "description": "Escalation policy name to assign incidents to.", "multiple": false }, "from": { "name": "from", "type": "option", "char": "F", "description": "Login email of a PD user account for the \"From:\" header. Use only with legacy API tokens.", "multiple": false }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read incident ID's from stdin.", "allowNo": false, "exclusive": [ "me", "ids" ] } }, "args": {} }, "incident:create": { "id": "incident:create", "description": "Create a PagerDuty Incident", "strict": true, "usage": "incident create", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "service": { "name": "service", "type": "option", "char": "S", "description": "The name of the service to create the incident in", "multiple": false, "exclusive": [ "service_id" ] }, "service_id": { "name": "service_id", "type": "option", "description": "The ID of the service to create the incident in", "multiple": false, "exclusive": [ "service" ] }, "escalation_policy": { "name": "escalation_policy", "type": "option", "char": "E", "description": "The name of the escalation policy to assign the incident to", "multiple": false, "exclusive": [ "escalation_policy_id" ] }, "escalation_policy_id": { "name": "escalation_policy_id", "type": "option", "description": "The ID of the escalation policy to assign the incident to", "multiple": false, "exclusive": [ "escalation_policy" ] }, "user": { "name": "user", "type": "option", "char": "U", "description": "The email of a user to assign the incident to", "multiple": true, "exclusive": [ "escalation_policy", "escalation_policy_id" ] }, "user_id": { "name": "user_id", "type": "option", "description": "The ID of a user to assign the incident to", "multiple": true, "exclusive": [ "escalation_policy", "escalation_policy_id" ] }, "title": { "name": "title", "type": "option", "char": "t", "description": "Incident title", "required": true, "multiple": false }, "details": { "name": "details", "type": "option", "char": "d", "description": "Incident details", "multiple": false }, "urgency": { "name": "urgency", "type": "option", "char": "u", "description": "Incident urgency", "multiple": false, "options": [ "high", "low" ] }, "priority": { "name": "priority", "type": "option", "char": "P", "description": "Incident priority", "multiple": false }, "key": { "name": "key", "type": "option", "char": "k", "description": "Incident key", "multiple": false }, "from": { "name": "from", "type": "option", "char": "F", "description": "Login email of a PD user account for the \"From:\" header. Use only with legacy API tokens.", "multiple": false }, "open": { "name": "open", "type": "boolean", "char": "o", "description": "Open the new incident in the browser", "allowNo": false }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print the incident ID only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "open" ] } }, "args": {} }, "incident:list": { "id": "incident:list", "description": "List PagerDuty Incidents", "strict": true, "usage": "incident list", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Select <%= command.pdObjectNamePlural || \"objects\" %> whose names contain the given text", "multiple": false }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "limit": { "name": "limit", "type": "option", "description": "Return no more than this many entries. This option turns off table filtering options.", "multiple": false, "exclusive": [ "filter", "sort" ] }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print <%= command.pdObjectName || \"object\" %> ID's only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "columns", "sort", "csv", "extended", "json" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] }, "me": { "name": "me", "type": "boolean", "char": "m", "description": "Return incidents assigned to me", "allowNo": false }, "statuses": { "name": "statuses", "type": "option", "char": "s", "description": "Return only incidents with the given statuses. Specify multiple times for multiple statuses.", "multiple": true, "options": [ "open", "closed", "triggered", "acknowledged", "resolved" ], "default": [ "open" ] }, "assignees": { "name": "assignees", "type": "option", "char": "e", "description": "Return incidents assigned to PD accounts whose login emails contain this text. Specify multiple times for multiple assignee filters.", "multiple": true, "exclusive": [ "me" ] }, "exact_assignees": { "name": "exact_assignees", "type": "option", "char": "E", "description": "Return incidents assigned to the PD account whose login email is exactly this text. Specify multiple times for multiple assignees.", "multiple": true, "exclusive": [ "me" ] }, "teams": { "name": "teams", "type": "option", "char": "t", "description": "Return incidents belonging to teams whose names contain this text. Specify multiple times for multiple team filters.", "multiple": true }, "exact_teams": { "name": "exact_teams", "type": "option", "char": "T", "description": "Return incidents belonging to the team whose name is exactly this text. Specify multiple times for multiple teams.", "multiple": true }, "services": { "name": "services", "type": "option", "char": "S", "description": "Return incidents in services whose names contain this text. Specify multiple times for multiple service filters.", "multiple": true }, "exact_services": { "name": "exact_services", "type": "option", "char": "X", "description": "Return incidents in the service whose name is exactly this text. Specify multiple times for multiple services.", "multiple": true }, "urgencies": { "name": "urgencies", "type": "option", "char": "u", "description": "Urgencies to include.", "multiple": true, "options": [ "high", "low" ], "default": [ "high", "low" ] }, "since": { "name": "since", "type": "option", "description": "The start of the date range over which you want to search.", "multiple": false }, "until": { "name": "until", "type": "option", "description": "The end of the date range over which you want to search.", "multiple": false }, "notes": { "name": "notes", "type": "boolean", "description": "Also show incident notes (Uses a lot more HTTPS requests!)", "allowNo": false } }, "args": {}, "pdObjectName": "incident", "pdObjectNamePlural": "incidents" }, "incident:log": { "id": "incident:log", "description": "Show PagerDuty Incident Log Entries", "strict": true, "usage": "incident log", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Select incidents with the given ID. Specify multiple times for multiple incidents.", "multiple": true, "exclusive": [ "pipe" ] }, "overview": { "name": "overview", "type": "boolean", "char": "O", "description": "Get only `overview` log entries", "allowNo": false }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read incident IDs from stdin, for use with pipes.", "allowNo": false, "exclusive": [ "ids" ] }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "incident:merge": { "id": "incident:merge", "description": "Merge PagerDuty Incidents", "strict": true, "usage": "incident merge", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Merge incidents with the given ID. Specify multiple times for multiple incidents. If -I is not given, the first incident in the list will be the parent incident.", "multiple": true, "exclusive": [ "pipe" ] }, "parent_id": { "name": "parent_id", "type": "option", "char": "I", "description": "Use this incident ID as the parent ID.", "multiple": false }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read incident IDs from stdin, for use with pipes. If -I is not given, the first incident ID from the pipe will be the parent incident.", "allowNo": false, "exclusive": [ "ids" ] }, "from": { "name": "from", "type": "option", "char": "F", "description": "Login email of a PD user account for the \"From:\" header. Use only with legacy API tokens.", "multiple": false }, "open": { "name": "open", "type": "boolean", "char": "o", "description": "Open the merged incident in the browser", "allowNo": false } }, "args": {} }, "incident:notes": { "id": "incident:notes", "description": "See or add notes on PagerDuty Incidents", "strict": true, "usage": "incident notes", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "Incident ID.", "required": true, "multiple": false }, "note": { "name": "note", "type": "option", "char": "n", "description": "Note to add", "multiple": false, "exclusive": [ "columns", "sort", "filter", "csv", "output", "extended", "no-truncate", "no-header" ] }, "from": { "name": "from", "type": "option", "char": "F", "description": "Login email of a PD user account for the \"From:\" header. Use only with legacy API tokens.", "multiple": false }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "incident:open": { "id": "incident:open", "description": "Open PagerDuty Incidents in your browser", "strict": true, "usage": "incident open", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "me": { "name": "me", "type": "boolean", "char": "m", "description": "Open all incidents assigned to me", "allowNo": false, "exclusive": [ "ids" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Incident ID's to open. Specify multiple times for multiple incidents.", "multiple": true, "exclusive": [ "me" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read incident ID's from stdin.", "allowNo": false, "exclusive": [ "me", "ids" ] } }, "args": {} }, "incident:priority": { "id": "incident:priority", "description": "Set priority on PagerDuty Incidents", "strict": true, "usage": "incident priority", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "me": { "name": "me", "type": "boolean", "char": "m", "description": "Set priority on all incidents assigned to me", "allowNo": false, "exclusive": [ "ids" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Incident ID's to set priority on. Specify multiple times for multiple incidents.", "multiple": true, "exclusive": [ "me" ] }, "priority": { "name": "priority", "type": "option", "char": "n", "description": "The name of the priority to set.", "required": true, "multiple": false }, "from": { "name": "from", "type": "option", "char": "F", "description": "Login email of a PD user account for the \"From:\" header. Use only with legacy API tokens.", "multiple": false }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read incident ID's from stdin.", "allowNo": false, "exclusive": [ "me", "ids" ] } }, "args": {} }, "incident:rename": { "id": "incident:rename", "description": "Rename (change the title of) PagerDuty Incidents", "strict": true, "usage": "incident rename", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "me": { "name": "me", "type": "boolean", "char": "m", "description": "Rename all incidents that are currently assigned to me", "allowNo": false, "exclusive": [ "ids", "pipe" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Incident ID's to rename. Specify multiple times for multiple incidents.", "multiple": true, "exclusive": [ "me", "pipe" ] }, "title": { "name": "title", "type": "option", "char": "t", "description": "Set the incident title to this string", "multiple": false, "exclusive": [ "prefix" ] }, "prefix": { "name": "prefix", "type": "option", "description": "Prefix the incident title with this string", "multiple": false, "exclusive": [ "title" ] }, "from": { "name": "from", "type": "option", "char": "F", "description": "Login email of a PD user account for the \"From:\" header. Use only with legacy API tokens.", "multiple": false }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read incident ID's from stdin.", "allowNo": false, "exclusive": [ "me", "ids" ] } }, "args": {} }, "incident:resolve": { "id": "incident:resolve", "description": "Resolve PagerDuty Incidents", "strict": true, "usage": "incident resolve", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "me": { "name": "me", "type": "boolean", "char": "m", "description": "Resolve all incidents assigned to me", "allowNo": false, "exclusive": [ "ids", "pipe" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Incident ID's to resolve. Specify multiple times for multiple incidents.", "multiple": true, "exclusive": [ "me", "pipe" ] }, "from": { "name": "from", "type": "option", "char": "F", "description": "Login email of a PD user account for the \"From:\" header. Use only with legacy API tokens.", "multiple": false }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read incident ID's from stdin.", "allowNo": false, "exclusive": [ "me", "ids" ] } }, "args": {} }, "incident:set": { "id": "incident:set", "description": "Update PagerDuty Incidents", "strict": true, "usage": "incident set", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [ "incident:update" ], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "me": { "name": "me", "type": "boolean", "char": "m", "description": "Update all incidents that are currently assigned to me", "allowNo": false, "exclusive": [ "ids", "pipe" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Incident ID's to update. Specify multiple times for multiple incidents.", "multiple": true, "exclusive": [ "me", "pipe" ] }, "key": { "name": "key", "type": "option", "char": "k", "description": "Attribute key to set", "required": true, "multiple": false }, "value": { "name": "value", "type": "option", "char": "v", "description": "Attribute value to set", "required": true, "multiple": false }, "from": { "name": "from", "type": "option", "char": "F", "description": "Login email of a PD user account for the \"From:\" header. Use only with legacy API tokens.", "multiple": false }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read incident ID's from stdin.", "allowNo": false, "exclusive": [ "me", "ids" ] } }, "args": {} }, "orchestration:add": { "id": "orchestration:add", "description": "Add a PagerDuty Event Orchestration", "strict": true, "usage": "orchestration add", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "The name of the orchestration to add", "multiple": false }, "description": { "name": "description", "type": "option", "char": "d", "description": "The description of the orchestration to add", "multiple": false }, "team_id": { "name": "team_id", "type": "option", "char": "t", "description": "The ID of the team that owns this orchestration. If none is specified, only admins have access.", "multiple": false, "exclusive": [ "team_name" ] }, "team_name": { "name": "team_name", "type": "option", "char": "T", "description": "The name of the team that owns this orchestration. If none is specified, only admins have access.", "multiple": false, "exclusive": [ "team_id" ] } }, "args": {} }, "orchestration:list": { "id": "orchestration:list", "description": "List PagerDuty Event Orchestrations", "strict": true, "usage": "orchestration list", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print orchestration ID's only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "columns", "sort", "csv", "extended", "json" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "rest:delete": { "id": "rest:delete", "description": "Make a DELETE request to PagerDuty", "strict": true, "usage": "rest delete", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "endpoint": { "name": "endpoint", "type": "option", "char": "e", "description": "The path to the endpoint, for example, `/users/PXXXXXX` or `/services`", "required": true, "multiple": false }, "params": { "name": "params", "type": "option", "char": "P", "description": "Parameters to add, for example, `query=martin` or `include[]=teams`. Specify multiple times for multiple params.", "multiple": true, "default": [] }, "headers": { "name": "headers", "type": "option", "char": "H", "description": "Headers to add, for example, `From=martin@pagerduty.com`. Specify multiple times for multiple headers.", "multiple": true, "default": [] } }, "args": {} }, "rest:fetch": { "id": "rest:fetch", "description": "Fetch objects from PagerDuty", "strict": true, "usage": "rest fetch", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "endpoint": { "name": "endpoint", "type": "option", "char": "e", "description": "The path to the endpoint, for example, `users` or `services`", "required": true, "multiple": false }, "params": { "name": "params", "type": "option", "char": "P", "description": "Parameters to add, for example, `query=martin` or `include[]=teams. Specify multiple times for multiple params.", "multiple": true, "default": [] }, "headers": { "name": "headers", "type": "option", "char": "H", "description": "Headers to add, for example, `From=martin@pagerduty.com`. Specify multiple times for multiple headers.", "multiple": true, "default": [] }, "table": { "name": "table", "type": "boolean", "char": "t", "description": "Output in table format instead of JSON", "allowNo": false }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display, for use with `--table`. Specify multiple times for multiple fields.", "multiple": true }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print object ID's only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "columns", "sort", "csv", "extended", "json", "keys" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value, for use with `--table`.", "multiple": false, "default": "\\n" }, "limit": { "name": "limit", "type": "option", "description": "Return no more than this many entries. This option turns off table filtering options.", "multiple": false, "exclusive": [ "filter", "sort" ] }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "rest:get": { "id": "rest:get", "description": "Make a GET request to PagerDuty", "strict": true, "usage": "rest get", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "endpoint": { "name": "endpoint", "type": "option", "char": "e", "description": "The path to the endpoint, for example, `/users/PXXXXXX` or `/services`", "required": true, "multiple": false }, "params": { "name": "params", "type": "option", "char": "P", "description": "Parameters to add, for example, `query=martin` or `include[]=teams`. Specify multiple times for multiple params.", "multiple": true, "default": [] }, "headers": { "name": "headers", "type": "option", "char": "H", "description": "Headers to add, for example, `From=martin@pagerduty.com`. Specify multiple times for multiple headers.", "multiple": true, "default": [] } }, "args": {} }, "rest:post": { "id": "rest:post", "description": "Make a POST request to PagerDuty", "strict": true, "usage": "rest post", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "endpoint": { "name": "endpoint", "type": "option", "char": "e", "description": "The path to the endpoint, for example, `/users/PXXXXXX` or `/services`", "required": true, "multiple": false }, "params": { "name": "params", "type": "option", "char": "P", "description": "Parameters to add, for example, `query=martin` or `include[]=teams. Specify multiple times for multiple params.", "multiple": true, "default": [] }, "headers": { "name": "headers", "type": "option", "char": "H", "description": "Headers to add, for example, `From=martin@pagerduty.com`. Specify multiple times for multiple headers.", "multiple": true, "default": [] }, "data": { "name": "data", "type": "option", "char": "d", "description": "JSON data to send", "required": true, "multiple": false } }, "args": {} }, "rest:put": { "id": "rest:put", "description": "Make a PUT request to PagerDuty", "strict": true, "usage": "rest put", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "endpoint": { "name": "endpoint", "type": "option", "char": "e", "description": "The path to the endpoint, for example, `/users/PXXXXXX` or `/services`", "required": true, "multiple": false }, "params": { "name": "params", "type": "option", "char": "P", "description": "Parameters to add, for example, `query=martin` or `include[]=teams. Specify multiple times for multiple params.", "multiple": true, "default": [] }, "headers": { "name": "headers", "type": "option", "char": "H", "description": "Headers to add, for example, `From=martin@pagerduty.com`. Specify multiple times for multiple headers.", "multiple": true, "default": [] }, "data": { "name": "data", "type": "option", "char": "d", "description": "JSON data to send", "required": true, "multiple": false } }, "args": {} }, "schedule:copy": { "id": "schedule:copy", "description": "Make a copy of a PagerDuty Schedule", "strict": true, "usage": "schedule copy", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "The name of the schedule to copy.", "multiple": false, "exclusive": [ "id" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "The ID of the schedule to copy.", "multiple": false, "exclusive": [ "name" ] }, "destination": { "name": "destination", "type": "option", "char": "d", "description": "The name for the new schedule", "multiple": false }, "open": { "name": "open", "type": "boolean", "char": "o", "description": "Open the new schedule in the browser", "allowNo": false }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print the new schedule ID only to stdout, for use with pipes.", "allowNo": false } }, "args": {} }, "schedule:create": { "id": "schedule:create", "description": "Create a PagerDuty Schedule", "strict": true, "usage": "schedule create", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "The name of the schedule to create.", "required": true, "multiple": false }, "description": { "name": "description", "type": "option", "char": "d", "description": "The description of the schedule to create", "multiple": false }, "timezone": { "name": "timezone", "type": "option", "char": "z", "description": "The time zone of the schedule", "multiple": false, "default": "UTC" }, "users": { "name": "users", "type": "option", "char": "u", "description": "The IDs of users to include in the first layer of the schedule. Specify multiple times, in order, for multiple users.", "required": true, "multiple": true }, "handoff_time": { "name": "handoff_time", "type": "option", "char": "t", "description": "The handoff time of the first layer of the schedule (in the time zone specified by -z)", "multiple": false, "default": "09:00" }, "turn_length": { "name": "turn_length", "type": "option", "char": "l", "description": "The rotation turn length of the first layer of the schedule", "multiple": false, "default": "1 day" }, "start": { "name": "start", "type": "option", "char": "s", "description": "The start time of the first layer of the schedule", "multiple": false, "default": "now" }, "rotation_virtual_start": { "name": "rotation_virtual_start", "type": "option", "description": "The effective start time of the first layer. This can be before the start time of the schedule.", "multiple": false }, "open": { "name": "open", "type": "boolean", "char": "o", "description": "Open the new schedule in the browser", "allowNo": false }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print the new schedule ID only to stdout, for use with pipes.", "allowNo": false } }, "args": {} }, "schedule:list": { "id": "schedule:list", "description": "List PagerDuty Schedules", "strict": true, "usage": "schedule list", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Select <%= command.pdObjectNamePlural || \"objects\" %> whose names contain the given text", "multiple": false }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "limit": { "name": "limit", "type": "option", "description": "Return no more than this many entries. This option turns off table filtering options.", "multiple": false, "exclusive": [ "filter", "sort" ] }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print <%= command.pdObjectName || \"object\" %> ID's only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "columns", "sort", "csv", "extended", "json" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {}, "pdObjectName": "schedule", "pdObjectNamePlural": "schedules" }, "schedule:listdeletedusers": { "id": "schedule:listdeletedusers", "description": "List deleted users in all PagerDuty Schedules", "strict": true, "usage": "schedule listdeletedusers", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "schedule:oncall": { "id": "schedule:oncall", "description": "List a PagerDuty Schedule's on call shifts.", "strict": true, "usage": "schedule oncall", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "Show oncalls for the schedule with this ID.", "multiple": false, "exclusive": [ "email", "me" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Show oncalls for the schedule with this name.", "multiple": false, "exclusive": [ "id" ] }, "since": { "name": "since", "type": "option", "description": "The start of the date range over which you want to search.", "multiple": false }, "until": { "name": "until", "type": "option", "description": "The end of the date range over which you want to search.", "multiple": false }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "schedule:open": { "id": "schedule:open", "description": "Open PagerDuty Schedules in the browser", "strict": true, "usage": "schedule open", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Open schedules matching this string.", "multiple": false, "exclusive": [ "ids", "pipe" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "The IDs of schedules to open.", "multiple": true, "exclusive": [ "name", "pipe" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read schedule ID's from stdin.", "allowNo": false, "exclusive": [ "ids", "name" ] } }, "args": {} }, "schedule:render": { "id": "schedule:render", "description": "Render a PagerDuty Schedule", "strict": true, "usage": "schedule render", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "Render the schedule with this ID.", "multiple": false, "exclusive": [ "email", "me" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Render the schedule with this name.", "multiple": false, "exclusive": [ "id" ] }, "since": { "name": "since", "type": "option", "description": "The start of the date range over which you want to search.", "multiple": false }, "until": { "name": "until", "type": "option", "description": "The end of the date range over which you want to search.", "multiple": false }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "schedule:show": { "id": "schedule:show", "description": "Show a PagerDuty Schedule", "strict": true, "usage": "schedule show", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "Show the schedule with this ID.", "multiple": false, "exclusive": [ "email", "me" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Show the schedule with this name.", "multiple": false, "exclusive": [ "id" ] }, "since": { "name": "since", "type": "option", "description": "The start of the date range over which you want to search.", "multiple": false }, "until": { "name": "until", "type": "option", "description": "The end of the date range over which you want to search.", "multiple": false }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "service:create": { "id": "service:create", "description": "Create a PagerDuty Service", "strict": true, "usage": "service create", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "The service's name", "required": true, "multiple": false }, "description": { "name": "description", "type": "option", "char": "d", "description": "The service's description", "multiple": false }, "escalation_policy_id": { "name": "escalation_policy_id", "type": "option", "char": "e", "description": "The ID of the service's escalation policy.", "multiple": false, "exclusive": [ "escalation_policy_name" ] }, "escalation_policy_name": { "name": "escalation_policy_name", "type": "option", "char": "E", "description": "The name of the service's escalation policy.", "multiple": false, "exclusive": [ "escalation_policy_id" ] }, "auto_resolve_timeout": { "name": "auto_resolve_timeout", "type": "option", "char": "r", "description": "Automatically resolve incidents after this number of minutes", "multiple": false }, "ack_timeout": { "name": "ack_timeout", "type": "option", "char": "t", "description": "Automatically re-trigger incidents after this number of minutes", "multiple": false }, "create_alerts": { "name": "create_alerts", "type": "boolean", "description": "Turn on alert support in the service (default: true)", "allowNo": false }, "urgency": { "name": "urgency", "type": "option", "char": "u", "description": "The urgency of incidents in the service", "multiple": false, "options": [ "high", "low", "use_support_hours", "severity_based" ] }, "Ss": { "name": "Ss", "type": "option", "description": "The time of day when support hours start", "multiple": false }, "Se": { "name": "Se", "type": "option", "description": "The time of day when support hours end", "multiple": false }, "Sd": { "name": "Sd", "type": "option", "description": "A day when support hours are active. Specify multiple times for multiple days.", "multiple": true }, "Ud": { "name": "Ud", "type": "option", "description": "Incident urgency during support hours.", "multiple": false, "options": [ "high", "low", "severity_based" ] }, "Uo": { "name": "Uo", "type": "option", "description": "Incident urgency outside of support hours.", "multiple": false, "options": [ "high", "low", "severity_based" ] }, "Uc": { "name": "Uc", "type": "boolean", "description": "Change unacknowledged incidents to high urgency when entering high-urgency support hours", "allowNo": false }, "Gd": { "name": "Gd", "type": "option", "description": "Do time based alert grouping for this number of minutes.", "multiple": false, "exclusive": [ "Gi", "Gc", "Gf" ] }, "Gi": { "name": "Gi", "type": "boolean", "description": "Do intelligent alert grouping", "allowNo": false, "exclusive": [ "Gd", "Gc", "Gf" ] }, "Gc": { "name": "Gc", "type": "option", "description": "Do content-based alert grouping. Specify the fields to look at with --Gf and choose 'any' or 'all' fields.", "multiple": false, "options": [ "any", "all" ], "exclusive": [ "Gd", "Gi" ] }, "Gf": { "name": "Gf", "type": "option", "description": "The fields to look at for content based alert grouping. Specify multiple times for multiple fields.", "multiple": true, "exclusive": [ "Gd", "Gi" ] }, "from": { "name": "from", "type": "option", "char": "F", "description": "Login email of a PD user account for the \"From:\" header. Use only with legacy API tokens.", "multiple": false }, "open": { "name": "open", "type": "boolean", "char": "o", "description": "Open the new service in the browser", "allowNo": false }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print the service ID only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "open" ] } }, "args": {} }, "service:disable": { "id": "service:disable", "description": "Disable PagerDuty Services", "strict": true, "usage": "service disable", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Select services whose names contain the given text", "multiple": false }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Select services with the given ID. Specify multiple times for multiple services.", "multiple": true }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read service ID's from stdin.", "allowNo": false, "exclusive": [ "name", "ids" ] } }, "args": {} }, "service:enable": { "id": "service:enable", "description": "Enable PagerDuty Services", "strict": true, "usage": "service enable", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Select services whose names contain the given text", "multiple": false }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Select services with the given ID. Specify multiple times for multiple services.", "multiple": true }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read service ID's from stdin.", "allowNo": false, "exclusive": [ "name", "ids" ] } }, "args": {} }, "service:list": { "id": "service:list", "description": "List PagerDuty Services", "strict": true, "usage": "service list", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Select <%= command.pdObjectNamePlural || \"objects\" %> whose names contain the given text", "multiple": false }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "limit": { "name": "limit", "type": "option", "description": "Return no more than this many entries. This option turns off table filtering options.", "multiple": false, "exclusive": [ "filter", "sort" ] }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print <%= command.pdObjectName || \"object\" %> ID's only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "columns", "sort", "csv", "extended", "json" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] }, "teams": { "name": "teams", "type": "option", "char": "t", "description": "Team names to include. Specify multiple times for multiple teams.", "multiple": true } }, "args": {}, "pdObjectName": "service", "pdObjectNamePlural": "services" }, "service:open": { "id": "service:open", "description": "Open PagerDuty Services in the browser", "strict": true, "usage": "service open", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Open services matching this string.", "multiple": false, "exclusive": [ "ids", "pipe" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "The IDs of services to open.", "multiple": true, "exclusive": [ "name", "pipe" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read service ID's from stdin.", "allowNo": false, "exclusive": [ "ids", "name" ] } }, "args": {} }, "service:set": { "id": "service:set", "description": "Set PagerDuty Service attributes", "strict": true, "usage": "service set", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "names": { "name": "names", "type": "option", "char": "n", "description": "Select services whose names contain the given text. Specify multiple times for multiple names.", "multiple": true }, "exact_names": { "name": "exact_names", "type": "option", "char": "N", "description": "Select a service whose name is this exact text. Specify multiple times for multiple services.", "multiple": true }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Select services with the given ID. Specify multiple times for multiple services.", "multiple": true }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Attribute keys to set. Specify multiple times to set multiple keys.", "required": true, "multiple": true }, "values": { "name": "values", "type": "option", "char": "v", "description": "Attribute values to set. To set multiple key/values, specify multiple times in the same order as the keys.", "required": true, "multiple": true }, "jsonvalues": { "name": "jsonvalues", "type": "boolean", "description": "Interpret values as JSON [default: true]", "allowNo": true }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read service ID's from stdin.", "allowNo": false, "exclusive": [ "names", "exact_names", "ids" ] } }, "args": {} }, "tag:assign": { "id": "tag:assign", "description": "Assign/Remove Tags to/from PagerDuty objects", "strict": true, "usage": "tag assign", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "add_ids": { "name": "add_ids", "type": "option", "char": "a", "description": "The ID of a Tag to add. Specify multiple times for multiple tags", "multiple": true, "default": [] }, "add_names": { "name": "add_names", "type": "option", "char": "A", "description": "The name of a Tag to add. If no tag with this name exists, a new tag will be created. Specify multiple times for multiple tags", "multiple": true, "default": [] }, "remove_ids": { "name": "remove_ids", "type": "option", "char": "r", "description": "The ID of a Tag to remove. Specify multiple times for multiple tags", "multiple": true, "default": [] }, "remove_names": { "name": "remove_names", "type": "option", "char": "R", "description": "The name of a Tag to remove. Specify multiple times for multiple tags", "multiple": true, "default": [] }, "user_ids": { "name": "user_ids", "type": "option", "char": "u", "description": "The ID of a User to assign this tag to. Specify multiple times for multiple users", "multiple": true, "default": [] }, "user_emails": { "name": "user_emails", "type": "option", "char": "U", "description": "The email of a User to assign this tag to. Specify multiple times for multiple users", "multiple": true, "default": [] }, "team_ids": { "name": "team_ids", "type": "option", "char": "t", "description": "The ID of a Team to assign this tag to. Specify multiple times for multiple teams", "multiple": true, "default": [] }, "ep_ids": { "name": "ep_ids", "type": "option", "char": "e", "description": "The ID of an Escalation Policy to assign this tag to. Specify multiple times for multiple users", "multiple": true, "default": [] } }, "args": {} }, "tag:list": { "id": "tag:list", "description": "List PagerDuty Tags", "strict": true, "usage": "tag list", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Select <%= command.pdObjectNamePlural || \"objects\" %> whose names contain the given text", "multiple": false }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "limit": { "name": "limit", "type": "option", "description": "Return no more than this many entries. This option turns off table filtering options.", "multiple": false, "exclusive": [ "filter", "sort" ] }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print <%= command.pdObjectName || \"object\" %> ID's only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "columns", "sort", "csv", "extended", "json" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "tag:listobjects": { "id": "tag:listobjects", "description": "List Tagged PagerDuty Objects (Connected Entities)", "strict": true, "usage": "tag listobjects", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "The ID of a Tag to show. Specify multiple times for multiple tags", "multiple": true, "default": [] }, "names": { "name": "names", "type": "option", "char": "n", "description": "The name of a Tag to show. Specify multiple times for multiple tags", "multiple": true, "default": [] }, "types": { "name": "types", "type": "option", "char": "t", "description": "The types of objects to show. Specify multiple times for multiple types", "multiple": true, "options": [ "users", "teams", "escalation_policies" ], "default": [ "users", "teams", "escalation_policies" ] }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print object ID's only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "columns", "sort", "csv", "extended", "json" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "team:create": { "id": "team:create", "description": "Create an empty PagerDuty Team. You can add escalation policies and users later with team:ep and team:user", "strict": true, "usage": "team create", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "The name of the team to add.", "required": true, "multiple": false }, "description": { "name": "description", "type": "option", "description": "The description of the team", "multiple": false }, "parent_id": { "name": "parent_id", "type": "option", "char": "a", "description": "The ID of the new team's parent team", "multiple": false, "exclusive": [ "parent_name" ] }, "parent_name": { "name": "parent_name", "type": "option", "char": "A", "description": "The name of the new team's parent team", "multiple": false, "exclusive": [ "parent_id" ] }, "open": { "name": "open", "type": "boolean", "char": "o", "description": "Open the new team in the browser", "allowNo": false }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print the team ID only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "open" ] } }, "args": {} }, "team:list": { "id": "team:list", "description": "List PagerDuty Teams", "strict": true, "usage": "team list", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Select <%= command.pdObjectNamePlural || \"objects\" %> whose names contain the given text", "multiple": false }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "limit": { "name": "limit", "type": "option", "description": "Return no more than this many entries. This option turns off table filtering options.", "multiple": false, "exclusive": [ "filter", "sort" ] }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print <%= command.pdObjectName || \"object\" %> ID's only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "columns", "sort", "csv", "extended", "json" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {}, "pdObjectName": "team", "pdObjectNamePlural": "teams" }, "team:open": { "id": "team:open", "description": "Open PagerDuty Teams in the browser", "strict": true, "usage": "team open", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Open teams matching this string.", "multiple": false, "exclusive": [ "ids", "pipe" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "The IDs of teams to open.", "multiple": true, "exclusive": [ "name", "pipe" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read team ID's from stdin.", "allowNo": false, "exclusive": [ "ids", "name" ] } }, "args": {} }, "user:create": { "id": "user:create", "description": "Create a PagerDuty User", "strict": true, "usage": "user create", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "email": { "name": "email", "type": "option", "char": "e", "description": "The user's login email", "required": true, "multiple": false }, "name": { "name": "name", "type": "option", "char": "n", "description": "The user's name", "required": true, "multiple": false }, "timezone": { "name": "timezone", "type": "option", "char": "z", "description": "The user's time zone", "multiple": false, "default": "UTC" }, "color": { "name": "color", "type": "option", "char": "c", "description": "The user's schedule color", "multiple": false }, "role": { "name": "role", "type": "option", "char": "r", "description": "The user's role", "multiple": false, "options": [ "admin", "read_only_user", "read_only_limited_user", "user", "limited_user", "observer", "restricted_access" ], "default": "user" }, "title": { "name": "title", "type": "option", "char": "t", "description": "The user's job title", "multiple": false }, "description": { "name": "description", "type": "option", "char": "d", "description": "The user's job description", "multiple": false }, "password": { "name": "password", "type": "option", "char": "w", "description": "The user's password - if not specified, a random password will be generated", "multiple": false }, "show_password": { "name": "show_password", "type": "boolean", "description": "Show the user's password when creating", "allowNo": false }, "from": { "name": "from", "type": "option", "char": "F", "description": "Login email of a PD user account for the \"From:\" header. Use only with legacy API tokens.", "multiple": false }, "open": { "name": "open", "type": "boolean", "char": "o", "description": "Open the new user in the browser", "allowNo": false }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print the user ID only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "open" ] } }, "args": {} }, "user:delete": { "id": "user:delete", "description": "Dangerous - Delete PagerDuty Users", "strict": true, "usage": "user delete", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "emails": { "name": "emails", "type": "option", "char": "e", "description": "Select users whose emails contain the given text. Specify multiple times for multiple emails.", "multiple": true }, "exact_emails": { "name": "exact_emails", "type": "option", "char": "E", "description": "Select a user whose login email is this exact text. Specify multiple times for multiple emails.", "multiple": true }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Select users with the given ID. Specify multiple times for multiple users.", "multiple": true }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read user ID's from stdin.", "allowNo": false, "exclusive": [ "email", "ids" ] }, "force": { "name": "force", "type": "boolean", "description": "\u001b[31mExtreme danger mode\u001b[39m: do not prompt before deleting", "allowNo": false } }, "args": {} }, "user:list": { "id": "user:list", "description": "List PagerDuty Users", "strict": true, "usage": "user list", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Select <%= command.pdObjectNamePlural || \"objects\" %> whose names contain the given text", "multiple": false }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "limit": { "name": "limit", "type": "option", "description": "Return no more than this many entries. This option turns off table filtering options.", "multiple": false, "exclusive": [ "filter", "sort" ] }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print <%= command.pdObjectName || \"object\" %> ID's only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "columns", "sort", "csv", "extended", "json" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] }, "email": { "name": "email", "type": "option", "char": "e", "description": "Select users whose login email addresses contain the given text", "multiple": false, "exclusive": [ "exact_email", "name" ] }, "exact_email": { "name": "exact_email", "type": "option", "char": "E", "description": "Select the user whose login email is this exact text", "multiple": false, "exclusive": [ "email", "name" ] }, "contact_country_code": { "name": "contact_country_code", "type": "option", "char": "C", "description": "Select only users with an SMS or Phone Contact method in the country (defined by the ISO 3166-1 alpha-2 country code)", "multiple": true } }, "args": {}, "pdObjectName": "user", "pdObjectNamePlural": "users" }, "user:log": { "id": "user:log", "description": "Show PagerDuty User Log Entries", "strict": true, "usage": "user log", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Select <%= command.pdObjectNamePlural || \"objects\" %> whose names contain the given text", "multiple": false }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "limit": { "name": "limit", "type": "option", "description": "Return no more than this many entries. This option turns off table filtering options.", "multiple": false, "exclusive": [ "filter", "sort" ] }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print <%= command.pdObjectName || \"object\" %> ID's only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "columns", "sort", "csv", "extended", "json" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] }, "email": { "name": "email", "type": "option", "char": "e", "description": "Select users whose login email addresses contain the given text", "multiple": false, "exclusive": [ "exact_email", "name" ] }, "exact_email": { "name": "exact_email", "type": "option", "char": "E", "description": "Select the user whose login email is this exact text", "multiple": false, "exclusive": [ "email", "name" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Select users with the given ID. Specify multiple times for multiple users.", "multiple": true }, "since": { "name": "since", "type": "option", "description": "The start of the date range over which you want to search.", "multiple": false, "default": "30 days ago" }, "until": { "name": "until", "type": "option", "description": "The end of the date range over which you want to search.", "multiple": false }, "overview": { "name": "overview", "type": "boolean", "char": "O", "description": "Get only `overview` log entries", "allowNo": false } }, "args": {} }, "user:oncall": { "id": "user:oncall", "description": "List a PagerDuty User's on call shifts.", "strict": true, "usage": "user oncall", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "me": { "name": "me", "type": "boolean", "char": "m", "description": "Show my oncalls.", "allowNo": false, "exclusive": [ "id", "email" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "Show oncalls for the user with this ID.", "multiple": false, "exclusive": [ "email", "me" ] }, "email": { "name": "email", "type": "option", "char": "e", "description": "Show oncalls for the user with this login email.", "multiple": false, "exclusive": [ "id", "me" ] }, "since": { "name": "since", "type": "option", "description": "The start of the date range over which you want to search.", "multiple": false }, "until": { "name": "until", "type": "option", "description": "The end of the date range over which you want to search.", "multiple": false }, "always": { "name": "always", "type": "boolean", "char": "a", "description": "Include 'Always on call.'", "allowNo": false }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "user:replace": { "id": "user:replace", "description": "Replace PagerDuty Users in all Schedules and Escalation Policies", "strict": true, "usage": "user replace", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Replace the given user IDs. Specify multiple times for multiple users.", "multiple": true, "exclusive": [ "deleted", "pipe" ] }, "deleted": { "name": "deleted", "type": "boolean", "char": "d", "description": "Replace all deleted users", "allowNo": false, "exclusive": [ "ids", "pipe" ] }, "user_id": { "name": "user_id", "type": "option", "char": "u", "description": "The ID of the replacement user.", "multiple": false, "exclusive": [ "user_email" ] }, "user_email": { "name": "user_email", "type": "option", "char": "U", "description": "The email of the replacement user.", "multiple": false, "exclusive": [ "user_id" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read IDs of users to replace from stdin.", "allowNo": false, "exclusive": [ "ids", "deleted" ] }, "force": { "name": "force", "type": "boolean", "description": "\u001b[31mExtreme danger mode\u001b[39m: do not prompt before updating", "allowNo": false } }, "args": {} }, "user:set": { "id": "user:set", "description": "Set PagerDuty User attributes", "strict": true, "usage": "user set", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "emails": { "name": "emails", "type": "option", "char": "e", "description": "Select users whose emails contain the given text. Specify multiple times for multiple emails.", "multiple": true }, "exact_emails": { "name": "exact_emails", "type": "option", "char": "E", "description": "Select a user whose login email is this exact text. Specify multiple times for multiple emails.", "multiple": true }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Select users with the given ID. Specify multiple times for multiple users.", "multiple": true }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Attribute keys to set. Specify multiple times to set multiple keys.", "required": true, "multiple": true }, "values": { "name": "values", "type": "option", "char": "v", "description": "Attribute values to set. To set multiple key/values, specify multiple times in the same order as the keys.", "required": true, "multiple": true }, "jsonvalues": { "name": "jsonvalues", "type": "boolean", "description": "Interpret values as JSON [default: true]", "allowNo": true }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read user ID's from stdin.", "allowNo": false, "exclusive": [ "emails", "exact_emails", "ids" ] } }, "args": {} }, "util:deleteresource": { "id": "util:deleteresource", "description": "Dangerous - Delete PagerDuty Resources", "strict": true, "usage": "util deleteresource", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "resource-type": { "name": "resource-type", "type": "option", "char": "t", "description": "The type of PagerDuty resource to delete. You have to provide either -i or -p to specify IDs of objects to delete.", "required": true, "multiple": false, "options": [ "business_service", "escalation_policy", "extension", "response_play", "ruleset", "schedule", "service", "tag", "team", "user", "webhook_subscription", "automation_action", "automation_runner", "field", "field_schema" ], "exclusive": [ "endpoint" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Select resources with the given ID. Specify multiple times for multiple resources.", "multiple": true }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read resource ID's from stdin.", "allowNo": false, "exclusive": [ "ids" ] }, "force": { "name": "force", "type": "boolean", "description": "\u001b[31mExtreme danger mode\u001b[39m: do not prompt before deleting", "allowNo": false } }, "args": {} }, "util:timestamp": { "id": "util:timestamp", "description": "Make ISO8601 timestamps", "strict": false, "usage": "util timestamp", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false } }, "args": { "date": { "name": "date", "description": "A human-style date/time, like \"4pm 1/1/2021\" or \"Dec 2 1pm\", etc. Default: now" } } }, "analytics:incident": { "id": "analytics:incident", "description": "Get PagerDuty Incident Analytics", "strict": true, "usage": "analytics incident", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "teams": { "name": "teams", "type": "option", "char": "t", "description": "Team names to include. Specify multiple times for multiple teams.", "multiple": true }, "services": { "name": "services", "type": "option", "char": "S", "description": "Service names to include. Specify multiple times for multiple services.", "multiple": true }, "major": { "name": "major", "type": "boolean", "char": "M", "description": "Include only major incidents", "allowNo": false }, "urgencies": { "name": "urgencies", "type": "option", "char": "u", "description": "Urgencies to include.", "multiple": true, "options": [ "high", "low" ], "default": [ "high", "low" ] }, "since": { "name": "since", "type": "option", "description": "The start of the date range over which you want to search.", "multiple": false, "default": "7 days ago" }, "until": { "name": "until", "type": "option", "description": "The end of the date range over which you want to search.", "multiple": false, "default": "now" }, "aggregate_unit": { "name": "aggregate_unit", "type": "option", "char": "g", "description": "The time unit to aggregate metrics by. If no value is provided, the metrics will be aggregated for the entire period.", "multiple": false, "options": [ "day", "week", "month" ] }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "analytics:incident:raw": { "id": "analytics:incident:raw", "description": "Get PagerDuty Raw Incident Analytics", "strict": true, "usage": "analytics incident raw", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "teams": { "name": "teams", "type": "option", "char": "t", "description": "Team names to include. Specify multiple times for multiple teams.", "multiple": true }, "services": { "name": "services", "type": "option", "char": "S", "description": "Service names to include. Specify multiple times for multiple services.", "multiple": true }, "major": { "name": "major", "type": "boolean", "char": "M", "description": "Include only major incidents", "allowNo": false }, "since": { "name": "since", "type": "option", "description": "The start of the date range over which you want to search.", "multiple": false }, "until": { "name": "until", "type": "option", "description": "The end of the date range over which you want to search.", "multiple": false }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "automation:action:create": { "id": "automation:action:create", "description": "Create a PagerDuty Automation Action", "strict": true, "usage": "automation action create", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "The name of the new automation action", "required": true, "multiple": false }, "description": { "name": "description", "type": "option", "char": "d", "description": "The description of the new automation action", "required": true, "multiple": false }, "classification": { "name": "classification", "type": "option", "char": "c", "description": "The classification of the new automation action", "multiple": false, "options": [ "diagnostic", "remediation" ] }, "runner_id": { "name": "runner_id", "type": "option", "char": "r", "description": "The ID of the runner to run this action", "multiple": false, "exclusive": [ "runner_name" ] }, "runner_name": { "name": "runner_name", "type": "option", "char": "R", "description": "The name of the runner to run this action", "multiple": false, "exclusive": [ "runner_id" ] }, "service_ids": { "name": "service_ids", "type": "option", "char": "s", "description": "The IDs of services whose incidents will have this action available.", "multiple": true }, "service_names": { "name": "service_names", "type": "option", "char": "S", "description": "The names of services whose incidents will have this action available.", "multiple": true }, "team_ids": { "name": "team_ids", "type": "option", "char": "t", "description": "The IDs of teams that will have access to run this action.", "multiple": true }, "team_names": { "name": "team_names", "type": "option", "char": "T", "description": "The names of teams that will have access to run this action.", "multiple": true }, "script": { "name": "script", "type": "option", "char": "x", "description": "For script actions - the body of the script to be executed on the runner.", "multiple": false, "exclusive": [ "script_from_stdin", "job_id" ] }, "script_from_stdin": { "name": "script_from_stdin", "type": "boolean", "char": "X", "description": "For script actions - read the body of the script from stdin.", "allowNo": false, "exclusive": [ "script", "job_id" ] }, "invocation_command": { "name": "invocation_command", "type": "option", "char": "i", "description": "For script actions - if the script body is not an executable file, the path to the command to run it with.", "multiple": false, "exclusive": [ "job_id" ] }, "job_id": { "name": "job_id", "type": "option", "char": "j", "description": "For process automation actions - the job ID of the job to run", "multiple": false, "exclusive": [ "script", "script_from_stdin" ] }, "job_arguments": { "name": "job_arguments", "type": "option", "description": "For process automation actions - arguments to pass to the job", "multiple": false, "dependsOn": [ "job_id" ], "aliases": [ "ja" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print the new action ID only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "open" ] }, "open": { "name": "open", "type": "boolean", "char": "o", "description": "Open the new action in the browser once it's been created", "allowNo": false } }, "args": {} }, "automation:action:list": { "id": "automation:action:list", "description": "List PagerDuty Automation Actions", "strict": true, "usage": "automation action list", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Select <%= command.pdObjectNamePlural || \"objects\" %> whose names contain the given text", "multiple": false }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "limit": { "name": "limit", "type": "option", "description": "Return no more than this many entries. This option turns off table filtering options.", "multiple": false, "exclusive": [ "filter", "sort" ] }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print <%= command.pdObjectName || \"object\" %> ID's only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "columns", "sort", "csv", "extended", "json" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {}, "pdObjectName": "automation action", "pdObjectNamePlural": "automation actions" }, "automation:runner:create": { "id": "automation:runner:create", "description": "Create a PagerDuty Automation Action", "strict": true, "usage": "automation runner create", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "The name of the new runner", "required": true, "multiple": false }, "description": { "name": "description", "type": "option", "char": "d", "description": "The description of the new runner", "required": true, "multiple": false }, "team_ids": { "name": "team_ids", "type": "option", "char": "t", "description": "The IDs of teams associated with this runner", "multiple": true }, "team_names": { "name": "team_names", "type": "option", "char": "T", "description": "The names of teams associated with this runner", "multiple": true }, "runner_type": { "name": "runner_type", "type": "option", "char": "y", "description": "The type of runner to create. Use `sidecar` to create a Process Automation runner, and `runbook` to create a Runbook Automation runner", "required": true, "multiple": false, "options": [ "sidecar", "runbook" ] }, "runbook_base_uri": { "name": "runbook_base_uri", "type": "option", "char": "u", "description": "For Runbook Automation runners, the base URI of the Runbook server to connect to", "multiple": false }, "runbook_api_key": { "name": "runbook_api_key", "type": "option", "char": "k", "description": "For Runbook Automation runners, the API key to use to connect to the Runbook server", "multiple": false }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print only the new runner credentials (for Process Automation runners) or ID (for Runbook Automation runners) to stdout.", "allowNo": false, "exclusive": [ "open" ] }, "open": { "name": "open", "type": "boolean", "char": "o", "description": "Open the new runner in the browser once it's been created", "allowNo": false } }, "args": {} }, "automation:runner:list": { "id": "automation:runner:list", "description": "List PagerDuty Automation Actions Runners", "strict": true, "usage": "automation runner list", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Select <%= command.pdObjectNamePlural || \"objects\" %> whose names contain the given text", "multiple": false }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "limit": { "name": "limit", "type": "option", "description": "Return no more than this many entries. This option turns off table filtering options.", "multiple": false, "exclusive": [ "filter", "sort" ] }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print <%= command.pdObjectName || \"object\" %> ID's only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "columns", "sort", "csv", "extended", "json" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] }, "health": { "name": "health", "type": "boolean", "description": "Also get runner health info (uses more API requests)", "allowNo": false } }, "args": {}, "pdObjectName": "runner", "pdObjectNamePlural": "runners" }, "bs:subscriber:add": { "id": "bs:subscriber:add", "description": "Add Subscribers to a PagerDuty Business Service", "strict": true, "usage": "bs subscriber add", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "Business Service ID to add subscribers to.", "multiple": false, "exclusive": [ "name" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Business Service name to add subscribers to.", "multiple": false, "exclusive": [ "id" ] }, "team_ids": { "name": "team_ids", "type": "option", "char": "t", "description": "The ID of a team to add as a subscriber. Specify multiple times for multiple teams", "multiple": true }, "team_names": { "name": "team_names", "type": "option", "char": "T", "description": "The name of a team to add as a subscriber. Specify multiple times for multiple teams", "multiple": true }, "user_ids": { "name": "user_ids", "type": "option", "char": "u", "description": "The ID of a user to add as a subscriber. Specify multiple times for multiple users", "multiple": true }, "user_emails": { "name": "user_emails", "type": "option", "char": "U", "description": "The email of a user to add as a subscriber. Specify multiple times for multiple users", "multiple": true } }, "args": {} }, "bs:subscriber:list": { "id": "bs:subscriber:list", "description": "List PagerDuty Business Service Subscribers", "strict": true, "usage": "bs subscriber list", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "Business Service ID to list subscribers for.", "multiple": false, "exclusive": [ "name" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Business Service name to list subscribers for.", "multiple": false, "exclusive": [ "id" ] }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print subscriber ID's only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "columns", "sort", "csv", "extended", "json" ] }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "bs:subscriber:remove": { "id": "bs:subscriber:remove", "description": "Remove Subscribers from a PagerDuty Business Service", "strict": true, "usage": "bs subscriber remove", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "Business Service ID to remove subscribers from.", "multiple": false, "exclusive": [ "name" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Business Service name to remove subscribers from.", "multiple": false, "exclusive": [ "id" ] }, "team_ids": { "name": "team_ids", "type": "option", "char": "t", "description": "The ID of a team to remove. Specify multiple times for multiple teams", "multiple": true }, "team_names": { "name": "team_names", "type": "option", "char": "T", "description": "The name of a team to remove. Specify multiple times for multiple teams", "multiple": true }, "user_ids": { "name": "user_ids", "type": "option", "char": "u", "description": "The ID of a user to remove. Specify multiple times for multiple users", "multiple": true }, "user_emails": { "name": "user_emails", "type": "option", "char": "U", "description": "The email of a user to remove. Specify multiple times for multiple users", "multiple": true } }, "args": {} }, "ep:level:add": { "id": "ep:level:add", "description": "Add a level to PagerDuty Escalation Policies", "strict": true, "usage": "ep level add", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Update escalation policies whose names match this string.", "multiple": false, "exclusive": [ "ids", "pipe" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "The IDs of escalation policies to update.", "multiple": true, "exclusive": [ "name", "pipe" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read escalation policy ID's from stdin.", "allowNo": false, "exclusive": [ "ids", "name" ] }, "level": { "name": "level", "type": "option", "char": "l", "description": "Escalation policy level to add (the lowest level is 1; any existing levels at or above the added level will be moved up. To add the top level, specify any number higher than the existing number of levels (e.g., 99))", "required": true, "multiple": false }, "delay": { "name": "delay", "type": "option", "char": "d", "description": "Delay in minutes before unacknowledged incidents escalate away from this level", "multiple": false, "default": 30 }, "user_ids": { "name": "user_ids", "type": "option", "char": "u", "description": "Add a target user with this ID. Specify multiple times for multiple targets.", "multiple": true }, "user_emails": { "name": "user_emails", "type": "option", "char": "U", "description": "Add a target user with this email. Specify multiple times for multiple targets.", "multiple": true }, "schedule_ids": { "name": "schedule_ids", "type": "option", "char": "s", "description": "Add a target schedule with this ID. Specify multiple times for multiple targets.", "multiple": true }, "schedule_names": { "name": "schedule_names", "type": "option", "char": "S", "description": "Add a target schedule with this name. Specify multiple times for multiple targets.", "multiple": true } }, "args": {} }, "ep:level:remove": { "id": "ep:level:remove", "description": "Remove a level from PagerDuty Escalation Policies", "strict": true, "usage": "ep level remove", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Update escalation policies whose names match this string.", "multiple": false, "exclusive": [ "ids", "pipe" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "The IDs of escalation policies to update.", "multiple": true, "exclusive": [ "name", "pipe" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read escalation policy ID's from stdin.", "allowNo": false, "exclusive": [ "ids", "name" ] }, "level": { "name": "level", "type": "option", "char": "l", "description": "Escalation policy level to remove (the lowest level is 1; any existing levels above the deleted level will be moved down.", "required": true, "multiple": false } }, "args": {} }, "ep:target:add": { "id": "ep:target:add", "description": "Add targets to PagerDuty Escalation Policies", "strict": true, "usage": "ep target add", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Update escalation policies whose names match this string.", "multiple": false, "exclusive": [ "ids", "pipe" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "The IDs of escalation policies to update.", "multiple": true, "exclusive": [ "name", "pipe" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read escalation policy ID's from stdin.", "allowNo": false, "exclusive": [ "ids", "name" ] }, "level": { "name": "level", "type": "option", "char": "l", "description": "Escalation policy level to add targets to", "required": true, "multiple": false }, "user_ids": { "name": "user_ids", "type": "option", "char": "u", "description": "Add a target user with this ID. Specify multiple times for multiple targets.", "multiple": true }, "user_emails": { "name": "user_emails", "type": "option", "char": "U", "description": "Add a target user with this email. Specify multiple times for multiple targets.", "multiple": true }, "schedule_ids": { "name": "schedule_ids", "type": "option", "char": "s", "description": "Add a target schedule with this ID. Specify multiple times for multiple targets.", "multiple": true }, "schedule_names": { "name": "schedule_names", "type": "option", "char": "S", "description": "Add a target schedule with this name. Specify multiple times for multiple targets.", "multiple": true } }, "args": {} }, "ep:target:remove": { "id": "ep:target:remove", "description": "Remove targets from PagerDuty Escalation Policies", "strict": true, "usage": "ep target remove", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Update escalation policies whose names match this string.", "multiple": false, "exclusive": [ "ids", "pipe" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "The IDs of escalation policies to update.", "multiple": true, "exclusive": [ "name", "pipe" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read escalation policy ID's from stdin.", "allowNo": false, "exclusive": [ "ids", "name" ] }, "level": { "name": "level", "type": "option", "char": "l", "description": "Escalation policy level to remove targets from", "required": true, "multiple": false }, "user_ids": { "name": "user_ids", "type": "option", "char": "u", "description": "Remove a target user with this ID. Specify multiple times for multiple targets.", "multiple": true }, "user_emails": { "name": "user_emails", "type": "option", "char": "U", "description": "Remove a target user with this email. Specify multiple times for multiple targets.", "multiple": true }, "schedule_ids": { "name": "schedule_ids", "type": "option", "char": "s", "description": "Remove a target schedule with this ID. Specify multiple times for multiple targets.", "multiple": true }, "schedule_names": { "name": "schedule_names", "type": "option", "char": "S", "description": "Remove a target schedule with this name. Specify multiple times for multiple targets.", "multiple": true } }, "args": {} }, "field:option:create": { "id": "field:option:create", "description": "Create an option for a fixed-options Custom Field", "strict": true, "usage": "field option create", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "The ID of a fixed-options Field to add an option to.", "required": true, "multiple": false }, "value": { "name": "value", "type": "option", "char": "v", "description": "The field option value to add", "required": true, "multiple": false }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print the new field option ID only to stdout, for use with pipes.", "allowNo": false } }, "args": {} }, "field:option:list": { "id": "field:option:list", "description": "List PagerDuty Custom Field Options", "strict": true, "usage": "field option list", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "The ID of a fixed-options Field to list options for.", "required": true, "multiple": false }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print field option ID's only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "columns", "sort", "csv", "extended", "json" ] }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "field:option:remove": { "id": "field:option:remove", "description": "Remove an option from a fixed-options Custom Field", "strict": true, "usage": "field option remove", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "The ID of a fixed-options Field to remove an option from.", "required": true, "multiple": false }, "option_id": { "name": "option_id", "type": "option", "char": "o", "description": "The ID of the option to remove from the field.", "required": true, "multiple": false } }, "args": {} }, "field:schema:addfield": { "id": "field:schema:addfield", "description": "Add a Field to a PagerDuty Custom Field Schema", "strict": true, "usage": "field schema addfield", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "The ID of a Field Schema to add fields to.", "required": true, "multiple": false }, "field_id": { "name": "field_id", "type": "option", "char": "f", "description": "The ID of a field to add to the schema.", "required": true, "multiple": false }, "required": { "name": "required", "type": "boolean", "char": "r", "description": "The specified field is a required field.", "allowNo": false }, "defaultvalue": { "name": "defaultvalue", "type": "option", "char": "d", "description": "Provide a default value for the field. You can specify multiple times if the field is multi-valued.", "multiple": true }, "overwrite": { "name": "overwrite", "type": "boolean", "description": "Overwrite existing configuration for this field if it is already present in the schema", "allowNo": false } }, "args": {} }, "field:schema:create": { "id": "field:schema:create", "description": "Create a PagerDuty Custom Field Schema", "strict": true, "usage": "field schema create", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "title": { "name": "title", "type": "option", "char": "t", "description": "An identifier for the schema intended primarily for scripting or other programmatic use.", "required": true, "multiple": false }, "description": { "name": "description", "type": "option", "char": "d", "description": "A human readable description for the schema", "multiple": false }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print the schema ID only to stdout, for use with pipes.", "allowNo": false } }, "args": {} }, "field:schema:list": { "id": "field:schema:list", "description": "List PagerDuty Custom Field Schemas", "strict": true, "usage": "field schema list", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print field ID's only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "columns", "sort", "csv", "extended", "json" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "field:schema:listfields": { "id": "field:schema:listfields", "description": "List Fields in a PagerDuty Custom Field Schema", "strict": true, "usage": "field schema listfields", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "The ID of the schema to show fields for", "required": true, "multiple": false }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print field ID's only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "columns", "sort", "csv", "extended", "json" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "field:schema:removefield": { "id": "field:schema:removefield", "description": "Remove a Field from a PagerDuty Custom Field Schema", "strict": true, "usage": "field schema removefield", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "The ID of the schema to delete a field from", "required": true, "multiple": false }, "field_id": { "name": "field_id", "type": "option", "char": "f", "description": "The ID of the field to remove from the schema.", "required": true, "multiple": false } }, "args": {} }, "incident:field:get": { "id": "incident:field:get", "description": "Get Custom Field Values on PagerDuty Incidents", "strict": true, "usage": "incident field get", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "me": { "name": "me", "type": "boolean", "char": "m", "description": "Show all incidents that are currently assigned to me", "allowNo": false, "exclusive": [ "ids", "pipe" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Incident ID's to show. Specify multiple times for multiple incidents.", "multiple": true, "exclusive": [ "me", "pipe" ] }, "display_name": { "name": "display_name", "type": "boolean", "char": "n", "description": "Show the display names of fields rather than their canonical names.", "allowNo": false }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read incident ID's from stdin.", "allowNo": false, "exclusive": [ "me", "ids" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\n" } }, "args": {} }, "incident:field:set": { "id": "incident:field:set", "description": "Set Custom Field Values on PagerDuty Incidents", "strict": true, "usage": "incident field set", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "me": { "name": "me", "type": "boolean", "char": "m", "description": "Update all incidents that are currently assigned to me", "allowNo": false, "exclusive": [ "ids", "pipe" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Incident ID's to update. Specify multiple times for multiple incidents.", "multiple": true, "exclusive": [ "me", "pipe" ] }, "names": { "name": "names", "type": "option", "char": "n", "description": "Custom Field names to set. Specify multiple times to set multiple fields.", "required": true, "multiple": true }, "values": { "name": "values", "type": "option", "char": "v", "description": "Custom Field values to set. To set multiple name/values, specify multiple times in the same order as the names.", "required": true, "multiple": true }, "jsonvalues": { "name": "jsonvalues", "type": "boolean", "description": "Interpret values as JSON [default: true]", "allowNo": true }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read incident ID's from stdin.", "allowNo": false, "exclusive": [ "me", "ids" ] } }, "args": {} }, "incident:responder:add": { "id": "incident:responder:add", "description": "Add Responders to PagerDuty Incidents", "strict": true, "usage": "incident responder add", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "me": { "name": "me", "type": "boolean", "char": "m", "description": "Add responders to all incidents that are currently assigned to me", "allowNo": false, "exclusive": [ "ids", "pipe" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Incident ID's to add responders to. Specify multiple times for multiple incidents.", "multiple": true, "exclusive": [ "me", "pipe" ] }, "from": { "name": "from", "type": "option", "char": "F", "description": "Login email of a PD user account for the \"From:\" header. Use only with legacy API tokens.", "multiple": false }, "user_ids": { "name": "user_ids", "type": "option", "char": "u", "description": "User ID's to add as responders. Specify multiple times for multiple users.", "multiple": true }, "user_emails": { "name": "user_emails", "type": "option", "char": "U", "description": "User emails to add as responders. Specify multiple times for multiple users.", "multiple": true }, "ep_ids": { "name": "ep_ids", "type": "option", "char": "e", "description": "Escalation policy IDs to add as responders. Specify multiple times for multiple EPs", "multiple": true }, "ep_names": { "name": "ep_names", "type": "option", "char": "E", "description": "Escalation policy names to add as responders. Specify multiple times for multiple EPs", "multiple": true }, "message": { "name": "message", "type": "option", "char": "s", "description": "A custom message to send to the responders", "multiple": false }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read incident ID's from stdin.", "allowNo": false, "exclusive": [ "me", "ids" ] } }, "args": {} }, "incident:responder:list": { "id": "incident:responder:list", "description": "List Responders on PagerDuty Incidents", "strict": true, "usage": "incident responder list", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "me": { "name": "me", "type": "boolean", "char": "m", "description": "List responders on all incidents that are currently assigned to me", "allowNo": false, "exclusive": [ "ids", "pipe" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Incident ID's to list responders on. Specify multiple times for multiple incidents.", "multiple": true, "exclusive": [ "me", "pipe" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read incident ID's from stdin.", "allowNo": false, "exclusive": [ "me", "ids" ] }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "incident:subscriber:add": { "id": "incident:subscriber:add", "description": "Add Subscribers to PagerDuty Incidents", "strict": true, "usage": "incident subscriber add", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "me": { "name": "me", "type": "boolean", "char": "m", "description": "Add subscribers to all incidents that are currently assigned to me", "allowNo": false, "exclusive": [ "ids", "pipe" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Incident ID's to add subscribers to. Specify multiple times for multiple incidents.", "multiple": true, "exclusive": [ "me", "pipe" ] }, "user_ids": { "name": "user_ids", "type": "option", "char": "u", "description": "User ID's to add as subscribers. Specify multiple times for multiple users.", "multiple": true }, "user_emails": { "name": "user_emails", "type": "option", "char": "U", "description": "User emails to add as subscribers. Specify multiple times for multiple users.", "multiple": true }, "team_ids": { "name": "team_ids", "type": "option", "char": "t", "description": "Team IDs to add as subscribers. Specify multiple times for multiple teams", "multiple": true }, "team_names": { "name": "team_names", "type": "option", "char": "T", "description": "Team names to add as subscribers. Specify multiple times for multiple teams", "multiple": true }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read incident ID's from stdin.", "allowNo": false, "exclusive": [ "me", "ids" ] } }, "args": {} }, "incident:subscriber:list": { "id": "incident:subscriber:list", "description": "List Responders on PagerDuty Incidents", "strict": true, "usage": "incident subscriber list", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "me": { "name": "me", "type": "boolean", "char": "m", "description": "List subscribers on all incidents that are currently assigned to me", "allowNo": false, "exclusive": [ "ids", "pipe" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Incident ID's to list subscribers on. Specify multiple times for multiple incidents.", "multiple": true, "exclusive": [ "me", "pipe" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read incident ID's from stdin.", "allowNo": false, "exclusive": [ "me", "ids" ] }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "incident:subscriber:remove": { "id": "incident:subscriber:remove", "description": "Remove Subscribers from PagerDuty Incidents", "strict": true, "usage": "incident subscriber remove", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "me": { "name": "me", "type": "boolean", "char": "m", "description": "Remove subscribers from all incidents that are currently assigned to me", "allowNo": false, "exclusive": [ "ids", "pipe" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Incident ID's to remove subscribers from. Specify multiple times for multiple incidents.", "multiple": true, "exclusive": [ "me", "pipe" ] }, "user_ids": { "name": "user_ids", "type": "option", "char": "u", "description": "User ID's to remove. Specify multiple times for multiple users.", "multiple": true }, "user_emails": { "name": "user_emails", "type": "option", "char": "U", "description": "User emails to remove. Specify multiple times for multiple users.", "multiple": true }, "team_ids": { "name": "team_ids", "type": "option", "char": "t", "description": "Team IDs to remove. Specify multiple times for multiple teams", "multiple": true }, "team_names": { "name": "team_names", "type": "option", "char": "T", "description": "Team names to remove. Specify multiple times for multiple teams", "multiple": true }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read incident ID's from stdin.", "allowNo": false, "exclusive": [ "me", "ids" ] } }, "args": {} }, "incident:subscriber:update": { "id": "incident:subscriber:update", "description": "Send a status update to PagerDuty Incident Subscribers", "strict": true, "usage": "incident subscriber update", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "me": { "name": "me", "type": "boolean", "char": "m", "description": "Send a status update to subscribers on all incidents that are currently assigned to me", "allowNo": false, "exclusive": [ "ids", "pipe" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "Send a status update to subscribers on these Incident ID's. Specify multiple times for multiple incidents.", "multiple": true, "exclusive": [ "me", "pipe" ] }, "from": { "name": "from", "type": "option", "char": "F", "description": "Login email of a PD user account for the \"From:\" header. Use only with legacy API tokens.", "multiple": false }, "message": { "name": "message", "type": "option", "description": "The message to be posted as a status update.", "required": true, "multiple": false }, "html_message": { "name": "html_message", "type": "option", "description": "The html content to be sent for the custom html email status update. Required if sending custom html email.", "multiple": false, "dependsOn": [ "subject" ] }, "subject": { "name": "subject", "type": "option", "description": "The subject to be sent for the custom html email status update. Required if sending custom html email.", "multiple": false, "dependsOn": [ "html_message" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Read incident ID's from stdin.", "allowNo": false, "exclusive": [ "me", "ids" ] } }, "args": {} }, "orchestration:route:add": { "id": "orchestration:route:add", "description": "Add a Route to a PagerDuty Event Orchestration", "strict": true, "usage": "orchestration route add", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "The ID of the orchestration to add a route to", "required": true, "multiple": false }, "description": { "name": "description", "type": "option", "char": "d", "description": "A human-readable description of what the route does", "multiple": false }, "conditions": { "name": "conditions", "type": "option", "char": "c", "description": "The conditions that must be true for the route action to occur", "multiple": true }, "service_id": { "name": "service_id", "type": "option", "char": "s", "description": "The ID of a PagerDuty service to route to", "multiple": false, "exclusive": [ "service_name" ] }, "service_name": { "name": "service_name", "type": "option", "char": "S", "description": "The name of a PagerDuty service to route to", "multiple": false, "exclusive": [ "service_id" ] } }, "args": {} }, "orchestration:route:delete": { "id": "orchestration:route:delete", "description": "Delete a Route from a PagerDuty Event Orchestration", "strict": true, "usage": "orchestration route delete", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "The ID of the orchestration to delete a route from", "required": true, "multiple": false }, "route_ids": { "name": "route_ids", "type": "option", "char": "r", "description": "The ID of the route to delete. Specify multiple times to delete multiple routes.", "multiple": true }, "service_ids": { "name": "service_ids", "type": "option", "char": "s", "description": "Delete routes that route to the PagerDuty service with this ID. Specify multiple times to delete multiple routes.", "multiple": true }, "service_names": { "name": "service_names", "type": "option", "char": "S", "description": "Delete routes that route to the PagerDuty service with this name. Specify multiple times to delete multiple routes.", "multiple": true } }, "args": {} }, "orchestration:route:list": { "id": "orchestration:route:list", "description": "List PagerDuty Event Orchestration Routes", "strict": true, "usage": "orchestration route list", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "The ID of the orchestration whose routes to list", "required": true, "multiple": false }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print orchestration ID's only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "columns", "sort", "csv", "extended", "json" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "schedule:override:add": { "id": "schedule:override:add", "description": "Add an override to a PagerDuty schedule.", "strict": true, "usage": "schedule override add", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "Add an override to the schedule with this ID.", "multiple": false, "exclusive": [ "name" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Add an override to the schedule with this name.", "multiple": false, "exclusive": [ "id" ] }, "start": { "name": "start", "type": "option", "description": "The start time for the override.", "multiple": false, "default": "now" }, "end": { "name": "end", "type": "option", "description": "The end time for the override.", "multiple": false, "default": "in 1 day" }, "user_id": { "name": "user_id", "type": "option", "char": "u", "description": "The ID of the PagerDuty user for the override", "multiple": false, "exclusive": [ "user_email", "me" ] }, "user_email": { "name": "user_email", "type": "option", "char": "U", "description": "The email of the PagerDuty user for the override", "multiple": false, "exclusive": [ "user_id", "me" ] }, "me": { "name": "me", "type": "boolean", "char": "m", "description": "The PagerDuty user for the override is me (use with OAuth tokens only)", "allowNo": false, "exclusive": [ "user_id", "user_email" ] } }, "args": {} }, "schedule:override:list": { "id": "schedule:override:list", "description": "List a PagerDuty Schedule's overrides.", "strict": true, "usage": "schedule override list", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "Show overrides for the schedule with this ID.", "multiple": false, "exclusive": [ "name" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Show overrides for the schedule with this name.", "multiple": false, "exclusive": [ "id" ] }, "since": { "name": "since", "type": "option", "description": "The start of the date range over which you want to search.", "multiple": false, "default": "now" }, "until": { "name": "until", "type": "option", "description": "The end of the date range over which you want to search.", "multiple": false, "default": "in 30 days" }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print override ID's only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "columns", "sort", "csv", "extended", "json" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "team:ep:add": { "id": "team:ep:add", "description": "Add PagerDuty escalation policies to Teams.", "strict": true, "usage": "team ep add", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Select teams whose names contain the given text", "multiple": false }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "The IDs of teams to add escalation policies to.", "multiple": true, "exclusive": [ "name", "pipe" ] }, "ep_ids": { "name": "ep_ids", "type": "option", "char": "e", "description": "Add an escalation policy with this ID. Specify multiple times for multiple escalation policies.", "multiple": true }, "ep_names": { "name": "ep_names", "type": "option", "char": "E", "description": "Add an escalation policy with this name. Specify multiple times for multiple escalation policies.", "multiple": true } }, "args": {} }, "team:ep:list": { "id": "team:ep:list", "description": "List the Escalation Policies for a PagerDuty Team", "strict": true, "usage": "team ep list", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Select teams whose names contain the given text", "multiple": false }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "The IDs of teams to list escalation policies for.", "multiple": true, "exclusive": [ "name", "pipe" ] }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print escalation policy ID's only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "columns", "sort", "csv", "extended", "json" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "team:ep:remove": { "id": "team:ep:remove", "description": "Remove PagerDuty escalation policies from Teams.", "strict": true, "usage": "team ep remove", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Select teams whose names contain the given text", "multiple": false }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "The IDs of teams to remove escalation policies from.", "multiple": true, "exclusive": [ "name", "pipe" ] }, "ep_ids": { "name": "ep_ids", "type": "option", "char": "e", "description": "Remove an escalation policy with this ID. Specify multiple times for multiple escalation policies.", "multiple": true }, "ep_names": { "name": "ep_names", "type": "option", "char": "E", "description": "Remove an escalation policy with this name. Specify multiple times for multiple escalation policies.", "multiple": true } }, "args": {} }, "team:user:add": { "id": "team:user:add", "description": "Add PagerDuty users to Teams. If a given user is already a member, this command will set their role on the team.", "strict": true, "usage": "team user add", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Select teams whose names contain the given text", "multiple": false }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "The IDs of teams to add members to.", "multiple": true, "exclusive": [ "name", "pipe" ] }, "user_ids": { "name": "user_ids", "type": "option", "char": "u", "description": "Add a user with this ID. Specify multiple times for multiple users.", "multiple": true }, "user_emails": { "name": "user_emails", "type": "option", "char": "U", "description": "Add a user with this email. Specify multiple times for multiple users.", "multiple": true }, "role": { "name": "role", "type": "option", "char": "r", "description": "The role of the user(s) on the team(s)", "multiple": false, "options": [ "manager", "responder", "observer" ], "default": "manager" } }, "args": {} }, "team:user:list": { "id": "team:user:list", "description": "List PagerDuty Team Members", "strict": true, "usage": "team user list", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Select teams whose names contain the given text", "multiple": false }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "The IDs of teams to list members for.", "multiple": true, "exclusive": [ "name" ] }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print user ID's only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "columns", "sort", "csv", "extended", "json" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "team:user:remove": { "id": "team:user:remove", "description": "Remove PagerDuty users from Teams", "strict": true, "usage": "team user remove", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "name": { "name": "name", "type": "option", "char": "n", "description": "Select teams whose names contain the given text", "multiple": false }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "The IDs of teams to remove members from.", "multiple": true, "exclusive": [ "name", "pipe" ] }, "user_ids": { "name": "user_ids", "type": "option", "char": "u", "description": "Remove a user with this ID. Specify multiple times for multiple users.", "multiple": true }, "user_emails": { "name": "user_emails", "type": "option", "char": "U", "description": "Remove a user with this email. Specify multiple times for multiple users.", "multiple": true } }, "args": {} }, "user:contact:add": { "id": "user:contact:add", "description": "Add a contact method to a PagerDuty user", "strict": true, "usage": "user contact add", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "Add contact to the user with this ID.", "multiple": false, "exclusive": [ "email" ] }, "email": { "name": "email", "type": "option", "char": "e", "description": "Add contact to the user with this login email.", "multiple": false, "exclusive": [ "id" ] }, "label": { "name": "label", "type": "option", "char": "l", "description": "The contact method label.", "required": true, "multiple": false }, "type": { "name": "type", "type": "option", "char": "T", "description": "The contact method type.", "required": true, "multiple": false, "options": [ "email", "phone", "sms" ] }, "address": { "name": "address", "type": "option", "char": "a", "description": "The contact method address or phone number.", "required": true, "multiple": false } }, "args": {} }, "user:contact:list": { "id": "user:contact:list", "description": "List a PagerDuty User's contact methods.", "strict": true, "usage": "user contact list", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "Show contacts for the user with this ID.", "multiple": false, "exclusive": [ "email" ] }, "email": { "name": "email", "type": "option", "char": "e", "description": "Show contacts for the user with this login email.", "multiple": false, "exclusive": [ "id" ] }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print contact ID's only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "columns", "sort", "csv", "extended", "json" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "user:contact:set": { "id": "user:contact:set", "description": "Update a contact method for a PagerDuty user", "strict": true, "usage": "user contact set", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "Update a contact for the user with this ID.", "multiple": false, "exclusive": [ "email" ] }, "email": { "name": "email", "type": "option", "char": "e", "description": "Update a contact for the user with this login email.", "multiple": false, "exclusive": [ "id" ] }, "contact_id": { "name": "contact_id", "type": "option", "char": "c", "description": "Update the contact with this ID.", "required": true, "multiple": false }, "label": { "name": "label", "type": "option", "char": "l", "description": "The contact method label to set.", "multiple": false }, "address": { "name": "address", "type": "option", "char": "a", "description": "The contact method address or phone number to set.", "multiple": false } }, "args": {} }, "user:session:list": { "id": "user:session:list", "description": "List a PagerDuty User's sessions.", "strict": true, "usage": "user session list", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "Show sessions for the user with this ID.", "multiple": false, "exclusive": [ "email" ] }, "email": { "name": "email", "type": "option", "char": "e", "description": "Show sessions for the user with this login email.", "multiple": false, "exclusive": [ "id" ] }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\\n" }, "since": { "name": "since", "type": "option", "description": "The start of the date range over which you want to search.", "multiple": false }, "until": { "name": "until", "type": "option", "description": "The end of the date range over which you want to search.", "multiple": false }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "pipe": { "name": "pipe", "type": "boolean", "char": "p", "description": "Print session ID's only to stdout, for use with pipes.", "allowNo": false, "exclusive": [ "columns", "sort", "csv", "extended", "json" ] }, "query": { "name": "query", "type": "option", "char": "q", "description": "Query the API output", "multiple": false }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "field:schema:assignment:create": { "id": "field:schema:assignment:create", "description": "Create a PagerDuty Custom Field Schema Assignment", "strict": true, "usage": "field schema assignment create", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "The ID of a Field Schema to assign.", "required": true, "multiple": false }, "service_id": { "name": "service_id", "type": "option", "char": "s", "description": "The ID of a service to assign the schema to.", "required": true, "multiple": false } }, "args": {} }, "field:schema:assignment:list": { "id": "field:schema:assignment:list", "description": "List PagerDuty Custom Field Schema Service Assignments", "strict": true, "usage": "field schema assignment list", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "ids": { "name": "ids", "type": "option", "char": "i", "description": "A schema ID to list assignments for. Specify multiple times for multiple schemas.", "multiple": true }, "service_ids": { "name": "service_ids", "type": "option", "char": "s", "description": "A service ID to list assignments for. Specify multiple times for multiple services.", "multiple": true }, "keys": { "name": "keys", "type": "option", "char": "k", "description": "Additional fields to display. Specify multiple times for multiple fields.", "multiple": true }, "json": { "name": "json", "type": "boolean", "char": "j", "description": "output full details as JSON", "allowNo": false, "exclusive": [ "columns", "filter", "sort", "csv", "extended" ] }, "delimiter": { "name": "delimiter", "type": "option", "char": "d", "description": "Delimiter for fields that have more than one value", "multiple": false, "default": "\n" }, "columns": { "name": "columns", "type": "option", "description": "only show provided columns (comma-separated)", "multiple": false, "exclusive": [ "extended" ] }, "sort": { "name": "sort", "type": "option", "description": "property to sort by (prepend '-' for descending)", "multiple": false }, "filter": { "name": "filter", "type": "option", "description": "filter property by partial string matching, ex: name=foo", "multiple": false }, "csv": { "name": "csv", "type": "boolean", "description": "output is csv format [alias: --output=csv]", "allowNo": false, "exclusive": [ "no-truncate" ] }, "output": { "name": "output", "type": "option", "description": "output in a more machine friendly format", "multiple": false, "options": [ "csv", "json", "yaml" ], "exclusive": [ "no-truncate", "csv" ] }, "extended": { "name": "extended", "type": "boolean", "char": "x", "description": "show extra columns", "allowNo": false, "exclusive": [ "columns" ] }, "no-truncate": { "name": "no-truncate", "type": "boolean", "description": "do not truncate output to fit screen", "allowNo": false, "exclusive": [ "csv" ] }, "no-header": { "name": "no-header", "type": "boolean", "description": "hide table header from output", "allowNo": false, "exclusive": [ "csv" ] } }, "args": {} }, "field:schema:assignment:remove": { "id": "field:schema:assignment:remove", "description": "Remove a PagerDuty Custom Field Schema Assignment", "strict": true, "usage": "field schema assignment remove", "pluginName": "pagerduty-cli", "pluginAlias": "pagerduty-cli", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "debug": { "name": "debug", "type": "boolean", "description": "Print REST API call debug logs", "allowNo": false }, "useauth": { "name": "useauth", "type": "option", "char": "b", "description": "Use the saved REST API token with this alias", "multiple": false }, "token": { "name": "token", "type": "option", "description": "Ignore the saved configuration and use this token", "multiple": false, "exclusive": [ "useauth" ] }, "id": { "name": "id", "type": "option", "char": "i", "description": "The ID of a Field Schema Assignment to remove.", "required": true, "multiple": false } }, "args": {} } } }