netlify-cli 8.1.0-rc.1 → 8.1.0-rc.2

package/README.md

@@ -20,6 +20,7 @@ See the [CLI command line reference](https://cli.netlify.com/commands/) to get s
   - [addons](#addons)
   - [api](#api)
   - [build](#build)
+  - [completion](#completion)
   - [deploy](#deploy)
   - [dev](#dev)
   - [env](#env)
@@ -34,7 +35,6 @@ See the [CLI command line reference](https://cli.netlify.com/commands/) to get s
   - [switch](#switch)
   - [unlink](#unlink)
   - [watch](#watch)
-  - [completion](#completion)
 - [Contributing](#contributing)
 - [Development](#development)
 - [License](#license)
@@ -102,6 +102,15 @@ Run any Netlify API method
 
 (Beta) Build on your local machine
 
+### [completion](/docs/commands/completion.md)
+
+(Beta) Generate shell completion script
+
+| Subcommand | description  |
+|:--------------------------- |:-----|
+| [`completion:generate`](/docs/commands/completion.md#completiongenerate) | Generates completion script  |
+
+
 ### [deploy](/docs/commands/deploy.md)
 
 Create a new deploy from the contents of a folder
@@ -157,8 +166,8 @@ Handle Netlify Large Media operations
 | Subcommand | description  |
 |:--------------------------- |:-----|
 | [`lm:info`](/docs/commands/lm.md#lminfo) | Show large media requirements information.  |
-| [`lm:install`](/docs/commands/lm.md#lminstall) | Configures your computer to use Netlify Large Media.  |
-| [`lm:setup`](/docs/commands/lm.md#lmsetup) | Configures your site to use Netlify Large Media.  |
+| [`lm:install`](/docs/commands/lm.md#lminstall) | Configures your computer to use Netlify Large Media  |
+| [`lm:setup`](/docs/commands/lm.md#lmsetup) | Configures your site to use Netlify Large Media  |
 
 
 ### [login](/docs/commands/login.md)
@@ -207,16 +216,6 @@ Unlink a local folder from a Netlify site
 
 Watch for site deploy to finish
 
-### [completion](/docs/commands/completion.md)
-
-(Beta) Generate shell completion script
-
-| Subcommand | description  |
-|:--------------------------- |:-----|
-| [`completion:generate:alias`](/docs/commands/completion.md#completiongeneratealias) | Generates completion script for alias  |
-| [`completion:generate`](/docs/commands/completion.md#completiongenerate) | Generates completion script  |
-
-
 
 <!-- AUTO-GENERATED-CONTENT:END -->
 

package/bin/run

@@ -4,27 +4,7 @@ const process = require('process')
 
 const updateNotifier = require('update-notifier')
 
-const { createAddonsCommand } = require('../src/commands/addons')
-const { createApiCommand } = require('../src/commands/api')
-const { BaseCommand } = require('../src/commands/base-command')
-const { createBuildCommand } = require('../src/commands/build')
-const { createCompletionCommand } = require('../src/commands/completion')
-const { createDeployCommand } = require('../src/commands/deploy')
-const { createDevCommand } = require('../src/commands/dev')
-const { createEnvCommand } = require('../src/commands/env')
-const { createFunctionsCommand } = require('../src/commands/functions')
-const { createInitCommand } = require('../src/commands/init')
-const { createLinkCommand } = require('../src/commands/link')
-const { createLmCommand } = require('../src/commands/lm')
-const { createLoginCommand } = require('../src/commands/login')
-const { createLogoutCommand } = require('../src/commands/logout')
-const { createMainCommand } = require('../src/commands/main')
-const { createOpenCommand } = require('../src/commands/open')
-const { createSitesCommand } = require('../src/commands/sites')
-const { createStatusCommand } = require('../src/commands/status')
-const { createSwitchCommand } = require('../src/commands/switch')
-const { createUnlinkCommand } = require('../src/commands/unlink')
-const { createWatchCommand } = require('../src/commands/watch')
+const { createMainCommand } = require('../src/commands')
 
 // 12 hours
 const UPDATE_CHECK_INTERVAL = 432e5
@@ -43,36 +23,14 @@ if (require.main === module) {
     console.log(error)
   }
 
-  const program = new BaseCommand('netlify')
-
-  createAddonsCommand(program)
-  createApiCommand(program)
-  createBuildCommand(program)
-  createCompletionCommand(program)
-  createDeployCommand(program)
-  createDevCommand(program)
-  createEnvCommand(program)
-  createFunctionsCommand(program)
-  createInitCommand(program)
-  createLinkCommand(program)
-  createLmCommand(program)
-  createLoginCommand(program)
-  createLogoutCommand(program)
-  createOpenCommand(program)
-  createSitesCommand(program)
-  createStatusCommand(program)
-  createSwitchCommand(program)
-  createUnlinkCommand(program)
-  createWatchCommand(program)
-
   /** @type {Error} */
   let caughtError
 
-  createMainCommand(program)
-    .then(() => program.parseAsync(process.argv))
-    .catch((error) => {
-      caughtError = error
-    })
+  const program = createMainCommand()
+
+  program.parseAsync(process.argv).catch((error) => {
+    caughtError = error
+  })
 
   // long running commands like dev server cannot be caught by a post action hook
   // they are running on the main command

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "netlify-cli",
-  "version": "8.1.0-rc.1",
+  "version": "8.1.0-rc.2",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "netlify-cli",
-      "version": "8.1.0-rc.1",
+      "version": "8.1.0-rc.2",
       "hasInstallScript": true,
       "license": "MIT",
       "dependencies": {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "netlify-cli",
   "description": "Netlify command line tool",
-  "version": "8.1.0-rc.1",
+  "version": "8.1.0-rc.2",
   "author": "Netlify Inc.",
   "contributors": [
     "Mathias Biilmann <matt@netlify.com> (https://twitter.com/biilmann)",
@@ -215,6 +215,7 @@
   },
   "ava": {
     "files": [
+      "site/**/*.test.js",
       "src/**/*.test.js",
       "tools/**/*.test.js",
       "tests/*.test.js"

package/src/commands/addons/addons-create.js

@@ -2,7 +2,7 @@
 const inquirer = require('inquirer')
 const isEmpty = require('lodash/isEmpty')
 
-const { chalk, error, generateDescriptionHelp, log, parseRawFlags } = require('../../utils')
+const { chalk, error, log, parseRawFlags } = require('../../utils')
 const { ADDON_VALIDATION, prepareAddonCommand } = require('../../utils/addons/prepare')
 const generatePrompts = require('../../utils/addons/prompts')
 const render = require('../../utils/addons/render')
@@ -118,10 +118,12 @@ const createAddonsCreateCommand = (program) =>
     .command('addons:create')
     .alias('addon:create')
     .argument('<name>', 'Add-on namespace')
-    .description('Add an add-on extension to your site')
+    .description(
+      `Add an add-on extension to your site
+Add-ons are a way to extend the functionality of your Netlify site`,
+    )
     // allow for any flags. Handy for variadic configuration options
     .allowUnknownOption(true)
-    .addHelpText('after', generateDescriptionHelp('Add-ons are a way to extend the functionality of your Netlify site'))
     .action(async (addonName, options, command) => {
       await addonsCreate(addonName, options, command)
     })

package/src/commands/addons/addons-delete.js

@@ -1,7 +1,7 @@
 // @ts-check
 const inquirer = require('inquirer')
 
-const { error, exit, generateDescriptionHelp, log } = require('../../utils')
+const { error, exit, log } = require('../../utils')
 const { ADDON_VALIDATION, prepareAddonCommand } = require('../../utils/addons/prepare')
 
 /**
@@ -51,9 +51,10 @@ const createAddonsDeleteCommand = (program) =>
     .command('addons:delete')
     .alias('addon:delete')
     .argument('<name>', 'Add-on namespace')
-    .description('Remove an add-on extension to your site')
+    .description(
+      `Remove an add-on extension to your site\nAdd-ons are a way to extend the functionality of your Netlify site`,
+    )
     .option('-f, --force', 'delete without prompting (useful for CI)')
-    .addHelpText('after', generateDescriptionHelp('Add-ons are a way to extend the functionality of your Netlify site'))
     .action(addonsDelete)
 
 module.exports = { createAddonsDeleteCommand }

package/src/commands/addons/addons.js

@@ -1,7 +1,5 @@
 // @ts-check
 
-const { generateExamplesHelp } = require('../../utils')
-
 const { createAddonsAuthCommand } = require('./addons-auth')
 const { createAddonsConfigCommand } = require('./addons-config')
 const { createAddonsCreateCommand } = require('./addons-create')
@@ -34,16 +32,13 @@ const createAddonsCommand = (program) => {
     .alias('addon')
     .description('(Beta) Manage Netlify Add-ons')
     .noHelpOptions()
-    .addHelpText(
-      'after',
-      generateExamplesHelp([
-        'netlify addons:create addon-xyz',
-        'netlify addons:list',
-        'netlify addons:config addon-xyz',
-        'netlify addons:delete addon-xyz',
-        'netlify addons:auth addon-xyz',
-      ]),
-    )
+    .addExamples([
+      'netlify addons:create addon-xyz',
+      'netlify addons:list',
+      'netlify addons:config addon-xyz',
+      'netlify addons:delete addon-xyz',
+      'netlify addons:auth addon-xyz',
+    ])
     .action(addons)
 }
 module.exports = { createAddonsCommand }

package/src/commands/api/api.js

@@ -4,7 +4,7 @@ const AsciiTable = require('ascii-table')
 // TODO: use static `import` after migrating this repository to pure ES modules
 const jsClient = import('netlify')
 
-const { chalk, error, exit, generateDescriptionHelp, generateExamplesHelp, log, logJson } = require('../../utils')
+const { chalk, error, exit, log, logJson } = require('../../utils')
 
 /**
  * The api command
@@ -60,25 +60,16 @@ const apiCommand = async (apiMethod, options, command) => {
 const createApiCommand = (program) =>
   program
     .command('api')
-    .argument('[method]', 'Open API method to run')
-    .description('Run any Netlify API method')
-    .option('-d, --data <data>', 'Data to use')
-    .option('--list', 'List out available API methods', false)
-    .addHelpText(
-      'after',
-      generateDescriptionHelp(
-        `For more information on available methods checkout https://open-api.netlify.com/ or run '${chalk.grey(
-          'netlify api --list',
-        )}'`,
-      ),
-    )
-    .addHelpText(
-      'after',
-      generateExamplesHelp([
+    .argument('[apiMethod]', 'Open API method to run')
+    .description(
+      `Run any Netlify API method
+For more information on available methods checkout https://open-api.netlify.com/ or run '${chalk.grey(
         'netlify api --list',
-        `netlify api getSite --data '${chalk.grey('{ "site_id": "123456"}')}'`,
-      ]),
+      )}'`,
     )
+    .option('-d, --data <data>', 'Data to use')
+    .option('--list', 'List out available API methods', false)
+    .addExamples(['netlify api --list', `netlify api getSite --data '{ "site_id": "123456" }'`])
     .action(apiCommand)
 
 module.exports = { createApiCommand }

package/src/commands/base-command.js

@@ -3,7 +3,7 @@ const process = require('process')
 const { format } = require('util')
 
 const resolveConfig = require('@netlify/config')
-const { Command } = require('commander')
+const { Command, Option } = require('commander')
 const debug = require('debug')
 const merge = require('lodash/merge')
 
@@ -12,15 +12,12 @@ const jsClient = import('netlify')
 
 const { getAgent } = require('../lib/http-agent')
 const {
-  HELP_$,
-  HELP_INDENT_WIDTH,
-  HELP_SEPERATOR_WIDTH,
+  NETLIFY_CYAN,
   StateConfig,
   USER_AGENT,
   chalk,
   error,
   exit,
-  formatHelpList,
   getGlobalConfig,
   getToken,
   identify,
@@ -39,8 +36,22 @@ const CLIENT_ID = 'd6f37de6614df7ae58664cfca524744d73807a377f5ee71f1a254f78412e3
 const NANO_SECS_TO_MSECS = 1e6
 // The fallback width for the help terminal
 const FALLBACK_HELP_CMD_WIDTH = 80
-// AN option description that should be hidden in the help page
-const OPTION_HIDDEN_DESCRIPTION = 'hidden:true'
+
+const HELP_$ = NETLIFY_CYAN('$')
+// indent on commands or description on the help page
+const HELP_INDENT_WIDTH = 2
+// seperator width between term and description
+const HELP_SEPERATOR_WIDTH = 5
+
+/**
+ * Formats a help list correctly with the correct indent
+ * @param {string[]} textArray
+ * @returns
+ */
+const formatHelpList = (textArray) => textArray.join('\n').replace(/^/gm, ' '.repeat(HELP_INDENT_WIDTH))
+
+/** A list of base command flags that needs to be sorted down on documentation and on help pages */
+const BASE_FLAGS = new Set(['--debug', '--httpProxy', '--httpProxyCertificateFilename'])
 
 /**
  * Get the duration between a start time and the current time
@@ -87,29 +98,21 @@ class BaseCommand extends Command {
     return (
       new BaseCommand(name)
         // If  --silent or --json flag passed disable logger
-        .option('--json', OPTION_HIDDEN_DESCRIPTION)
-        .option('--cwd <cwd>', OPTION_HIDDEN_DESCRIPTION)
-        .option('-o, --offline', OPTION_HIDDEN_DESCRIPTION)
-
-        // Allow hidden flags like
-        // --json,
-        // --silent,
-        // --offline, -o
-        // --cwd <cwd> Pass a current working directory.
-
-        // this disables the suggestions
-        // .allowUnknownOption(true)
-
-        // 'Print debugging information'
-        .option('--debug', OPTION_HIDDEN_DESCRIPTION)
-        // 'Proxy server address to route requests through'
-        .option('--httpProxy', OPTION_HIDDEN_DESCRIPTION, process.env.HTTP_PROXY || process.env.HTTPS_PROXY)
-        // 'Certificate file to use when connecting using a proxy server',
+        .addOption(new Option('--json', 'Output return values as JSON').hideHelp(true))
+        .addOption(new Option('--silent', 'Silence CLI output').hideHelp(true))
+        .addOption(new Option('--cwd <cwd>').hideHelp(true))
+        .addOption(new Option('-o, --offline').hideHelp(true))
         .option(
-          '--httpProxyCertificateFilename',
-          OPTION_HIDDEN_DESCRIPTION,
+          '--httpProxyCertificateFilename [file]',
+          'Certificate file to use when connecting using a proxy server',
           process.env.NETLIFY_PROXY_CERTIFICATE_FILENAME,
         )
+        .option(
+          '--httpProxy [address]',
+          'Proxy server address to route requests through.',
+          process.env.HTTP_PROXY || process.env.HTTPS_PROXY,
+        )
+        .option('--debug', 'Print debugging information')
         .hook('preAction', async (_parentCommand, actionCommand) => {
           debug(`${name}:preAction`)('start')
           this.analytics = { startTime: process.hrtime.bigint() }
@@ -129,6 +132,18 @@ class BaseCommand extends Command {
     return this
   }
 
+  /** The examples list for the command (used inside doc generation and help page) */
+  examples = []
+
+  /**
+   * Set examples for the command
+   * @param {string[]} examples
+   */
+  addExamples(examples) {
+    this.examples = examples
+    return this
+  }
+
   /**
    * Overrides the help output of commander with custom styling
    * @returns {import('commander').Help}
@@ -199,8 +214,8 @@ class BaseCommand extends Command {
         const bang = isCommand ? `${HELP_$} ` : ''
 
         if (description) {
-          const pad = termWidth + HELP_SEPERATOR_WIDTH - (isCommand ? 2 : 0)
-          const fullText = `${bang}${term.padEnd(pad)}${chalk.grey(description)}`
+          const pad = termWidth + HELP_SEPERATOR_WIDTH
+          const fullText = `${bang}${term.padEnd(pad - (isCommand ? 2 : 0))}${chalk.grey(description)}`
           return helper.wrap(fullText, helpWidth - HELP_INDENT_WIDTH, pad)
         }
 
@@ -211,9 +226,9 @@ class BaseCommand extends Command {
       let output = []
 
       // Description
-      const commandDescription = helper.commandDescription(command)
-      if (commandDescription.length !== 0) {
-        output = [...output, commandDescription, '']
+      const [topDescription, ...commandDescription] = (helper.commandDescription(command) || '').split('\n')
+      if (topDescription.length !== 0) {
+        output = [...output, topDescription, '']
       }
 
       // on the parent help command the version should be displayed
@@ -224,14 +239,6 @@ class BaseCommand extends Command {
       // Usage
       output = [...output, chalk.bold('USAGE'), helper.commandUsage(command), '']
 
-      // Aliases
-      // eslint-disable-next-line no-underscore-dangle
-      if (command._aliases.length !== 0) {
-        // eslint-disable-next-line no-underscore-dangle
-        const aliases = command._aliases.map((alias) => formatItem(`${parentCommand.name()} ${alias}`, null, true))
-        output = [...output, chalk.bold('ALIASES'), formatHelpList(aliases), '']
-      }
-
       // Arguments
       const argumentList = helper
         .visibleArguments(command)
@@ -244,13 +251,41 @@ class BaseCommand extends Command {
         // Options
         const optionList = helper
           .visibleOptions(command)
-          .filter((option) => option.description !== OPTION_HIDDEN_DESCRIPTION)
+          .sort((optionA, optionB) => {
+            // base flags should be always at the bottom
+            if (BASE_FLAGS.has(optionA.long) || BASE_FLAGS.has(optionB.long)) {
+              return -1
+            }
+            return optionA.long.localeCompare(optionB.long)
+          })
           .map((option) => formatItem(helper.optionTerm(option), helper.optionDescription(option)))
         if (optionList.length !== 0) {
           output = [...output, chalk.bold('OPTIONS'), formatHelpList(optionList), '']
         }
       }
 
+      // Description
+      if (commandDescription.length !== 0) {
+        output = [...output, chalk.bold('DESCRIPTION'), formatHelpList(commandDescription), '']
+      }
+
+      // Aliases
+      // eslint-disable-next-line no-underscore-dangle
+      if (command._aliases.length !== 0) {
+        // eslint-disable-next-line no-underscore-dangle
+        const aliases = command._aliases.map((alias) => formatItem(`${parentCommand.name()} ${alias}`, null, true))
+        output = [...output, chalk.bold('ALIASES'), formatHelpList(aliases), '']
+      }
+
+      if (command.examples.length !== 0) {
+        output = [
+          ...output,
+          chalk.bold('EXAMPLES'),
+          formatHelpList(command.examples.map((example) => `${HELP_$} ${example}`)),
+          '',
+        ]
+      }
+
       const commandList = getCommands(command).map((cmd) =>
         formatItem(cmd.name(), helper.subcommandDescription(cmd), true),
       )
@@ -471,4 +506,4 @@ class BaseCommand extends Command {
   }
 }
 
-module.exports = { BaseCommand }
+module.exports = { BaseCommand, BASE_FLAGS }

package/src/commands/build/build.js

@@ -1,6 +1,6 @@
 // @ts-check
 const { getBuildOptions, runBuild } = require('../../lib/build')
-const { error, exit, generateExamplesHelp, getToken } = require('../../utils')
+const { error, exit, getToken } = require('../../utils')
 
 /**
  * @param {import('../../lib/build').BuildConfig} options
@@ -52,7 +52,7 @@ const createBuildCommand = (program) =>
     .option('--dry', 'Dry run: show instructions without running them', false)
     .option('--context [context]', 'Build context')
     .option('-o, --offline', 'disables any features that require network access', false)
-    .addHelpText('after', generateExamplesHelp(['netlify build']))
+    .addExamples(['netlify build'])
     .action(build)
 
 module.exports = { createBuildCommand }

package/src/commands/completion/completion.js

@@ -1,7 +1,5 @@
 const { Option } = require('commander')
 
-const { generateDescriptionHelp, generateExamplesHelp } = require('../../utils')
-
 /**
  * The completion:generate command
  * @param {import('commander').OptionValues} options
@@ -19,24 +17,20 @@ const completionGenerate = (options, command) => {
 const createCompletionCommand = (program) => {
   program
     .command('completion:generate')
+    .description(
+      'Generates completion script\nRun the "completion" command to see instructions about how to use the script generated by this command',
+    )
     .addOption(
       new Option('-s, --shell <shell>', 'Name of shell').choices(['bash', 'fish', 'zsh']).makeOptionMandatory(true),
     )
-    .addHelpText(
-      'after',
-      generateDescriptionHelp(
-        'Run the "completion" command to see instructions about how to use the script generated by this command',
-      ),
-    )
-    .addHelpText('after', generateExamplesHelp(['netlify completion --shell zsh']))
+    .addExamples(['netlify completion --shell zsh'])
     .action(completionGenerate)
 
   return program
     .command('completion')
-    .description('(Beta) Generate shell completion script')
+    .description('(Beta) Generate shell completion script\nRun this command to see instructions for your shell.')
     .addOption(new Option('-s, --shell <shell>', 'Name of shell').choices(['bash', 'fish', 'zsh']))
-    .addHelpText('after', generateDescriptionHelp('Run this command to see instructions for your shell.'))
-    .addHelpText('after', generateExamplesHelp(['netlify completion --shell zsh']))
+    .addExamples(['netlify completion --shell zsh'])
     .action((options, command) => command.help())
 }
 module.exports = { createCompletionCommand }

package/src/commands/deploy/deploy.js

@@ -23,8 +23,6 @@ const {
   deploySite,
   error,
   exit,
-  generateDescriptionHelp,
-  generateExamplesHelp,
   getFunctionsManifestPath,
   getInternalFunctionsDir,
   getToken,
@@ -580,36 +578,9 @@ const deploy = async (options, command) => {
 const createDeployCommand = (program) =>
   program
     .command('deploy')
-    .description('Create a new deploy from the contents of a folder')
-    .option('-d, --dir <path>', 'Specify a folder to deploy')
-    .option('-f, --functions', 'Specify a functions folder to deploy')
-    .option('-p, --prod', 'Deploy to production', false)
-    .option('--prodIfUnlocked', 'Deploy to production if unlocked, create a draft otherwise', false)
-    .option(
-      '--alias <name>',
-      'Specifies the alias for deployment, the string at the beginning of the deploy subdomain. Useful for creating predictable deployment URLs. Avoid setting an alias string to the same value as a deployed branch. `alias` doesn’t create a branch deploy and can’t be used in conjunction with the branch subdomain feature. Maximum 37 characters.',
-    )
-    .option(
-      '-b, --branch <name>',
-      'Serves the same functionality as --alias. Deprecated and will be removed in future versions',
-    )
-    .option('-o, --open', 'Open site after deploy', false)
-    .option('-m, --message <message>', 'A short message to include in the deploy log')
-    .option('-a, --auth <token>', 'Netlify auth token to deploy with', env.NETLIFY_AUTH_TOKEN)
-    .option('-s, --site <id>', 'A site ID to deploy to', env.NETLIFY_SITE_ID)
-    .option('--json', 'Output deployment data as JSON')
-    .option('--timeout <number>', 'Timeout to wait for deployment to finish', (value) => Number.parseInt(value))
-    .option('--trigger', 'Trigger a new build of your site on Netlify without uploading local files')
-    .option('--build', 'Run build command before deploying')
-    .option(
-      '--skip-functions-cache',
-      'Ignore any functions created as part of a previous `build` or `deploy` commands, forcing them to be bundled again as part of the deployment',
-      false,
-    )
-    .addHelpText(
-      'after',
-      generateDescriptionHelp(
-        `Deploys from the build settings found in the netlify.toml file, or settings from the API.
+    .description(
+      `Create a new deploy from the contents of a folder
+Deploys from the build settings found in the netlify.toml file, or settings from the API.
 
 The following environment variables can be used to override configuration file lookups and prompts:
 
@@ -676,20 +647,41 @@ functions/
 \`\`\`
 
 Support for package.json's main field, and intrinsic index.js entrypoints are coming soon.`,
-      ),
     )
-    .addHelpText(
-      'after',
-      generateExamplesHelp([
-        'netlify deploy',
-        'netlify deploy --prod',
-        'netlify deploy --prod --open',
-        'netlify deploy --prodIfUnlocked',
-        'netlify deploy --message "A message with an $ENV_VAR"',
-        'netlify deploy --auth $NETLIFY_AUTH_TOKEN',
-        'netlify deploy --trigger',
-      ]),
+    .option('-d, --dir <path>', 'Specify a folder to deploy')
+    .option('-f, --functions <folder>', 'Specify a functions folder to deploy')
+    .option('-p, --prod', 'Deploy to production', false)
+    .option('--prodIfUnlocked', 'Deploy to production if unlocked, create a draft otherwise', false)
+    .option(
+      '--alias <name>',
+      'Specifies the alias for deployment, the string at the beginning of the deploy subdomain. Useful for creating predictable deployment URLs. Avoid setting an alias string to the same value as a deployed branch. `alias` doesn’t create a branch deploy and can’t be used in conjunction with the branch subdomain feature. Maximum 37 characters.',
+    )
+    .option(
+      '-b, --branch <name>',
+      'Serves the same functionality as --alias. Deprecated and will be removed in future versions',
+    )
+    .option('-o, --open', 'Open site after deploy', false)
+    .option('-m, --message <message>', 'A short message to include in the deploy log')
+    .option('-a, --auth <token>', 'Netlify auth token to deploy with', env.NETLIFY_AUTH_TOKEN)
+    .option('-s, --site <id>', 'A site ID to deploy to', env.NETLIFY_SITE_ID)
+    .option('--json', 'Output deployment data as JSON')
+    .option('--timeout <number>', 'Timeout to wait for deployment to finish', (value) => Number.parseInt(value))
+    .option('--trigger', 'Trigger a new build of your site on Netlify without uploading local files')
+    .option('--build', 'Run build command before deploying')
+    .option(
+      '--skip-functions-cache',
+      'Ignore any functions created as part of a previous `build` or `deploy` commands, forcing them to be bundled again as part of the deployment',
+      false,
     )
+    .addExamples([
+      'netlify deploy',
+      'netlify deploy --prod',
+      'netlify deploy --prod --open',
+      'netlify deploy --prodIfUnlocked',
+      'netlify deploy --message "A message with an $ENV_VAR"',
+      'netlify deploy --auth $NETLIFY_AUTH_TOKEN',
+      'netlify deploy --trigger',
+    ])
     .action(deploy)
 
 module.exports = { createDeployCommand }