ask-cli/lib/commands/option-model.json

Alexa Skills Kit (ASK) Command Line Interfaces

{
  "profile": {
    "name": "profile",
    "description": "Provides the ASK CLI profile to use. When you don't include this option, ASK CLI uses the default profile.",
    "alias": "p",
    "stringInput": "REQUIRED"
  },
  "debug": {
    "name": "debug",
    "description": "Enables the ASK CLI  to show debug messages in the output of the command.",
    "alias": null,
    "stringInput": "NONE"
  },
  "full-response": {
    "name": "full-response",
    "description": "Returns body, headers and status code of the response as one object.",
    "alias": null,
    "stringInput": "NONE"
  },
  "ignore-hash": {
    "name": "ignore-hash",
    "description": "Forces ASK CLI deploy skill package even if the hash of current skill package folder does not change.",
    "alias": null,
    "stringInput": "NONE"
  },
  "no-browser": {
    "name": "no-browser",
    "description": "ASK CLI displays a URL that you can use to sign in with your Amazon developer account from anywhere",
    "alias": null,
    "stringInput": "NONE"
  },
  "skill-id": {
    "name": "skill-id",
    "description": "The skill ID.",
    "alias": "s",
    "stringInput": "REQUIRED"
  },
  "replay": {
    "name": "replay",
    "description": "Specify a replay file to simulate dialog with Alexa",
    "alias": "r",
    "stringInput": "REQUIRED",
    "rule": [{
      "type": "REGEX",
      "regex": "^[./]?[\\w\\-. /]+\\.(json)"
    }]
  },
  "hosted-skill-id": {
    "name": "hosted-skill-id",
    "description": "skill-id for the Alexa hosted skill",
    "alias": null,
    "stringInput": "REQUIRED"
  },
  "stage": {
    "name": "stage",
    "description": "Stage for skill.",
    "alias": "g",
    "stringInput": "REQUIRED",
    "rule": [{
      "type": "ENUM",
      "values": ["development", "live", "certification"]
    }]
  },
  "locale": {
    "name": "locale",
    "description": "Locale value for the resource",
    "alias": "l",
    "stringInput": "REQUIRED",
    "rule": [{
      "type": "REGEX",
      "regex": "^[a-z]{2}-[A-Z]{2}$"
    }]
  },
  "templateUrl": {
    "name": "template-url",
    "description": "Url for the template to be used with",
    "alias": null,
    "stringInput": "REQUIRED"
  },
  "templateBranch": {
    "name": "template-branch",
    "description": "Git branch used with the template url",
    "alias": null,
    "stringInput": "REQUIRED"
  },
  "file": {
    "name": "file",
    "description": "Path to the target file input",
    "alias": "f",
    "stringInput": "REQUIRED",
    "rule": [{
      "type": "FILE_PATH"
    }]
  },
  "max-results": {
    "name": "max-results",
    "description": "Max results returned by the request",
    "alias": null,
    "stringInput": "REQUIRED",
    "rule": [{
      "type": "INTEGER"
    }]
  },
  "next-token": {
    "name": "next-token",
    "description": "Next token if the result is paginated",
    "alias": null,
    "stringInput": "REQUIRED"
  },
  "etag": {
    "name": "etag",
    "description": "The eTag from the resource's last update",
    "alias": null,
    "stringInput": "REQUIRED"
  },
  "catalog-id": {
    "name": "catalog-id",
    "description": "Unique identifier of the catalog",
    "alias": "c",
    "stringInput": "REQUIRED"
  },
  "scopes": {
    "name": "scopes",
    "description": "Request with particular scope(s) from Login with Amazon, delimited by space",
    "alias": null,
    "stringInput": "REQUIRED"
  },
  "client-confirmation": {
    "name": "client-confirmation",
    "description": "The client-secret when registering LWA application, uses CLI's default if not set",
    "alias": null,
    "stringInput": "REQUIRED"
  },
  "client-id": {
    "name": "client-id",
    "description": "The client-id when registering LWA application, uses CLI's default if not set",
    "alias": null,
    "stringInput": "REQUIRED"
  },
  "task-name": {
    "name": "task-name",
    "description": "Name of a task.",
    "stringInput": "REQUIRED"
  },
  "task-version": {
    "name": "task-version",
    "description": "Version of a task. For example: 1, 2, 3 and so on.",
    "stringInput": "REQUIRED"
  },
  "provider-skill-id": {
    "name": "provider-skill-id",
    "description": "Task provider skill id. When this is specified, we will only fetch the tasks from this given skill ID.",
    "stringInput": "OPTIONAL"
  },
  "keywords": {
    "name": "keywords",
    "description": "Keywords can be description of tasks, task name or tags in task definition.\n[MULTIPLE]: Values can be separated by comma.",
    "stringInput": "OPTIONAL"
  }
}