{
"name": "vercel",
"description": "CLI Interface for Vercel.com",
"subcommands": [
{
"name": "deploy",
"description": "Performs a deployment (default)",
"args": [
{
"template": "folders"
}
]
},
{
"name": "dev",
"description": "Start a local development server",
"options": [
{
"names": [
"--listen"
],
"description": "Specifies which port to run on"
}
]
},
{
"name": "env",
"description": "Manages the Environment Variables for your current Project",
"subcommands": [
{
"name": "add",
"description": "Add an environment variable",
"args": [
{
"name": "name",
"description": "Name of the env variable to add"
},
{
"name": "environment",
"description": "Environment to add the variable to",
"suggestions": [
"production",
"preview",
"development"
]
}
]
},
{
"name": "rm",
"description": "Remove an environment variable",
"args": [
{
"name": "name",
"description": "Name of the variable to remove"
},
{
"name": "environment",
"description": "Environment to remove from",
"suggestions": [
"production",
"preview",
"development"
]
}
]
},
{
"name": "pull",
"description": "Download dev env variables from cloud and write to .env",
"args": [
{
"name": "file",
"description": "The file to write downloaded variables to",
"template": "filepaths"
}
]
},
{
"name": "ls",
"description": "List environment variables for a specific environment",
"args": [
{
"name": "environment",
"description": "Environment to list variables for"
}
]
}
]
},
{
"name": "init",
"description": "Initialize an example project",
"args": [
{
"name": "project name",
"description": "Project name to initialize locally"
},
{
"name": "new project name",
"description": "Initialize specific project locally and rename directory"
}
]
},
{
"name": "list",
"description": "Lists deployments",
"options": [
{
"names": [
"-m",
"--meta"
],
"description": "Filters results based on project metadata",
"takes_arg": true,
"arg": {
"is_variadic": true
}
}
],
"args": [
{
"name": "project name",
"description": "View deployments for specified project"
}
]
},
{
"name": "ls",
"description": "Lists deployments",
"args": [
{
"name": "project name",
"description": "View deployments for specified project"
}
]
},
{
"name": "inspect",
"description": "Displays information related to a deployment",
"args": [
{
"name": "url",
"description": "The URL of the deployment to inspect"
}
]
},
{
"name": "login",
"description": "Logs into your account or creates a new one"
},
{
"name": "logout",
"description": "Logs out of your account"
},
{
"name": "switch",
"description": "Switches between teams and your personal account",
"args": [
{
"name": "team name",
"description": "Team to switch to"
}
]
},
{
"name": "help",
"description": "Displays complete help for [cmd]",
"args": [
{
"name": "command",
"description": "Command to detailed information about"
}
]
},
{
"name": "rm",
"description": "Removes a deployment",
"options": [
{
"names": [
"-s",
"--safe"
],
"description": "Skip removal of deployments with an active preview URL or production domain"
},
{
"names": [
"-y",
"--yes"
],
"description": "Skip confirmation step for a deployment or project removal"
}
],
"args": [
{
"name": "deployment url",
"description": "URL of the deployment to remove"
}
]
},
{
"name": "remove",
"description": "Removes a deployment",
"args": [
{
"name": "deployment url",
"description": "URL of the deployment to remove"
}
]
},
{
"name": "domains",
"description": "Manages your domain names",
"subcommands": [
{
"name": "ls",
"description": "List all domains under an account"
},
{
"name": "inspect",
"description": "Retrieves information about a domain",
"args": [
{
"name": "domain",
"description": "Domain to inspect"
}
]
},
{
"name": "add",
"description": "Add a domain to an account",
"args": [
{
"name": "domain",
"description": "Domain to add"
}
]
},
{
"name": "rm",
"description": "Removes a domain from an account",
"args": [
{
"name": "domain",
"description": "Domain to remove"
}
]
},
{
"name": "buy",
"description": "Buy a domain for an account",
"args": [
{
"name": "domain",
"description": "Domain to buy"
}
]
},
{
"name": "move",
"description": "Removes a domain from an account",
"args": [
{
"name": "domain",
"description": "Domain to move"
},
{
"name": "account name",
"description": "Account to move the domain to"
}
]
},
{
"name": "transfer-in",
"description": "Transfers in a domain to an account",
"args": [
{
"name": "domain",
"description": "Domain to transfer in"
}
]
},
{
"name": "verify",
"description": "Verifies a domain for an account",
"args": [
{
"name": "domain",
"description": "Domain to verify"
}
]
}
]
},
{
"name": "dns",
"description": "Manages your DNS records",
"subcommands": [
{
"name": "add",
"description": "Add DNS record for a domain",
"args": [
{
"name": "domain",
"description": "Domain to add record to"
},
{
"name": "subdomain",
"description": "Subdomain to add record to"
},
{
"name": "record type",
"description": "Type of record to add",
"suggestions": [
"A",
"AAAA",
"ALIAS",
"CNAME",
"TXT"
]
},
{
"name": "value",
"description": "Record value"
}
]
}
]
},
{
"name": "certs",
"description": "Manages your SSL certificates",
"subcommands": [
{
"name": "ls",
"description": "List all certificates under an account"
},
{
"name": "issue",
"description": "Issue certificates for multiple domains",
"args": [
{
"name": "Domains",
"description": "List of domains separated by commas to issue certificates for",
"is_variadic": true
}
]
},
{
"name": "rm",
"description": "Remove a certificate by id",
"args": [
{
"name": "certificate id",
"description": "Id of the certificate to remove"
}
]
}
],
"options": [
{
"names": [
"--challenge-only"
],
"description": "Show challenges needed to issue a certificate"
},
{
"names": [
"--crt"
],
"description": "Include path to .crt",
"takes_arg": true,
"arg": {
"template": "filepaths"
}
},
{
"names": [
"--key"
],
"description": "Include path to .key",
"takes_arg": true,
"arg": {
"template": "filepaths"
}
},
{
"names": [
"--ca"
],
"description": "Include path to .ca",
"takes_arg": true,
"arg": {
"template": "filepaths"
}
}
]
},
{
"name": "secrets",
"description": "Manages your global Secrets, for use in Environment Variables",
"subcommands": [
{
"name": "list",
"description": "List all secrets"
},
{
"name": "add",
"description": "Add a new secret",
"args": [
{
"name": "secret name",
"description": "Name of the secret to add"
},
{
"name": "secret value",
"description": "Value of the secret to add"
}
]
},
{
"name": "rename",
"description": "Rename a secret",
"args": [
{
"name": "old name",
"description": "Old name of the secret to rename"
},
{
"name": "new name",
"description": "New name of the secret"
}
]
},
{
"name": "remove",
"description": "Remove a secret",
"args": [
{
"name": "secret name",
"description": "Name of the seret to remove"
}
]
}
]
},
{
"name": "logs",
"description": "Displays the logs for a deployment",
"options": [
{
"names": [
"-a",
"--all"
],
"description": "Receive access logs in addition to regular logs"
},
{
"names": [
"-f",
"--follow"
],
"description": "Watch for additional logs output"
},
{
"names": [
"-n",
"--number"
],
"description": "Specify number of log lines to output",
"takes_arg": true
},
{
"names": [
"-o",
"--output"
],
"description": "Specifies format of logs output as 'short' or 'raw'",
"takes_arg": true
},
{
"names": [
"--since"
],
"description": "Return logs after a specific ISO 8601 date",
"takes_arg": true
},
{
"names": [
"-q",
"--query"
],
"description": "Return logs against a search query",
"takes_arg": true
},
{
"names": [
"--until"
],
"description": "Return logs up to a specific ISO 8601 date",
"takes_arg": true
}
],
"args": [
{
"name": "deployment url",
"description": "Get logs for specified deployment"
}
]
},
{
"name": "teams",
"description": "Manages your teams",
"subcommands": [
{
"name": "list",
"description": "List all teams under an account"
},
{
"name": "add",
"description": "Create a new team"
},
{
"name": "invite",
"description": "Invite a new member to the team",
"args": [
{
"name": "email",
"description": "Email of member to invite to team"
}
]
}
]
},
{
"name": "whoami",
"description": "Shows the username of the currently logged in user"
},
{
"name": "alias",
"description": "Apply custom domains based on git branches, or other heuristics",
"subcommands": [
{
"name": "set",
"description": "Assign a custom domain to a deployment",
"args": [
{
"name": "url",
"description": "The URL of the deployment to assign to a domain"
},
{
"name": "domain",
"description": "The domain you want to assign to"
}
]
},
{
"name": "rm",
"description": "Remove a custom domain from a deployment",
"args": [
{
"name": "domain",
"description": "The domain to remove"
}
]
},
{
"name": "ls",
"description": "List custom domains that were assigned to deployments"
}
]
},
{
"name": "link",
"description": "Links your local directory to a Project",
"args": [
{
"name": "directory",
"template": "folders"
}
]
},
{
"name": "billing",
"description": "Manage payment methods",
"subcommands": [
{
"name": "ls",
"description": "List all the payment methods of the active account"
},
{
"name": "add",
"description": "Interactively add a new credit card"
},
{
"name": "rm",
"description": "Remove a credit card by ID",
"args": [
{
"name": "id",
"description": "The id of the card to remove"
}
]
},
{
"name": "set-default",
"description": "Select which credit card should be default",
"args": [
{
"name": "id",
"description": "The id of the card to set default"
}
]
}
]
}
],
"options": [
{
"names": [
"-h",
"--help"
],
"description": "Output usage information"
},
{
"names": [
"-v",
"--version"
],
"description": "Output the version number"
},
{
"names": [
"-V",
"--platform-version"
],
"description": "Set the platform version to deploy to"
},
{
"names": [
"-A",
"--local-config"
],
"description": "Path to the local 'vercel.json' file",
"takes_arg": true,
"arg": {
"template": "filepaths"
}
},
{
"names": [
"-Q",
"--global-config"
],
"description": "Path to the global '.vercel' directory",
"takes_arg": true,
"arg": {
"template": "folders"
}
},
{
"names": [
"-d",
"--debug"
],
"description": "Provides more verbose output"
},
{
"names": [
"-f",
"--force"
],
"description": "Force a new deployment even if nothing has changed"
},
{
"names": [
"-with-cache"
],
"description": "Retain build cache when using --force"
},
{
"names": [
"-t",
"--token"
],
"description": "Execute command with an auth token",
"takes_arg": true,
"arg": {
"name": "auth token",
"description": "Auth token to add to your command"
}
},
{
"names": [
"-p",
"--public"
],
"description": "Deployment is public ('/_src' is exposed)"
},
{
"names": [
"-e",
"--env"
],
"description": "Include an env var during run time (e.g.: '-e KEY=value'). Can appear many times"
},
{
"names": [
"-b",
"--build-env"
],
"description": "Similar to `--env` but for build time only"
},
{
"names": [
"-m",
"--meta"
],
"description": "Add metadata for the deployment (e.g.: `-m KEY=value`). Can appear many times"
},
{
"names": [
"-C",
"--no-clipboard"
],
"description": "Do not attempt to copy URL to clipboard"
},
{
"names": [
"-S",
"--scope"
],
"description": "Set a custom scope",
"takes_arg": true,
"arg": {
"name": "team name",
"description": "Team to execute commands from"
}
},
{
"names": [
"--regions"
],
"description": "Set default regions to enable the deployment on"
},
{
"names": [
"--prod"
],
"description": "Create a production deployment"
},
{
"names": [
"-c",
"--confirm"
],
"description": "Confirm default options and skip questions"
}
],
"args": [
{
"name": "path to project",
"template": "folders"
}
]
}