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

package/src/commands/dev/dev-exec.js

@@ -1,6 +1,6 @@
 const execa = require('execa')
 
-const { generateDescriptionHelp, generateExamplesHelp, injectEnvVariables } = require('../../utils')
+const { injectEnvVariables } = require('../../utils')
 
 /**
  * The dev:exec command
@@ -24,16 +24,12 @@ const devExec = async (cmd, options, command) => {
 const createDevExecCommand = (program) =>
   program
     .command('dev:exec')
-    .argument('<...cmd>')
-    .description('Exec command')
-    .allowExcessArguments(true)
-    .addHelpText(
-      'after',
-      generateDescriptionHelp(
-        'Runs a command within the netlify dev environment, e.g. with env variables from any installed addons',
-      ),
+    .argument('<...cmd>', `the command that should be executed`)
+    .description(
+      'Exec command\nRuns a command within the netlify dev environment, e.g. with env variables from any installed addons',
     )
-    .addHelpText('after', generateExamplesHelp(['netlify dev:exec npm run bootstrap']))
+    .allowExcessArguments(true)
+    .addExamples(['netlify dev:exec npm run bootstrap'])
     .action(devExec)
 
 module.exports = { createDevExecCommand }

package/src/commands/dev/dev-trace.js

@@ -1,7 +1,7 @@
 // @ts-check
 const process = require('process')
 
-const { generateExamplesHelp, runProcess } = require('../../utils')
+const { runProcess } = require('../../utils')
 
 /**
  * The dev:trace command
@@ -35,16 +35,13 @@ const createDevTraceCommand = (program) =>
       `Simulates Netlify's Edge routing logic to match specific requests.
 This command is designed to mimic cURL's command line, so the flags are more familiar.`,
     )
-    .addHelpText(
-      'after',
-      generateExamplesHelp([
-        'netlify dev:trace http://localhost/routing-path',
-        'netlify dev:trace -w dist-directory http://localhost/routing-path',
-        'netlify dev:trace -X POST http://localhost/routing-path',
-        'netlify dev:trace -H "Accept-Language es" http://localhost/routing-path',
-        'netlify dev:trace --cookie nf_jwt=token http://localhost/routing-path',
-      ]),
-    )
+    .addExamples([
+      'netlify dev:trace http://localhost/routing-path',
+      'netlify dev:trace -w dist-directory http://localhost/routing-path',
+      'netlify dev:trace -X POST http://localhost/routing-path',
+      'netlify dev:trace -H "Accept-Language es" http://localhost/routing-path',
+      'netlify dev:trace --cookie nf_jwt=token http://localhost/routing-path',
+    ])
     .action(devTrace)
 
 module.exports = { createDevTraceCommand }

package/src/commands/dev/dev.js

@@ -4,6 +4,7 @@ const process = require('process')
 const { promisify } = require('util')
 
 const boxen = require('boxen')
+const { Option } = require('commander')
 const execa = require('execa')
 const StaticServer = require('static-server')
 const stripAnsiCc = require('strip-ansi-control-characters')
@@ -18,8 +19,6 @@ const {
   chalk,
   detectServerSettings,
   exit,
-  generateDescriptionHelp,
-  generateExamplesHelp,
   getSiteInformation,
   injectEnvVariables,
   log,
@@ -304,46 +303,38 @@ const createDevCommand = (program) => {
   createDevExecCommand(program)
   createDevTraceCommand(program)
 
-  return (
-    program
-      .command('dev')
-      .description('Local dev server')
-      .option('-c ,--command <command>', 'command to run')
-      .option('-p ,--port <port>', 'port of netlify dev', (value) => Number.parseInt(value))
-      .option('--targetPort <port>', 'port of target app server', (value) => Number.parseInt(value))
-      .option('--framework <name>', 'framework to use. Defaults to #auto which automatically detects a framework')
-      // TODO: hidden
-      .option(
-        '--staticServerPort <port>',
-        'port of the static app server used when no framework is detected',
-        (value) => Number.parseInt(value),
-      )
-      .option('-d ,--dir <path>', 'dir with static files')
-      .option('-f ,--functions <folder>', 'specify a functions folder to serve')
-      .option('-o ,--offline', 'disables any features that require network access')
-      .option('-l, --live', 'start a public live session', false)
-      // TODO: hidden
-      .option('-e ,--edgeHandlers', 'activates the Edge Handlers runtime')
-      // TODO: hidden
-      .option(
+  return program
+    .command('dev')
+    .description(
+      `Local dev server\nThe dev command will run a local dev server with Netlify's proxy and redirect rules`,
+    )
+    .option('-c ,--command <command>', 'command to run')
+    .option('-p ,--port <port>', 'port of netlify dev', (value) => Number.parseInt(value))
+    .option('--targetPort <port>', 'port of target app server', (value) => Number.parseInt(value))
+    .option('--framework <name>', 'framework to use. Defaults to #auto which automatically detects a framework')
+    .option('-d ,--dir <path>', 'dir with static files')
+    .option('-f ,--functions <folder>', 'specify a functions folder to serve')
+    .option('-o ,--offline', 'disables any features that require network access')
+    .option('-l, --live', 'start a public live session', false)
+    .addOption(
+      new Option('--staticServerPort <port>', 'port of the static app server used when no framework is detected')
+        .argParser((value) => Number.parseInt(value))
+        .hideHelp(),
+    )
+    .addOption(new Option('-e ,--edgeHandlers', 'activates the Edge Handlers runtime').hideHelp())
+    .addOption(
+      new Option(
         '-t ,--trafficMesh',
         '(DEPRECATED: use --edgeHandlers or -e instead) uses Traffic Mesh for proxying requests',
-      )
-      // TODO: hidden
-      .option('-g ,--locationDb <path>', 'specify the path to a local GeoIP location database in MMDB format')
-      .addHelpText(
-        'after',
-        generateDescriptionHelp(`The dev command will run a local dev server with Netlify's proxy and redirect rules`),
-      )
-      .addHelpText(
-        'after',
-        generateExamplesHelp([
-          'netlify dev',
-          'netlify dev -d public',
-          'netlify dev -c "hugo server -w" --targetPort 1313',
-        ]),
-      )
-      .action(dev)
-  )
+      ).hideHelp(),
+    )
+    .addOption(
+      new Option(
+        '-g ,--locationDb <path>',
+        'specify the path to a local GeoIP location database in MMDB format',
+      ).hideHelp(),
+    )
+    .addExamples(['netlify dev', 'netlify dev -d public', 'netlify dev -c "hugo server -w" --targetPort 1313'])
+    .action(dev)
 }
 module.exports = { createDevCommand }

package/src/commands/env/env.js

@@ -1,5 +1,4 @@
-const { generateExamplesHelp } = require('../../utils')
-
+// @ts-check
 const { createEnvGetCommand } = require('./env-get')
 const { createEnvImportCommand } = require('./env-import')
 const { createEnvListCommand } = require('./env-list')
@@ -30,16 +29,13 @@ const createEnvCommand = (program) => {
   return program
     .command('env')
     .description('(Beta) Control environment variables for the current site')
-    .addHelpText(
-      'after',
-      generateExamplesHelp([
-        'netlify env:list',
-        'netlify env:get VAR_NAME',
-        'netlify env:set VAR_NAME value',
-        'netlify env:unset VAR_NAME',
-        'netlify env:import fileName',
-      ]),
-    )
+    .addExamples([
+      'netlify env:list',
+      'netlify env:get VAR_NAME',
+      'netlify env:set VAR_NAME value',
+      'netlify env:unset VAR_NAME',
+      'netlify env:import fileName',
+    ])
     .action(env)
 }
 

package/src/commands/functions/functions-build.js

@@ -52,7 +52,7 @@ const createFunctionsBuildCommand = (program) =>
     .command('functions:build')
     .alias('function:build')
     .description('Build functions locally')
-    .option('-f, --function <directory>', 'Specify a functions directory to build to')
+    .option('-f, --functions <directory>', 'Specify a functions directory to build to')
     .option('-s, --src <directory>', 'Specify the source directory for the functions')
     .action(functionsBuild)
 

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

@@ -21,7 +21,7 @@ const {
   chalk,
   error,
   execa,
-  generateExamplesHelp,
+
   injectEnvVariables,
   log,
   readRepoURL,
@@ -591,14 +591,11 @@ const createFunctionsCreateCommand = (program) =>
     .option('-n, --name <name>', 'function name')
     .option('-u, --url <url>', 'pull template from URL')
     .option('-l, --language <lang>', 'function language')
-    .addHelpText(
-      'after',
-      generateExamplesHelp([
-        'netlify functions:create',
-        'netlify functions:create hello-world',
-        'netlify functions:create --name hello-world',
-      ]),
-    )
+    .addExamples([
+      'netlify functions:create',
+      'netlify functions:create hello-world',
+      'netlify functions:create --name hello-world',
+    ])
     .action(functionsCreate)
 
 module.exports = { createFunctionsCreateCommand }

package/src/commands/functions/functions-invoke.js

@@ -6,7 +6,7 @@ const process = require('process')
 const inquirer = require('inquirer')
 const fetch = require('node-fetch')
 
-const { BACKGROUND, NETLIFYDEVWARN, chalk, error, exit, generateExamplesHelp, getFunctions } = require('../../utils')
+const { BACKGROUND, NETLIFYDEVWARN, chalk, error, exit, getFunctions } = require('../../utils')
 
 // https://www.netlify.com/docs/functions/#event-triggered-functions
 const events = [
@@ -258,19 +258,16 @@ const createFunctionsInvokeCommand = (program) =>
       'simulate Netlify Identity authentication JWT. pass --no-identity to affirm unauthenticated request',
     )
     .option('--port <port>', 'Port where netlify dev is accessible. e.g. 8888', (value) => Number.parseInt(value))
-    .addHelpText(
-      'after',
-      generateExamplesHelp([
-        'netlify functions:invoke',
-        'netlify functions:invoke myfunction',
-        'netlify functions:invoke --name myfunction',
-        'netlify functions:invoke --name myfunction --identity',
-        'netlify functions:invoke --name myfunction --no-identity',
-        `netlify functions:invoke myfunction --payload '{"foo": 1}'`,
-        'netlify functions:invoke myfunction --querystring "foo=1',
-        'netlify functions:invoke myfunction --payload "./pathTo.json"',
-      ]),
-    )
+    .addExamples([
+      'netlify functions:invoke',
+      'netlify functions:invoke myfunction',
+      'netlify functions:invoke --name myfunction',
+      'netlify functions:invoke --name myfunction --identity',
+      'netlify functions:invoke --name myfunction --no-identity',
+      `netlify functions:invoke myfunction --payload '{"foo": 1}'`,
+      'netlify functions:invoke myfunction --querystring "foo=1',
+      'netlify functions:invoke myfunction --payload "./pathTo.json"',
+    ])
     .action(functionsInvoke)
 
 module.exports = { createFunctionsInvokeCommand }

package/src/commands/functions/functions-list.js

@@ -5,7 +5,7 @@ const AsciiTable = require('ascii-table')
 const {
   error,
   exit,
-  generateDescriptionHelp,
+
   getFunctions,
   getFunctionsDir,
   log,
@@ -92,16 +92,15 @@ const createFunctionsListCommand = (program) =>
   program
     .command('functions:list')
     .alias('function:list')
-    .description('List functions that exist locally')
+    .description(
+      `List functions that exist locally
+Helpful for making sure that you have formatted your functions correctly
+
+NOT the same as listing the functions that have been deployed. For that info you need to go to your Netlify deploy log.`,
+    )
     .option('-n, --name <name>', 'name to print')
     .option('-f, --functions <dir>', 'Specify a functions directory to list')
     .option('--json', 'Output function data as JSON')
-    .addHelpText(
-      'after',
-      generateDescriptionHelp(`Helpful for making sure that you have formatted your functions correctly
-
-NOT the same as listing the functions that have been deployed. For that info you need to go to your Netlify deploy log.`),
-    )
     .action(functionsList)
 
 module.exports = { createFunctionsListCommand }

package/src/commands/functions/functions.js

@@ -1,6 +1,5 @@
 // @ts-check
-
-const { chalk, generateDescriptionHelp, generateExamplesHelp } = require('../../utils')
+const { chalk } = require('../../utils')
 
 const { createFunctionsBuildCommand } = require('./functions-build')
 const { createFunctionsCreateCommand } = require('./functions-create')
@@ -34,18 +33,14 @@ const createFunctionsCommand = (program) => {
   return program
     .command('functions')
     .alias('function')
-    .description('Manage netlify functions')
-    .addHelpText(
-      'after',
-      generateDescriptionHelp(`The ${name} command will help you manage the functions in this site`),
-    )
-    .addHelpText(
-      'after',
-      generateExamplesHelp([
-        'netlify functions:create --name function-xyz',
-        'netlify functions:build --name function-abc --timeout 30s',
-      ]),
+    .description(
+      `Manage netlify functions
+The ${name} command will help you manage the functions in this site`,
     )
+    .addExamples([
+      'netlify functions:create --name function-xyz',
+      'netlify functions:build --name function-abc --timeout 30s',
+    ])
     .action(functions)
 }
 

package/src/commands/index.js

@@ -1,5 +1,7 @@
-const { BaseCommand } = require('./base-command')
+const baseCommand = require('./base-command')
+const { createMainCommand } = require('./main')
 
 module.exports = {
-  BaseCommand,
+  ...baseCommand,
+  createMainCommand,
 }

package/src/commands/init/init.js

@@ -223,7 +223,7 @@ const createInitCommand = (program) =>
       'Configure continuous deployment for a new or existing site. To create a new site without continuous deployment, use `netlify sites:create`',
     )
     .option('-m, --manual', 'Manually configure a git remote for CI')
-    .option('--force', 'Manually configure a git remote for CI')
+    .option('--force', 'Reinitialize CI hooks if the linked site is already configured to use CI')
     .option('--gitRemoteName <name>', 'Name of Git remote to use. e.g. "origin"')
     .action(init)
 

package/src/commands/link/link.js

@@ -7,16 +7,7 @@ const inquirer = require('inquirer')
 const isEmpty = require('lodash/isEmpty')
 
 const { listSites } = require('../../lib/api')
-const {
-  chalk,
-  ensureNetlifyIgnore,
-  error,
-  exit,
-  generateExamplesHelp,
-  getRepoData,
-  log,
-  track,
-} = require('../../utils')
+const { chalk, ensureNetlifyIgnore, error, exit, getRepoData, log, track } = require('../../utils')
 
 /**
  *
@@ -370,10 +361,7 @@ const createLinkCommand = (program) =>
     .option('--id <id>', 'ID of site to link to')
     .option('--name <name>', 'Name of site to link to')
     .option('--gitRemoteName <name>', 'Name of Git remote to use. e.g. "origin"')
-    .addHelpText(
-      'after',
-      generateExamplesHelp(['netlify link', 'netlify link --id 123-123-123-123', 'netlify link --name my-site-name']),
-    )
+    .addExamples(['netlify link', 'netlify link --id 123-123-123-123', 'netlify link --name my-site-name'])
     .action(link)
 
 module.exports = { createLinkCommand, link }

package/src/commands/lm/lm-install.js

@@ -1,6 +1,4 @@
 // @ts-check
-
-const { generateDescriptionHelp } = require('../../utils')
 const { installPlatform } = require('../../utils/lm/install')
 const { printBanner } = require('../../utils/lm/ui')
 
@@ -24,13 +22,12 @@ const createLmInstallCommand = (program) =>
   program
     .command('lm:install')
     .alias('lm:init')
-    .description('Configures your computer to use Netlify Large Media')
-    .option('-f, --force', 'Force the credentials helper installation')
-    .addHelpText(
-      'after',
-      generateDescriptionHelp(`It installs the required credentials helper for Git,
-and configures your Git environment with the right credentials.`),
+    .description(
+      `Configures your computer to use Netlify Large Media
+It installs the required credentials helper for Git,
+and configures your Git environment with the right credentials.`,
     )
+    .option('-f, --force', 'Force the credentials helper installation')
     .action(lmInstall)
 
 module.exports = { createLmInstallCommand }

package/src/commands/lm/lm.js

@@ -1,7 +1,4 @@
 // @ts-check
-
-const { generateDescriptionHelp, generateExamplesHelp } = require('../../utils')
-
 const { createLmInfoCommand } = require('./lm-info')
 const { createLmInstallCommand } = require('./lm-install')
 const { createLmSetupCommand } = require('./lm-setup')
@@ -29,9 +26,8 @@ const createLmCommand = (program) => {
 
   program
     .command('lm')
-    .description('Handle Netlify Large Media operations')
-    .addHelpText('after', generateDescriptionHelp('The lm command will help you manage large media for a site'))
-    .addHelpText('after', generateExamplesHelp(['netlify lm:info', 'netlify lm:install', 'netlify lm:setup']))
+    .description('Handle Netlify Large Media operations\nThe lm command will help you manage large media for a site')
+    .addExamples(['netlify lm:info', 'netlify lm:install', 'netlify lm:setup'])
     .action(lm)
 }
 

package/src/commands/login/login.js

@@ -45,7 +45,10 @@ const login = async (options, command) => {
 const createLoginCommand = (program) =>
   program
     .command('login')
-    .description('Login to your Netlify account')
+    .description(
+      `Login to your Netlify account
+Opens a web browser to acquire an OAuth token.`,
+    )
     .option('--new', 'Login to new Netlify account')
     .action(login)
 

package/src/commands/main.js

@@ -1,11 +1,34 @@
 // @ts-check
 const process = require('process')
 
+const { Option } = require('commander')
 const inquirer = require('inquirer')
 const { findBestMatch } = require('string-similarity')
 
+const pkg = require('../../package.json')
 const { NETLIFY_CYAN, USER_AGENT, chalk, error, execa, exit, getGlobalConfig, log, track, warn } = require('../utils')
 
+const { createAddonsCommand } = require('./addons')
+const { createApiCommand } = require('./api')
+const { BaseCommand } = require('./base-command')
+const { createBuildCommand } = require('./build')
+const { createCompletionCommand } = require('./completion')
+const { createDeployCommand } = require('./deploy')
+const { createDevCommand } = require('./dev')
+const { createEnvCommand } = require('./env')
+const { createFunctionsCommand } = require('./functions')
+const { createInitCommand } = require('./init')
+const { createLinkCommand } = require('./link')
+const { createLmCommand } = require('./lm')
+const { createLoginCommand } = require('./login')
+const { createLogoutCommand } = require('./logout')
+const { createOpenCommand } = require('./open')
+const { createSitesCommand } = require('./sites')
+const { createStatusCommand } = require('./status')
+const { createSwitchCommand } = require('./switch')
+const { createUnlinkCommand } = require('./unlink')
+const { createWatchCommand } = require('./watch')
+
 const SUGGESTION_TIMEOUT = 1e4
 
 const getVersionPage = async () => {
@@ -50,12 +73,30 @@ const mainCommand = async function (options, command) {
     exit()
   }
 
-  if (command.args[0] === 'version') {
-    const versionPage = await getVersionPage()
-    log(versionPage)
+  if (command.args[0] === 'version' || options.version) {
+    if (options.verbose) {
+      const versionPage = await getVersionPage()
+      log(versionPage)
+    }
+    log(USER_AGENT)
     exit()
   }
 
+  // if no command show the header and the help
+  if (command.args.length === 0) {
+    const title = `${chalk.bgBlack.cyan('⬥ Netlify CLI')}`
+    const docsMsg = `${chalk.greenBright('Read the docs:')} https://www.netlify.com/docs/cli`
+    const supportMsg = `${chalk.magentaBright('Support and bugs:')} ${pkg.bugs.url}`
+
+    console.log()
+    console.log(title)
+    console.log(docsMsg)
+    console.log(supportMsg)
+    console.log()
+
+    command.help()
+  }
+
   if (command.args[0] === 'help') {
     if (command.args[1]) {
       const subCommand = command.commands.find((cmd) => cmd.name() === command.args[1])
@@ -102,17 +143,46 @@ const mainCommand = async function (options, command) {
 }
 
 /**
- * Creates the `netlify functions:create` command
- * @param {import('./base-command').BaseCommand} program
- * @returns
+ * Creates the `netlify-cli` command
+ * Promise is needed as the envinfo is a promise
+ * @returns {import('./base-command').BaseCommand}
  */
