netlify 13.3.4 → 21.5.0

package/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2020 Netlify <team@netlify.com>
+Copyright (c) 2016 Netlify <team@netlify.com>
 
 MIT License
 

package/README.md

@@ -1,182 +1,124 @@
-A Netlify [OpenAPI](https://github.com/netlify/open-api) client that works in the browser and Node.js.
-
-## Usage
-
-```js
-import { NetlifyAPI } from 'netlify'
-
-const client = new NetlifyAPI('1234myAccessToken')
-const sites = await client.listSites()
+![Netlify CLI](cli.png)
+
+[![Coverage Status](https://codecov.io/gh/netlify/cli/branch/main/graph/badge.svg)](https://codecov.io/gh/netlify/cli)
+[![npm version][npm-img]][npm] [![downloads][dl-img]][dl] [![netlify-status][netlify-img]][netlify]
+[![security][snyk-img]][snyk]
+
+Interact with [Netlify](http://netlify.com/) from the comfort of your CLI.
+
+See the [CLI command line reference](https://cli.netlify.com/commands/) to get started and the docs on using
+[Netlify Dev](https://github.com/netlify/cli/blob/main/docs/commands/dev.md) to run your site locally.
+
+## Table of Contents
+
+<!-- AUTO-GENERATED-CONTENT:START (TOC:collapse=true&collapseText=Click to expand) -->
+<details>
+<summary>Click to expand</summary>
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Documentation](#documentation)
+- [Commands](#commands)
+  - [api](#api)
+  - [blobs](#blobs)
+  - [build](#build)
+  - [completion](#completion)
+  - [deploy](#deploy)
+  - [dev](#dev)
+  - [env](#env)
+  - [functions](#functions)
+  - [init](#init)
+  - [integration](#integration)
+  - [link](#link)
+  - [login](#login)
+  - [open](#open)
+  - [recipes](#recipes)
+  - [serve](#serve)
+  - [sites](#sites)
+  - [status](#status)
+  - [switch](#switch)
+  - [unlink](#unlink)
+  - [watch](#watch)
+- [Contributing](#contributing)
+- [Development](#development)
+- [License](#license)
+
+</details>
+<!-- AUTO-GENERATED-CONTENT:END -->
+
+## Installation
+
+Netlify CLI requires [Node.js](https://nodejs.org) version 18.14.0 or above. To install, run the following command from any
+directory in your terminal:
+
+```bash
+npm install netlify-cli -g
 ```
 
-## Using OpenAPI operations
-
-```js
-import { NetlifyAPI } from 'netlify'
+When using the CLI in a CI environment we recommend installing it locally as a development dependency, instead of
+globally. To install locally, run the following command from the root directory of your project:
 
-const client = new NetlifyAPI('1234myAccessToken')
-
-// Fetch sites
-const sites = await client.listSites()
-
-// Create a site. Notice `body` here for sending OpenAPI body
-const site = await client.createSite({
-  body: {
-    name: `my-awesome-site`,
-    // ... https://open-api.netlify.com/#/default/createSite
-  },
-})
-
-// Delete site. Notice `site_id` is a path parameter https://open-api.netlify.com/#/default/deleteSite
-await client.deleteSite({ site_id: siteId })
+```bash
+npm install --save-dev netlify-cli
 ```
 
-## API
-
-### `client = new NetlifyAPI([accessToken], [opts])`
-
-Create a new instance of the Netlify API client with the provided `accessToken`.
-
-`accessToken` is optional. Without it, you can't make authorized requests.
-
-`opts` includes:
-
-```js
-const opts = {
-  userAgent: 'netlify/js-client',
-  scheme: 'https',
-  host: 'api.netlify.com',
-  pathPrefix: '/api/v1',
-  accessToken: '1234myAccessToken',
-  agent: undefined, // e.g. HttpsProxyAgent
-  globalParams: {}, // parameters you want available for every request.
-  // Global params are only sent of the OpenAPI spec specifies the provided params.
-}
-```
-
-### `client.accessToken`
-
-A setter/getter that returns the `accessToken` that the client is configured to use. You can set this after the class is
-instantiated, and all subsequent calls will use the newly set `accessToken`.
-
-### `client.basePath`
+**Important:** Running `npm install netlify-cli -g` in CI means you're always installing the latest version of the CLI,
+including **breaking changes**. When you install locally and use a
+[lock file](https://docs.npmjs.com/cli/v7/commands/npm-ci) you guarantee reproducible builds. To manage CLI updates we
+recommend using an automated tool like [renovate](https://github.com/renovatebot/renovate) or
+[dependabot](https://github.com/dependabot).
 
-A getter that returns the formatted base URL of the endpoint the client is configured to use.
+Alternatively you may also use Homebrew: `brew install netlify-cli` (thanks
+[@cglong](https://github.com/netlify/cli/issues/291)).
 
-### OpenAPI Client methods
-
-The client is dynamically generated from the [OpenAPI](https://github.com/netlify/open-api) definition file. Each method
-is is named after the `operationId` name of each operation. **To see a list of available operations, please see the
-[OpenAPI website](https://open-api.netlify.com/)**.
-
-Every OpenAPI operation has the following signature:
-
-#### `response = await client.operationId([params], [opts])`
-
-Performs a call to the given endpoint corresponding with the `operationId`. Returns a promise resolved with the body of
-the response, or rejected with an error with the details about the request attached. Rejects if the `status` > 400.
-
-- `params` is an object that includes any of the required or optional endpoint parameters.
-- `params.body` should be an object which gets serialized to JSON automatically. Any object can live here but refer to
-  the OpenAPI specification for allowed fields in a particular request body. It can also be a function returning an
-  object.
-- If the endpoint accepts `binary`, `params.body` can be a Node.js readable stream or a function returning one (e.g.
-  `() => fs.createReadStream('./foo')`). Using a function is recommended.
+## Usage
 
-```js
-// example params
-const params = {
-  any_param_needed: anyParamNeeded,
-  paramsCanAlsoBeCamelCase,
-  body: {
-    an: 'arbitrary js object',
-  },
-}
-```
+Installing the CLI globally provides access to the `netlify` command.
 
-Optional `opts` can include any property you want passed to [`node-fetch`](https://github.com/bitinn/node-fetch). The
-`headers` property is merged with some `defaultHeaders`.
-
-```js
-// example opts
-const opts = {
-  headers: {
-    // Default headers
-    'User-agent': 'netlify-js-client',
-    accept: 'application/json',
-  },
-  // any other properties for node-fetch
-}
-```
+```sh-session
+netlify [command]
 
-All operations are conveniently consumed with async/await:
-
-```js
-try {
-  const siteDeploy = await client.getSiteDeploy({
-    siteId: '1234abcd',
-    deploy_id: '4567',
-  })
-  // Calls may fail!
-} catch {
-  // handle error
-}
+# Run `help` for detailed information about CLI commands
+netlify [command] help
 ```
 
-If the response includes `json` in the `contentType` header, fetch will deserialize the JSON body. Otherwise the `text`
-of the response is returned.
+## Documentation
 
-### API Flow Methods
+To learn how to log in to Netlify and start deploying projects, visit the
+[documentation on Netlify](https://docs.netlify.com/cli/get-started/).
 
-Some methods have been added in addition to the open API operations that make certain actions simpler to perform.
 
-#### `accessToken = await client.getAccessToken(ticket, [opts])`
+## Commands
 
-Pass in a [`ticket`](https://open-api.netlify.com/#model-ticket) and get back an `accessToken`. Call this with the
-response from a `client.createTicket({ client_id })` call. Automatically sets the `accessToken` to `this.accessToken`
-and returns `accessToken` for the consumer to save for later.
+For a full command reference visit [cli.netlify.com](https://cli.netlify.com/).
 
-Optional `opts` include:
+## Contributing
 
-```js
-const opts = {
-  poll: 1000, // number of ms to wait between polling
-  timeout: 3.6e6, // number of ms to wait before timing out
-}
-```
+See [CONTRIBUTING.md](CONTRIBUTING.md) for more info on how to make contributions to this project.
 
-See the [authenticating](https://www.netlify.com/docs/api/#authenticating) docs for more context.
+## Development
 
-```js
-import open from 'open'
-
-const ticket = await client.createTicket({ clientId: CLIENT_ID })
-// Open browser for authentication
-await open(`https://app.netlify.com/authorize?response_type=ticket&ticket=${ticket.id}`)
-
-// API is also set up to use the returned access token as a side effect
-// Save this for later so you can quickly set up an authenticated client
-const accessToken = await client.getAccessToken(ticket)
-```
-
-## Proxy support
-
-**Node.js only**: If this client is used behind a corporate proxy, you can pass an `HttpsProxyAgent` or any other
-`http.Agent` that can handle your situation as `agent` option:
-
-```js
-import HttpsProxyAgent from 'https-proxy-agent'
-
-const proxyUri = 'http(s)://[user:password@]proxyhost:port'
-const agent = new HttpsProxyAgent(proxyUri)
-const client = new NetlifyAPI('1234myAccessToken', { agent })
-```
+You'll need to follow these steps to run Netlify CLI locally:
 
-## Site deployment
+    uninstall any globally installed versions of netlify-cli
+    clone and install deps for https://github.com/netlify/cli
+    npm link from inside the cli folder
 
-Support for site deployment has been removed from this package in version 7.0.0. You should consider using the
-[`deploy` command](https://cli.netlify.com/commands/deploy/) of Netlify CLI.
+Now you're both ready to start testing and to contribute to the project!
 
 ## License
 
-MIT. See [LICENSE](./LICENSE) for more details.
+MIT. See [LICENSE](LICENSE) for more details.
+
+[npm-img]: https://img.shields.io/npm/v/netlify-cli.svg
+[npm]: https://npmjs.org/package/netlify-cli
+[av-img]: https://ci.appveyor.com/api/projects/status/imk2qjc34ly7x11b/branch/master?svg=true
+[av]: https://ci.appveyor.com/project/netlify/cli
+[dl-img]: https://img.shields.io/npm/dm/netlify-cli.svg
+[dl]: https://npmjs.org/package/netlify-cli
+[david-img]: https://david-dm.org/netlify/cli/status.svg
+[david]: https://david-dm.org/netlify/cli
+[snyk-img]: https://snyk.io/test/npm/netlify-cli/badge.svg
+[snyk]: https://snyk.io/test/npm/netlify-cli
+[netlify-img]: https://api.netlify.com/api/v1/badges/d3807379-2dcf-4a43-9c00-e7e8d90ecf70/deploy-status
+[netlify]: https://app.netlify.com/projects/cli/deploys

package/bin/run.js

@@ -0,0 +1,66 @@
+#!/usr/bin/env node
+import { argv } from 'process'
+import EventEmitter from 'events'
+
+import { maybeEnableCompileCache } from '../dist/utils/nodejs-compile-cache.js'
+
+// 12 hours
+const UPDATE_CHECK_INTERVAL = 432e5
+
+const NETLIFY_CYAN_HEX = '#28b5ac'
+const UPDATE_BOXEN_OPTIONS = {
+  padding: 1,
+  margin: 1,
+  textAlignment: 'center',
+  borderStyle: 'round', 
+  borderColor: NETLIFY_CYAN_HEX,
+  float: 'center',
+  // This is an intentional half-width space to work around a unicode padding math bug in boxen
+  title: '⬥ ',
+  titleAlignment: 'center',
+}
+
+const main = async () => {
+  // TODO(serhalp) Investigate and fix this at the root instead.
+  // This avoids `MaxListenersExceededWarning` warnings during Edge Functions bundling,
+  // from somewhere around here:
+  // https://github.com/netlify/build/blob/ca0bb348b3d7437d2418526f49b803a3db4e5ac2/packages/build/src/steps/run_step.ts.
+  EventEmitter.defaultMaxListeners = 25
+
+  const { default: chalk } = await import('chalk')
+  const { default: updateNotifier } = await import('update-notifier')
+  const { default: terminalLink } = await import('terminal-link')
+  const { createMainCommand } = await import('../dist/commands/main.js')
+  const { logError } = await import('../dist/utils/command-helpers.js')
+  const { default: getPackageJson } = await import('../dist/utils/get-cli-package-json.js')
+  const { runProgram } = await import('../dist/utils/run-program.js')
+
+  try {
+    const pkg = await getPackageJson()
+    const message = `Update available ${chalk.dim('{currentVersion}')} → ${chalk.green('{latestVersion}')}
+See what's new in the ${terminalLink('release notes', 'https://ntl.fyi/cli-versions')}
+
+Run ${chalk.inverse.hex(NETLIFY_CYAN_HEX)('{updateCommand}')} to update`
+    updateNotifier({
+      pkg,
+      updateCheckInterval: UPDATE_CHECK_INTERVAL,
+    }).notify({ message, boxenOptions: UPDATE_BOXEN_OPTIONS })
+  } catch (error) {
+    logError(`Error checking for updates: ${error?.toString()}`)
+  }
+
+  const program = createMainCommand()
+
+  try {
+    await runProgram(program, argv)
+
+    program.onEnd()
+  } catch (error) {
+    program.onEnd(error)
+  }
+}
+
+// Must come first, including before any imports
+maybeEnableCompileCache()
+
+await main()

package/dist/commands/api/api.d.ts

@@ -0,0 +1,4 @@
+import type { OptionValues } from 'commander';
+import type BaseCommand from '../base-command.js';
+export declare const apiCommand: (apiMethodName: string, options: OptionValues, command: BaseCommand) => Promise<undefined>;
+//# sourceMappingURL=api.d.ts.map

package/dist/commands/api/api.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../../src/commands/api/api.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAG7C,OAAO,KAAK,WAAW,MAAM,oBAAoB,CAAA;AAOjD,eAAO,MAAM,UAAU,GAAU,eAAe,MAAM,EAAE,SAAS,YAAY,EAAE,SAAS,WAAW,uBAwClG,CAAA"}

package/dist/commands/api/api.js

@@ -0,0 +1,42 @@
+import { methods } from '@netlify/api';
+import AsciiTable from 'ascii-table';
+import { chalk, logAndThrowError, exit, log, logJson } from '../../utils/command-helpers.js';
+const isValidApiMethod = (api, apiMethod) => Object.hasOwn(api, apiMethod);
+export const apiCommand = async (apiMethodName, options, command) => {
+    const { api } = command.netlify;
+    if (options.list) {
+        const table = new AsciiTable(`Netlify API Methods`);
+        table.setHeading('API Method', 'Docs Link');
+        methods.forEach((method) => {
+            const { operationId } = method;
+            table.addRow(operationId, `https://open-api.netlify.com/#operation/${operationId}`);
+        });
+        log(table.toString());
+        log();
+        log('Above is a list of available API methods');
+        log(`To run a method use "${chalk.cyanBright('netlify api methodName')}"`);
+        exit();
+    }
+    if (!apiMethodName) {
+        return logAndThrowError(`You must provide an API method. Run "netlify api --list" to see available methods`);
+    }
+    if (!(isValidApiMethod(api, apiMethodName) && typeof api[apiMethodName] === 'function')) {
+        return logAndThrowError(`"${apiMethodName}"" is not a valid api method. Run "netlify api --list" to see available methods`);
+    }
+    const apiMethod = api[apiMethodName].bind(api);
+    let payload;
+    if (options.data) {
+        payload = typeof options.data === 'string' ? JSON.parse(options.data) : options.data;
+    }
+    else {
+        payload = {};
+    }
+    try {
+        const apiResponse = await apiMethod(payload);
+        logJson(apiResponse);
+    }
+    catch (error_) {
+        return logAndThrowError(error_);
+    }
+};
+//# sourceMappingURL=api.js.map

package/dist/commands/api/api.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../../src/commands/api/api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAmB,MAAM,cAAc,CAAA;AACvD,OAAO,UAAU,MAAM,aAAa,CAAA;AAGpC,OAAO,EAAE,KAAK,EAAE,gBAAgB,EAAE,IAAI,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAA;AAK5F,MAAM,gBAAgB,GAAG,CAAC,GAAe,EAAE,SAAiB,EAA8B,EAAE,CAC1F,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,SAAS,CAAC,CAAA;AAE/B,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,EAAE,aAAqB,EAAE,OAAqB,EAAE,OAAoB,EAAE,EAAE;IACrG,MAAM,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,OAAO,CAAA;IAE/B,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACjB,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,qBAAqB,CAAC,CAAA;QACnD,KAAK,CAAC,UAAU,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;QAC3C,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACzB,MAAM,EAAE,WAAW,EAAE,GAAG,MAAM,CAAA;YAC9B,KAAK,CAAC,MAAM,CAAC,WAAW,EAAE,2CAA2C,WAAW,EAAE,CAAC,CAAA;QACrF,CAAC,CAAC,CAAA;QACF,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;QACrB,GAAG,EAAE,CAAA;QACL,GAAG,CAAC,0CAA0C,CAAC,CAAA;QAC/C,GAAG,CAAC,wBAAwB,KAAK,CAAC,UAAU,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAA;QAC1E,IAAI,EAAE,CAAA;IACR,CAAC;IAED,IAAI,CAAC,aAAa,EAAE,CAAC;QACnB,OAAO,gBAAgB,CAAC,mFAAmF,CAAC,CAAA;IAC9G,CAAC;IAED,IAAI,CAAC,CAAC,gBAAgB,CAAC,GAAG,EAAE,aAAa,CAAC,IAAI,OAAO,GAAG,CAAC,aAAa,CAAC,KAAK,UAAU,CAAC,EAAE,CAAC;QACxF,OAAO,gBAAgB,CACrB,IAAI,aAAa,iFAAiF,CACnG,CAAA;IACH,CAAC;IACD,MAAM,SAAS,GAAG,GAAG,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;IAE9C,IAAI,OAAO,CAAA;IACX,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACjB,OAAO,GAAG,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CAAA;IACtF,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,EAAE,CAAA;IACd,CAAC;IACD,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,CAAA;QAC5C,OAAO,CAAC,WAAW,CAAC,CAAA;IACtB,CAAC;IAAC,OAAO,MAAM,EAAE,CAAC;QAChB,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAA;IACjC,CAAC;AACH,CAAC,CAAA"}

package/dist/commands/api/index.d.ts

@@ -0,0 +1,3 @@
+import BaseCommand from '../base-command.js';
+export declare const createApiCommand: (program: BaseCommand) => BaseCommand;
+//# sourceMappingURL=index.d.ts.map

package/dist/commands/api/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/commands/api/index.ts"],"names":[],"mappings":"AACA,OAAO,WAAW,MAAM,oBAAoB,CAAA;AAE5C,eAAO,MAAM,gBAAgB,GAAI,SAAS,WAAW,gBAgB/C,CAAA"}

package/dist/commands/api/index.js

@@ -0,0 +1,14 @@
+import { chalk } from '../../utils/command-helpers.js';
+export const createApiCommand = (program) => program
+    .command('api')
+    .argument('[apiMethod]', 'Open API method to run')
+    .description(`Run any Netlify API method
+For more information on available methods check out https://open-api.netlify.com/ or run '${chalk.grey('netlify api --list')}'`)
+    .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(async (apiMethod, options, command) => {
+    const { apiCommand } = await import('./api.js');
+    await apiCommand(apiMethod, options, command);
+});
+//# sourceMappingURL=index.js.map

package/dist/commands/api/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/commands/api/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,gCAAgC,CAAA;AAGtD,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,OAAoB,EAAE,EAAE,CACvD,OAAO;KACJ,OAAO,CAAC,KAAK,CAAC;KACd,QAAQ,CAAC,aAAa,EAAE,wBAAwB,CAAC;KACjD,WAAW,CACV;4FACsF,KAAK,CAAC,IAAI,CAC9F,oBAAoB,CACrB,GAAG,CACL;KACA,MAAM,CAAC,mBAAmB,EAAE,aAAa,CAAC;KAC1C,MAAM,CAAC,QAAQ,EAAE,gCAAgC,EAAE,KAAK,CAAC;KACzD,WAAW,CAAC,CAAC,oBAAoB,EAAE,sDAAsD,CAAC,CAAC;KAC3F,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE;IAC5C,MAAM,EAAE,UAAU,EAAE,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,CAAA;IAC/C,MAAM,UAAU,CAAC,SAAS,EAAE,OAAO,EAAE,OAAO,CAAC,CAAA;AAC/C,CAAC,CAAC,CAAA"}

package/dist/commands/base-command.d.ts

@@ -0,0 +1,93 @@
+import { Project } from '@netlify/build-info';
+import { Command, Help } from 'commander';
+import type { FeatureFlags } from '../utils/feature-flags.js';
+import type { NetlifyOptions } from './types.js';
+import type { CachedConfig } from '../lib/build.js';
+type Analytics = {
+    startTime: bigint;
+    payload?: Record<string, unknown>;
+};
+export type BaseOptionValues = {
+    auth?: string;
+    cwd?: string;
+    debug?: boolean;
+    filter?: string;
+    httpProxy?: string;
+    silent?: string;
+};
+/** Base command class that provides tracking and config initialization */
+export default class BaseCommand extends Command {
+    #private;
+    /** The netlify object inside each command with the state */
+    netlify: NetlifyOptions;
+    analytics: Analytics;
+    project: Project;
+    /**
+     * The working directory that is used for reading the `netlify.toml` file and storing the state.
+     * In a monorepo context this must not be the process working directory and can be an absolute path to the
+     * Package/Site that should be worked in.
+     */
+    workingDir: string;
+    /**
+     * The workspace root if inside a mono repository.
+     * Must not be the repository root!
+     */
+    jsWorkspaceRoot?: string;
+    /** The current workspace package we should execute the commands in  */
+    workspacePackage?: string;
+    featureFlags: FeatureFlags;
+    siteId?: string;
+    accountId?: string;
+    /**
+     * IMPORTANT this function will be called for each command!
+     * Don't do anything expensive in there.
+     */
+    createCommand(name: string): BaseCommand;
+    /** don't show help options on command overview (mostly used on top commands like `addons` where options only apply on children) */
+    noHelpOptions(): this;
+    /** The examples list for the command (used inside doc generation and help page) */
+    examples: string[];
+    /** Set examples for the command  */
+    addExamples(examples: string[]): this;
+    /** Overrides the help output of commander with custom styling */
+    createHelp(): Help;
+    /** Will be called on the end of an action to track the metrics */
+    onEnd(error_?: unknown): Promise<void>;
+    authenticate(tokenFromFlag?: string): Promise<string>;
+    expensivelyAuthenticate(): Promise<string>;
+    /** Adds some data to the analytics payload */
+    setAnalyticsPayload(payload: Record<string, unknown>): void;
+    /**
+     * Initializes the options and parses the configuration needs to be called on start of a command function
+     */
+    private init;
+    /** Find and resolve the Netlify configuration */
+    getConfig(opts: {
+        cwd: string;
+        token?: string | null;
+        offline?: boolean;
+        /** An optional path to the netlify configuration file e.g. netlify.toml */
+        configFilePath?: string;
+        packagePath?: string;
+        repositoryRoot?: string;
+        host?: string;
+        pathPrefix?: string;
+        scheme?: string;
+    }): Promise<CachedConfig>;
+    /**
+     * get a path inside the `.netlify` project folder resolving with the workspace package
+     */
+    getPathInProject(...paths: string[]): string;
+    /**
+     * Returns the context that should be used in case one hasn't been explicitly
+     * set. The default context is `dev` most of the time, but some commands may
+     * wish to override that.
+     */
+    getDefaultContext(): 'production' | 'dev';
+    /**
+     * Retrieve feature flags for this site
+     */
+    getFeatureFlag<T extends null | boolean | string>(flagName: string): T;
+}
+export {};
+//# sourceMappingURL=base-command.d.ts.map

package/dist/commands/base-command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-command.d.ts","sourceRoot":"","sources":["../../src/commands/base-command.ts"],"names":[],"mappings":"AAMA,OAAO,EAAiB,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAI5D,OAAO,EAAE,OAAO,EAAE,IAAI,EAA6B,MAAM,WAAW,CAAA;AAwBpE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAA;AAO7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAChD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAEnD,KAAK,SAAS,GAAG;IACf,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC,CAAA;AAwHD,MAAM,MAAM,gBAAgB,GAAG;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,OAAO,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,0EAA0E;AAC1E,MAAM,CAAC,OAAO,OAAO,WAAY,SAAQ,OAAO;;IAC9C,4DAA4D;IAC5D,OAAO,EAAG,cAAc,CAAA;IAGxB,SAAS,EAAE,SAAS,CAAyC;IAC7D,OAAO,EAAG,OAAO,CAAA;IAEjB;;;;OAIG;IAGH,UAAU,SAAgB;IAE1B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB,uEAAuE;IACvE,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB,YAAY,EAAE,YAAY,CAAK;IAC/B,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;;OAGG;IACH,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW;IAwCxC,mIAAmI;IACnI,aAAa;IAKb,mFAAmF;IACnF,QAAQ,EAAE,MAAM,EAAE,CAAK;IACvB,oCAAoC;IACpC,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE;IAK9B,iEAAiE;IACjE,UAAU,IAAI,IAAI;IA8HlB,kEAAkE;IAC5D,KAAK,CAAC,MAAM,CAAC,EAAE,OAAO;IA4BtB,YAAY,CAAC,aAAa,CAAC,EAAE,MAAM;IAQnC,uBAAuB;IA2D7B,8CAA8C;IAC9C,mBAAmB,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAOpD;;OAEG;YACW,IAAI;IA0MlB,iDAAiD;IAC3C,SAAS,CAAC,IAAI,EAAE;QACpB,GAAG,EAAE,MAAM,CAAA;QACX,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;QACrB,OAAO,CAAC,EAAE,OAAO,CAAA;QACjB,2EAA2E;QAC3E,cAAc,CAAC,EAAE,MAAM,CAAA;QACvB,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,cAAc,CAAC,EAAE,MAAM,CAAA;QACvB,IAAI,CAAC,EAAE,MAAM,CAAA;QACb,UAAU,CAAC,EAAE,MAAM,CAAA;QACnB,MAAM,CAAC,EAAE,MAAM,CAAA;KAChB,GAAG,OAAO,CAAC,YAAY,CAAC;IAkDzB;;OAEG;IACH,gBAAgB,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM;IAI5C;;;;OAIG;IACH,iBAAiB,IAAI,YAAY,GAAG,KAAK;IAIzC;;OAEG;IACH,cAAc,CAAC,CAAC,SAAS,IAAI,GAAG,OAAO,GAAG,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,CAAC;CAKvE"}