-const createMainCommand = async (program) =>
+const createMainCommand = () => {
+  const program = new BaseCommand('netlify')
+  // register all the commands
+  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)
+
   program
-    .version(await getVersionPage(), '-v, --version')
+    .version(USER_AGENT, '-V')
     .showSuggestionAfterError(true)
     .option('--telemetry-disable', 'Disable telemetry')
     .option('--telemetry-enable', 'Enables telemetry')
+    // needed for custom version output as we display further environment information
+    // commanders version output is set to uppercase -V
+    .addOption(new Option('-v, --version').hideHelp())
+    .addOption(new Option('--verbose').hideHelp())
     .noHelpOptions()
     .action(mainCommand)
 
+  return program
+}
+
 module.exports = { createMainCommand }

package/src/commands/open/open-admin.js

@@ -51,6 +51,10 @@ Run \`netlify link\` to connect to this folder to a site`)
  * @returns
  */
 const createOpenAdminCommand = (program) =>
-  program.command('open:admin').description('Opens current site admin UI in Netlify').action(openAdmin)
+  program
+    .command('open:admin')
+    .description('Opens current site admin UI in Netlify')
+    .addExamples(['netlify open:admin'])
+    .action(openAdmin)
 
 module.exports = { createOpenAdminCommand, openAdmin }

package/src/commands/open/open-site.js

@@ -44,6 +44,10 @@ Run \`netlify link\` to connect to this folder to a site`)
  * @returns
  */
 const createOpenSiteCommand = (program) =>
-  program.command('open:site').description('Opens current site url in browser').action(openSite)
+  program
+    .command('open:site')
+    .description('Opens current site url in browser')
+    .addExamples(['netlify open:site'])
+    .action(openSite)
 
 module.exports = { createOpenSiteCommand, openSite }

package/src/commands/open/open.js

@@ -1,5 +1,3 @@
-const { generateExamplesHelp } = require('../../utils')
-
 const { createOpenAdminCommand, openAdmin } = require('./open-admin')
 const { createOpenSiteCommand, openSite } = require('./open-site')
 
@@ -31,11 +29,10 @@ const createOpenCommand = (program) => {
 
   return program
     .command('open')
-    .description('Open settings for the site linked to the current folder')
-    .addHelpText(
-      'after',
-      generateExamplesHelp(['netlify open --site', 'netlify open --admin', 'netlify open:admin', 'netlify open:site']),
-    )
+    .description(`Open settings for the site linked to the current folder`)
+    .option('--site', 'Open site')
+    .option('--admin', 'Open Netlify site')
+    .addExamples(['netlify open --site', 'netlify open --admin', 'netlify open:admin', 'netlify open:site'])
     .action(open)
 }
 module.exports = { createOpenCommand }

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

@@ -170,7 +170,10 @@ const sitesCreate = async (options, command) => {
 const createSitesCreateCommand = (program) =>
   program
     .command('sites:create')
-    .description('Create an empty site (advanced)')
+    .description(
+      `Create an empty site (advanced)
+Create a blank site that isn't associated with any git remote. Does not link to the current working directory.`,
+    )
     .option('-n, --name [name]', 'name of site')
     .option('-a, --account-slug [slug]', 'account slug to create the site under')
     .option('-c, --with-ci', 'initialize CI hooks during site creation')