From c933335ea8734c454fba0422c19da19a73ecadbe Mon Sep 17 00:00:00 2001 From: Raees Iqbal Date: Tue, 26 May 2020 11:41:53 -0700 Subject: [PATCH] 2.52.0 --- CHANGELOG.md | 21 ++++++++- README.md | 92 ++++++++++++++++++++------------------ docs/README.md | 62 +++++++++++++------------ docs/commands/addons.md | 27 +++++------ docs/commands/api.md | 7 +-- docs/commands/build.md | 6 +-- docs/commands/deploy.md | 38 +++++++++------- docs/commands/dev.md | 25 ++++++----- docs/commands/functions.md | 37 ++++++++------- docs/commands/index.md | 62 +++++++++++++------------ docs/commands/init.md | 8 ++-- docs/commands/link.md | 8 ++-- docs/commands/login.md | 5 ++- docs/commands/logout.md | 2 - docs/commands/open.md | 16 +++---- docs/commands/sites.md | 32 ++++++------- docs/commands/status.md | 11 +++-- docs/commands/unlink.md | 2 +- docs/commands/watch.md | 2 +- package-lock.json | 2 +- package.json | 2 +- 21 files changed, 252 insertions(+), 215 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 01a565aa87d..7bbae4483af 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog). +## [v2.52.0](https://github.com/netlify/cli/compare/v2.51.0...v2.52.0) - 2020-05-26 + +### Merged + +- Fix CI tests failing [`#926`](https://github.com/netlify/cli/pull/926) +- docs: add build command doc for repo + cli.netlify.com [`#879`](https://github.com/netlify/cli/pull/879) +- Upgrade Netlify Build [`#925`](https://github.com/netlify/cli/pull/925) +- Update Netlify Dev docs [`#917`](https://github.com/netlify/cli/pull/917) +- test: move CRA test app install from github action to test setup [`#913`](https://github.com/netlify/cli/pull/913) +- Improve dev and CRA tests logic [`#918`](https://github.com/netlify/cli/pull/918) +- style: format files and enforce it in tests [`#915`](https://github.com/netlify/cli/pull/915) +- fix: use named Octokit import [`#910`](https://github.com/netlify/cli/pull/910) +- Dev: Dont add dots when waiting for port [`#905`](https://github.com/netlify/cli/pull/905) +- Improve Netlify Dev config and docs [`#902`](https://github.com/netlify/cli/pull/902) +- Rename proxyPort to frameworkPort [`#900`](https://github.com/netlify/cli/pull/900) +- Improve error when cant connect to targetPort [`#899`](https://github.com/netlify/cli/pull/899) + ## [v2.51.0](https://github.com/netlify/cli/compare/v2.50.0...v2.51.0) - 2020-05-12 ### Merged @@ -368,7 +385,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog). - Fix netlify-redirect-parser problem by updating [`5e28d0c`](https://github.com/netlify/cli/commit/5e28d0c50a9efcaaa23d4da2e747feab5a2716f6) - docs: update paths [`3bb6ed1`](https://github.com/netlify/cli/commit/3bb6ed118603dcf04cb68f70768839deff1aff8b) -- refactor: clean up functions:list & add json logging [`c895829`](https://github.com/netlify/cli/commit/c895829a015c4d03aa563a9db271b31478f22989) +- docs: update site sync script. Update paths for site build [`b4aa492`](https://github.com/netlify/cli/commit/b4aa492cb2d7d75fae84a71800ebbe66290e3697) ## [v2.25.0](https://github.com/netlify/cli/compare/v2.24.0...v2.25.0) - 2019-12-10 @@ -418,8 +435,8 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog). ### Commits - refactor: delete old config parsing [`6bd8a44`](https://github.com/netlify/cli/commit/6bd8a44c9c7ae08832ca1099f0820f9ea80eba09) -- chore: update config dep [`4012c9d`](https://github.com/netlify/cli/commit/4012c9d66fe37af570e43e3007ec527d373e5fd1) - fix: dont run detector sync lookup for every command [`18f1b30`](https://github.com/netlify/cli/commit/18f1b306c6ad101cc8126c7174a1f99ccf15ef32) +- chore: update config dep [`4012c9d`](https://github.com/netlify/cli/commit/4012c9d66fe37af570e43e3007ec527d373e5fd1) ## [v2.21.0](https://github.com/netlify/cli/compare/v2.20.2...v2.21.0) - 2019-11-13 diff --git a/README.md b/README.md index 7590e23736c..46bf1e59b67 100644 --- a/README.md +++ b/README.md @@ -16,21 +16,21 @@ See the [CLI command line reference](https://cli.netlify.com/commands/) to get s - [Usage](#usage) - [Documentation](#documentation) - [Commands](#commands) - - [addons](#addons) - - [api](#api) - - [build](#build) - - [deploy](#deploy) - - [dev](#dev) - - [functions](#functions) - - [init](#init) - - [link](#link) - - [login](#login) - - [open](#open) - - [sites](#sites) - - [status](#status) - - [switch](#switch) - - [unlink](#unlink) - - [watch](#watch) + * [addons](#addons) + * [api](#api) + * [build](#build) + * [deploy](#deploy) + * [dev](#dev) + * [functions](#functions) + * [init](#init) + * [link](#link) + * [login](#login) + * [open](#open) + * [sites](#sites) + * [status](#status) + * [switch](#switch) + * [unlink](#unlink) + * [watch](#watch) - [Contributing](#contributing) - [Development](#development) - [License](#license) @@ -68,18 +68,18 @@ For a full command reference, see the list below, or visit [cli.netlify.com](htt ## Commands - ### [addons](/docs/commands/addons.md) (Beta) Manage Netlify Add-ons -| Subcommand | description | -| :------------------------------------------------------- | :---------------------------------------- | -| [`addons:auth`](/docs/commands/addons.md#addonsauth) | Login to add-on provider | -| [`addons:config`](/docs/commands/addons.md#addonsconfig) | Configure add-on settings | -| [`addons:create`](/docs/commands/addons.md#addonscreate) | Add an add-on extension to your site | -| [`addons:delete`](/docs/commands/addons.md#addonsdelete) | Remove an add-on extension to your site | -| [`addons:list`](/docs/commands/addons.md#addonslist) | List currently installed add-ons for site | +| Subcommand | description | +|:--------------------------- |:-----| +| [`addons:auth`](/docs/commands/addons.md#addonsauth) | Login to add-on provider | +| [`addons:config`](/docs/commands/addons.md#addonsconfig) | Configure add-on settings | +| [`addons:create`](/docs/commands/addons.md#addonscreate) | Add an add-on extension to your site | +| [`addons:delete`](/docs/commands/addons.md#addonsdelete) | Remove an add-on extension to your site | +| [`addons:list`](/docs/commands/addons.md#addonslist) | List currently installed add-ons for site | + ### [api](/docs/commands/api.md) @@ -97,19 +97,21 @@ Create a new deploy from the contents of a folder Local dev server -| Subcommand | description | -| :------------------------------------------ | :----------- | -| [`dev:exec`](/docs/commands/dev.md#devexec) | Exec command | +| Subcommand | description | +|:--------------------------- |:-----| +| [`dev:exec`](/docs/commands/dev.md#devexec) | Exec command | + ### [functions](/docs/commands/functions.md) Manage netlify functions -| Subcommand | description | -| :---------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------- | -| [`functions:build`](/docs/commands/functions.md#functionsbuild) | Build functions locally | -| [`functions:create`](/docs/commands/functions.md#functionscreate) | Create a new function locally | -| [`functions:invoke`](/docs/commands/functions.md#functionsinvoke) | Trigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions | +| Subcommand | description | +|:--------------------------- |:-----| +| [`functions:build`](/docs/commands/functions.md#functionsbuild) | Build functions locally | +| [`functions:create`](/docs/commands/functions.md#functionscreate) | Create a new function locally | +| [`functions:invoke`](/docs/commands/functions.md#functionsinvoke) | Trigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions | + ### [init](/docs/commands/init.md) @@ -127,28 +129,31 @@ Login to your Netlify account Open settings for the site linked to the current folder -| Subcommand | description | -| :----------------------------------------------- | :------------------------------------- | -| [`open:admin`](/docs/commands/open.md#openadmin) | Opens current site admin UI in Netlify | -| [`open:site`](/docs/commands/open.md#opensite) | Opens current site url in browser | +| Subcommand | description | +|:--------------------------- |:-----| +| [`open:admin`](/docs/commands/open.md#openadmin) | Opens current site admin UI in Netlify | +| [`open:site`](/docs/commands/open.md#opensite) | Opens current site url in browser | + ### [sites](/docs/commands/sites.md) Handle various site operations -| Subcommand | description | -| :---------------------------------------------------- | :-------------------------------- | -| [`sites:create`](/docs/commands/sites.md#sitescreate) | Create an empty site (advanced) | -| [`sites:delete`](/docs/commands/sites.md#sitesdelete) | Delete a site | -| [`sites:list`](/docs/commands/sites.md#siteslist) | List all sites you have access to | +| Subcommand | description | +|:--------------------------- |:-----| +| [`sites:create`](/docs/commands/sites.md#sitescreate) | Create an empty site (advanced) | +| [`sites:delete`](/docs/commands/sites.md#sitesdelete) | Delete a site | +| [`sites:list`](/docs/commands/sites.md#siteslist) | List all sites you have access to | + ### [status](/docs/commands/status.md) Print status information -| Subcommand | description | -| :----------------------------------------------------- | :---------------------------------------- | -| [`status:hooks`](/docs/commands/status.md#statushooks) | Print hook information of the linked site | +| Subcommand | description | +|:--------------------------- |:-----| +| [`status:hooks`](/docs/commands/status.md#statushooks) | Print hook information of the linked site | + ### [switch](/docs/commands/switch.md) @@ -162,6 +167,7 @@ Unlink a local folder from a Netlify site Watch for site deploy to finish + ## Contributing diff --git a/docs/README.md b/docs/README.md index f55ca1c0c5e..71a1e1c09dc 100644 --- a/docs/README.md +++ b/docs/README.md @@ -34,18 +34,18 @@ netlify [command] help ## Commands - ### [addons](/docs/commands/addons.md) (Beta) Manage Netlify Add-ons -| Subcommand | description | -| :------------------------------------------------------- | :---------------------------------------- | -| [`addons:auth`](/docs/commands/addons.md#addonsauth) | Login to add-on provider | -| [`addons:config`](/docs/commands/addons.md#addonsconfig) | Configure add-on settings | -| [`addons:create`](/docs/commands/addons.md#addonscreate) | Add an add-on extension to your site | -| [`addons:delete`](/docs/commands/addons.md#addonsdelete) | Remove an add-on extension to your site | -| [`addons:list`](/docs/commands/addons.md#addonslist) | List currently installed add-ons for site | +| Subcommand | description | +|:--------------------------- |:-----| +| [`addons:auth`](/docs/commands/addons.md#addonsauth) | Login to add-on provider | +| [`addons:config`](/docs/commands/addons.md#addonsconfig) | Configure add-on settings | +| [`addons:create`](/docs/commands/addons.md#addonscreate) | Add an add-on extension to your site | +| [`addons:delete`](/docs/commands/addons.md#addonsdelete) | Remove an add-on extension to your site | +| [`addons:list`](/docs/commands/addons.md#addonslist) | List currently installed add-ons for site | + ### [api](/docs/commands/api.md) @@ -63,19 +63,21 @@ Create a new deploy from the contents of a folder Local dev server -| Subcommand | description | -| :------------------------------------------ | :----------- | -| [`dev:exec`](/docs/commands/dev.md#devexec) | Exec command | +| Subcommand | description | +|:--------------------------- |:-----| +| [`dev:exec`](/docs/commands/dev.md#devexec) | Exec command | + ### [functions](/docs/commands/functions.md) Manage netlify functions -| Subcommand | description | -| :---------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------- | -| [`functions:build`](/docs/commands/functions.md#functionsbuild) | Build functions locally | -| [`functions:create`](/docs/commands/functions.md#functionscreate) | Create a new function locally | -| [`functions:invoke`](/docs/commands/functions.md#functionsinvoke) | Trigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions | +| Subcommand | description | +|:--------------------------- |:-----| +| [`functions:build`](/docs/commands/functions.md#functionsbuild) | Build functions locally | +| [`functions:create`](/docs/commands/functions.md#functionscreate) | Create a new function locally | +| [`functions:invoke`](/docs/commands/functions.md#functionsinvoke) | Trigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions | + ### [init](/docs/commands/init.md) @@ -93,28 +95,31 @@ Login to your Netlify account Open settings for the site linked to the current folder -| Subcommand | description | -| :----------------------------------------------- | :------------------------------------- | -| [`open:admin`](/docs/commands/open.md#openadmin) | Opens current site admin UI in Netlify | -| [`open:site`](/docs/commands/open.md#opensite) | Opens current site url in browser | +| Subcommand | description | +|:--------------------------- |:-----| +| [`open:admin`](/docs/commands/open.md#openadmin) | Opens current site admin UI in Netlify | +| [`open:site`](/docs/commands/open.md#opensite) | Opens current site url in browser | + ### [sites](/docs/commands/sites.md) Handle various site operations -| Subcommand | description | -| :---------------------------------------------------- | :-------------------------------- | -| [`sites:create`](/docs/commands/sites.md#sitescreate) | Create an empty site (advanced) | -| [`sites:delete`](/docs/commands/sites.md#sitesdelete) | Delete a site | -| [`sites:list`](/docs/commands/sites.md#siteslist) | List all sites you have access to | +| Subcommand | description | +|:--------------------------- |:-----| +| [`sites:create`](/docs/commands/sites.md#sitescreate) | Create an empty site (advanced) | +| [`sites:delete`](/docs/commands/sites.md#sitesdelete) | Delete a site | +| [`sites:list`](/docs/commands/sites.md#siteslist) | List all sites you have access to | + ### [status](/docs/commands/status.md) Print status information -| Subcommand | description | -| :----------------------------------------------------- | :---------------------------------------- | -| [`status:hooks`](/docs/commands/status.md#statushooks) | Print hook information of the linked site | +| Subcommand | description | +|:--------------------------- |:-----| +| [`status:hooks`](/docs/commands/status.md#statushooks) | Print hook information of the linked site | + ### [switch](/docs/commands/switch.md) @@ -128,4 +133,5 @@ Unlink a local folder from a Netlify site Watch for site deploy to finish + diff --git a/docs/commands/addons.md b/docs/commands/addons.md index 01a3668742d..276e6987bb4 100644 --- a/docs/commands/addons.md +++ b/docs/commands/addons.md @@ -11,7 +11,6 @@ For more information on add-ons see our [Netlify partner add-ons docs](https://w ## About - (Beta) Manage Netlify Add-ons **Usage** @@ -20,13 +19,14 @@ For more information on add-ons see our [Netlify partner add-ons docs](https://w netlify addons ``` -| Subcommand | description | -| :------------------------------------------------------- | :---------------------------------------- | -| [`addons:auth`](/docs/commands/addons.md#addonsauth) | Login to add-on provider | -| [`addons:config`](/docs/commands/addons.md#addonsconfig) | Configure add-on settings | -| [`addons:create`](/docs/commands/addons.md#addonscreate) | Add an add-on extension to your site | -| [`addons:delete`](/docs/commands/addons.md#addonsdelete) | Remove an add-on extension to your site | -| [`addons:list`](/docs/commands/addons.md#addonslist) | List currently installed add-ons for site | +| Subcommand | description | +|:--------------------------- |:-----| +| [`addons:auth`](/docs/commands/addons.md#addonsauth) | Login to add-on provider | +| [`addons:config`](/docs/commands/addons.md#addonsconfig) | Configure add-on settings | +| [`addons:create`](/docs/commands/addons.md#addonscreate) | Add an add-on extension to your site | +| [`addons:delete`](/docs/commands/addons.md#addonsdelete) | Remove an add-on extension to your site | +| [`addons:list`](/docs/commands/addons.md#addonslist) | List currently installed add-ons for site | + **Examples** @@ -39,7 +39,6 @@ netlify addons:auth addon-xyz ``` --- - ## `addons:auth` Login to add-on provider @@ -55,7 +54,6 @@ netlify addons:auth - name - Add-on slug --- - ## `addons:config` Configure add-on settings @@ -71,13 +69,13 @@ netlify addons:config - name - Add-on namespace --- - ## `addons:create` Add an add-on extension to your site ... Add-ons are a way to extend the functionality of your Netlify site + **Usage** ```bash @@ -89,13 +87,13 @@ netlify addons:create - name - Add-on namespace --- - ## `addons:delete` Remove an add-on extension to your site ... Add-ons are a way to extend the functionality of your Netlify site + **Usage** ```bash @@ -108,10 +106,9 @@ netlify addons:delete **Flags** -- `force` (_boolean_) - delete without prompting (useful for CI) +- `force` (*boolean*) - delete without prompting (useful for CI) --- - ## `addons:list` List currently installed add-ons for site @@ -124,7 +121,7 @@ netlify addons:list **Flags** -- `json` (_boolean_) - Output add-on data as JSON +- `json` (*boolean*) - Output add-on data as JSON --- diff --git a/docs/commands/api.md b/docs/commands/api.md index 740a84e8c45..dcd6bcb69b3 100644 --- a/docs/commands/api.md +++ b/docs/commands/api.md @@ -7,11 +7,11 @@ title: Netlify CLI api command The `api` command will let you call any [Netlify open API methods](https://open-api.netlify.com/) - Run any Netlify API method For more information on available methods checkout https://open-api.netlify.com/ or run "netlify api --list" + **Usage** ```bash @@ -24,8 +24,8 @@ netlify api **Flags** -- `data` (_option_) - Data to use -- `list` (_boolean_) - List out available API methods +- `data` (*option*) - Data to use +- `list` (*boolean*) - List out available API methods **Examples** @@ -34,4 +34,5 @@ netlify api --list netlify api getSite --data '{ "site_id": "123456"}' ``` + diff --git a/docs/commands/build.md b/docs/commands/build.md index 8daa7914ab2..688097682b3 100644 --- a/docs/commands/build.md +++ b/docs/commands/build.md @@ -5,7 +5,6 @@ title: Netlify CLI build command # `build` - (Beta) Build on your local machine **Usage** @@ -16,8 +15,8 @@ netlify build **Flags** -- `dry` (_boolean_) - Dry run: show instructions without running them -- `context` (_option_) - Build context +- `dry` (*boolean*) - Dry run: show instructions without running them +- `context` (*option*) - Build context **Examples** @@ -25,4 +24,5 @@ netlify build netlify build ``` + diff --git a/docs/commands/deploy.md b/docs/commands/deploy.md index 560cbe60074..f97382e74a6 100644 --- a/docs/commands/deploy.md +++ b/docs/commands/deploy.md @@ -5,7 +5,6 @@ title: Netlify CLI deploy command # `deploy` - 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. @@ -17,7 +16,9 @@ The following environment variables can be used to override configuration file l Lambda functions in the function folder can be in the following configurations for deployment: -## Built Go binaries: + +Built Go binaries: +------------------ ``` functions/ @@ -26,7 +27,9 @@ functions/ Build binaries of your Go language functions into the functions folder as part of your build process. -## Single file Node.js functions: + +Single file Node.js functions: +----------------------------- Build dependency bundled Node.js lambda functions with tools like netlify-lambda, webpack or browserify into the function folder as part of your build process. @@ -35,7 +38,8 @@ functions/ └── nameOfBundledNodeJSFunction.js ``` -## Unbundled Node.js functions that have dependencies outside or inside of the functions folder: +Unbundled Node.js functions that have dependencies outside or inside of the functions folder: +--------------------------------------------------------------------------------------------- You can ship unbundled Node.js functions with the CLI, utilizing top level project dependencies, or a nested package.json. If you use nested dependencies, be sure to populate the nested node_modules as part of your build process before deploying using npm or yarn. @@ -55,7 +59,9 @@ project/ Any mix of these configurations works as well. -## Node.js function entry points + +Node.js function entry points +----------------------------- Function entry points are determined by the file name and name of the folder they are in: @@ -69,6 +75,7 @@ functions/ Support for package.json's main field, and intrinsic index.js entrypoints are coming soon. + **Usage** ```bash @@ -77,16 +84,16 @@ netlify deploy **Flags** -- `dir` (_option_) - Specify a folder to deploy -- `functions` (_option_) - Specify a functions folder to deploy -- `prod` (_boolean_) - Deploy to production -- `open` (_boolean_) - Open site after deploy -- `message` (_option_) - A short message to include in the deploy log -- `auth` (_option_) - Netlify auth token to deploy with -- `site` (_option_) - A site ID to deploy to -- `json` (_boolean_) - Output deployment data as JSON -- `timeout` (_option_) - Timeout to wait for deployment to finish -- `trigger` (_boolean_) - Trigger a new build of your site on Netlify without uploading local files +- `dir` (*option*) - Specify a folder to deploy +- `functions` (*option*) - Specify a functions folder to deploy +- `prod` (*boolean*) - Deploy to production +- `open` (*boolean*) - Open site after deploy +- `message` (*option*) - A short message to include in the deploy log +- `auth` (*option*) - Netlify auth token to deploy with +- `site` (*option*) - A site ID to deploy to +- `json` (*boolean*) - Output deployment data as JSON +- `timeout` (*option*) - Timeout to wait for deployment to finish +- `trigger` (*boolean*) - Trigger a new build of your site on Netlify without uploading local files **Examples** @@ -99,4 +106,5 @@ netlify deploy --auth $NETLIFY_AUTH_TOKEN netlify deploy --trigger ``` + diff --git a/docs/commands/dev.md b/docs/commands/dev.md index f2e466c5cdc..8aee42d47cb 100644 --- a/docs/commands/dev.md +++ b/docs/commands/dev.md @@ -6,10 +6,10 @@ description: Run netlify dev locally # `dev` - Local dev server The dev command will run a local dev server with Netlify's proxy and redirect rules + **Usage** ```bash @@ -18,17 +18,18 @@ netlify dev **Flags** -- `command` (_option_) - command to run -- `port` (_option_) - port of netlify dev -- `targetPort` (_option_) - port of target app server -- `dir` (_option_) - dir with static files -- `functions` (_option_) - Specify a functions folder to serve -- `offline` (_boolean_) - disables any features that require network access -- `live` (_boolean_) - Start a public live session +- `command` (*option*) - command to run +- `port` (*option*) - port of netlify dev +- `targetPort` (*option*) - port of target app server +- `dir` (*option*) - dir with static files +- `functions` (*option*) - Specify a functions folder to serve +- `offline` (*boolean*) - disables any features that require network access +- `live` (*boolean*) - Start a public live session + +| Subcommand | description | +|:--------------------------- |:-----| +| [`dev:exec`](/docs/commands/dev.md#devexec) | Exec command | -| Subcommand | description | -| :------------------------------------------ | :----------- | -| [`dev:exec`](/docs/commands/dev.md#devexec) | Exec command | **Examples** @@ -39,12 +40,12 @@ $ netlify dev -c hugo ``` --- - ## `dev:exec` Exec command Runs a command within the netlify dev environment, e.g. with env variables from any installed addons + **Usage** ```bash diff --git a/docs/commands/functions.md b/docs/commands/functions.md index e3983322436..c931da1509c 100644 --- a/docs/commands/functions.md +++ b/docs/commands/functions.md @@ -6,21 +6,22 @@ description: Run netlify dev locally # `functions` - Manage netlify functions The `functions` command will help you manage the functions in this site + **Usage** ```bash netlify functions ``` -| Subcommand | description | -| :---------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------- | -| [`functions:build`](/docs/commands/functions.md#functionsbuild) | Build functions locally | -| [`functions:create`](/docs/commands/functions.md#functionscreate) | Create a new function locally | -| [`functions:invoke`](/docs/commands/functions.md#functionsinvoke) | Trigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions | +| Subcommand | description | +|:--------------------------- |:-----| +| [`functions:build`](/docs/commands/functions.md#functionsbuild) | Build functions locally | +| [`functions:create`](/docs/commands/functions.md#functionscreate) | Create a new function locally | +| [`functions:invoke`](/docs/commands/functions.md#functionsinvoke) | Trigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions | + **Examples** @@ -30,11 +31,11 @@ netlify functions:build --name function-abc --timeout 30s ``` --- - ## `functions:build` Build functions locally + **Usage** ```bash @@ -43,11 +44,10 @@ netlify functions:build **Flags** -- `functions` (_option_) - Specify a functions folder to build to -- `src` (_option_) - Specify the source folder for the functions +- `functions` (*option*) - Specify a functions folder to build to +- `src` (*option*) - Specify the source folder for the functions --- - ## `functions:create` Create a new function locally @@ -64,8 +64,8 @@ netlify functions:create **Flags** -- `name` (_option_) - function name -- `url` (_option_) - pull template from URL +- `name` (*option*) - function name +- `url` (*option*) - pull template from URL **Examples** @@ -76,7 +76,6 @@ netlify functions:create --name hello-world ``` --- - ## `functions:invoke` Trigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions @@ -93,12 +92,12 @@ netlify functions:invoke **Flags** -- `name` (_option_) - function name to invoke -- `functions` (_option_) - Specify a functions folder to parse, overriding netlify.toml -- `querystring` (_option_) - Querystring to add to your function invocation -- `payload` (_option_) - Supply POST payload in stringified json, or a path to a json file -- `identity` (_boolean_) - simulate Netlify Identity authentication JWT. pass --no-identity to affirm unauthenticated request -- `port` (_option_) - Port where netlify dev is accessible. e.g. 8888 +- `name` (*option*) - function name to invoke +- `functions` (*option*) - Specify a functions folder to parse, overriding netlify.toml +- `querystring` (*option*) - Querystring to add to your function invocation +- `payload` (*option*) - Supply POST payload in stringified json, or a path to a json file +- `identity` (*boolean*) - simulate Netlify Identity authentication JWT. pass --no-identity to affirm unauthenticated request +- `port` (*option*) - Port where netlify dev is accessible. e.g. 8888 **Examples** diff --git a/docs/commands/index.md b/docs/commands/index.md index c4630c65298..363c25f9bed 100644 --- a/docs/commands/index.md +++ b/docs/commands/index.md @@ -20,18 +20,18 @@ netlify [command] help ## Commands - ### [addons](/docs/commands/addons.md) (Beta) Manage Netlify Add-ons -| Subcommand | description | -| :------------------------------------------------------- | :---------------------------------------- | -| [`addons:auth`](/docs/commands/addons.md#addonsauth) | Login to add-on provider | -| [`addons:config`](/docs/commands/addons.md#addonsconfig) | Configure add-on settings | -| [`addons:create`](/docs/commands/addons.md#addonscreate) | Add an add-on extension to your site | -| [`addons:delete`](/docs/commands/addons.md#addonsdelete) | Remove an add-on extension to your site | -| [`addons:list`](/docs/commands/addons.md#addonslist) | List currently installed add-ons for site | +| Subcommand | description | +|:--------------------------- |:-----| +| [`addons:auth`](/docs/commands/addons.md#addonsauth) | Login to add-on provider | +| [`addons:config`](/docs/commands/addons.md#addonsconfig) | Configure add-on settings | +| [`addons:create`](/docs/commands/addons.md#addonscreate) | Add an add-on extension to your site | +| [`addons:delete`](/docs/commands/addons.md#addonsdelete) | Remove an add-on extension to your site | +| [`addons:list`](/docs/commands/addons.md#addonslist) | List currently installed add-ons for site | + ### [api](/docs/commands/api.md) @@ -49,19 +49,21 @@ Create a new deploy from the contents of a folder Local dev server -| Subcommand | description | -| :------------------------------------------ | :----------- | -| [`dev:exec`](/docs/commands/dev.md#devexec) | Exec command | +| Subcommand | description | +|:--------------------------- |:-----| +| [`dev:exec`](/docs/commands/dev.md#devexec) | Exec command | + ### [functions](/docs/commands/functions.md) Manage netlify functions -| Subcommand | description | -| :---------------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------------------------------------- | -| [`functions:build`](/docs/commands/functions.md#functionsbuild) | Build functions locally | -| [`functions:create`](/docs/commands/functions.md#functionscreate) | Create a new function locally | -| [`functions:invoke`](/docs/commands/functions.md#functionsinvoke) | Trigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions | +| Subcommand | description | +|:--------------------------- |:-----| +| [`functions:build`](/docs/commands/functions.md#functionsbuild) | Build functions locally | +| [`functions:create`](/docs/commands/functions.md#functionscreate) | Create a new function locally | +| [`functions:invoke`](/docs/commands/functions.md#functionsinvoke) | Trigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions | + ### [init](/docs/commands/init.md) @@ -79,28 +81,31 @@ Login to your Netlify account Open settings for the site linked to the current folder -| Subcommand | description | -| :----------------------------------------------- | :------------------------------------- | -| [`open:admin`](/docs/commands/open.md#openadmin) | Opens current site admin UI in Netlify | -| [`open:site`](/docs/commands/open.md#opensite) | Opens current site url in browser | +| Subcommand | description | +|:--------------------------- |:-----| +| [`open:admin`](/docs/commands/open.md#openadmin) | Opens current site admin UI in Netlify | +| [`open:site`](/docs/commands/open.md#opensite) | Opens current site url in browser | + ### [sites](/docs/commands/sites.md) Handle various site operations -| Subcommand | description | -| :---------------------------------------------------- | :-------------------------------- | -| [`sites:create`](/docs/commands/sites.md#sitescreate) | Create an empty site (advanced) | -| [`sites:delete`](/docs/commands/sites.md#sitesdelete) | Delete a site | -| [`sites:list`](/docs/commands/sites.md#siteslist) | List all sites you have access to | +| Subcommand | description | +|:--------------------------- |:-----| +| [`sites:create`](/docs/commands/sites.md#sitescreate) | Create an empty site (advanced) | +| [`sites:delete`](/docs/commands/sites.md#sitesdelete) | Delete a site | +| [`sites:list`](/docs/commands/sites.md#siteslist) | List all sites you have access to | + ### [status](/docs/commands/status.md) Print status information -| Subcommand | description | -| :----------------------------------------------------- | :---------------------------------------- | -| [`status:hooks`](/docs/commands/status.md#statushooks) | Print hook information of the linked site | +| Subcommand | description | +|:--------------------------- |:-----| +| [`status:hooks`](/docs/commands/status.md#statushooks) | Print hook information of the linked site | + ### [switch](/docs/commands/switch.md) @@ -114,4 +119,5 @@ Unlink a local folder from a Netlify site Watch for site deploy to finish + diff --git a/docs/commands/init.md b/docs/commands/init.md index 70fb85451ba..5ddcd1d32c3 100644 --- a/docs/commands/init.md +++ b/docs/commands/init.md @@ -6,7 +6,6 @@ description: Initialize a new site locally # `init` - Configure continuous deployment for a new or existing site **Usage** @@ -17,8 +16,9 @@ netlify init **Flags** -- `manual` (_boolean_) - Manually configure a git remote for CI -- `force` (_boolean_) - Reinitialize CI hooks if the linked site is already configured to use CI -- `gitRemoteName` (_option_) - Name of Git remote to use. e.g. "origin" +- `manual` (*boolean*) - Manually configure a git remote for CI +- `force` (*boolean*) - Reinitialize CI hooks if the linked site is already configured to use CI +- `gitRemoteName` (*option*) - Name of Git remote to use. e.g. "origin" + diff --git a/docs/commands/link.md b/docs/commands/link.md index 66ed48b605e..6d624386842 100644 --- a/docs/commands/link.md +++ b/docs/commands/link.md @@ -6,7 +6,6 @@ description: Link an existing site to a local site directory # `link` - Link a local repo or project folder to an existing site on Netlify **Usage** @@ -17,9 +16,9 @@ netlify link **Flags** -- `id` (_option_) - ID of site to link to -- `name` (_option_) - Name of site to link to -- `gitRemoteName` (_option_) - Name of Git remote to use. e.g. "origin" +- `id` (*option*) - ID of site to link to +- `name` (*option*) - Name of site to link to +- `gitRemoteName` (*option*) - Name of Git remote to use. e.g. "origin" **Examples** @@ -29,4 +28,5 @@ netlify link --id 123-123-123-123 netlify link --name my-site-name ``` + diff --git a/docs/commands/login.md b/docs/commands/login.md index 93b7922c058..e1e37a8cd0b 100644 --- a/docs/commands/login.md +++ b/docs/commands/login.md @@ -6,11 +6,11 @@ description: Login to your Netlify account # `login` - Login to your Netlify account Opens a web browser to acquire an OAuth token. + **Usage** ```bash @@ -19,6 +19,7 @@ netlify login **Flags** -- `new` (_boolean_) - Login to new Netlify account +- `new` (*boolean*) - Login to new Netlify account + diff --git a/docs/commands/logout.md b/docs/commands/logout.md index a8e2eecbd5d..582f650b4d3 100644 --- a/docs/commands/logout.md +++ b/docs/commands/logout.md @@ -7,7 +7,6 @@ hidden: true # `logout` - Logout of your Netlify account **Usage** @@ -15,5 +14,4 @@ Logout of your Netlify account ```bash netlify logout ``` - diff --git a/docs/commands/open.md b/docs/commands/open.md index e0e2f7cb763..0217326801f 100644 --- a/docs/commands/open.md +++ b/docs/commands/open.md @@ -5,7 +5,6 @@ title: Netlify CLI open command # `open` - Open settings for the site linked to the current folder **Usage** @@ -16,13 +15,14 @@ netlify open **Flags** -- `site` (_boolean_) - Open site -- `admin` (_boolean_) - Open Netlify site +- `site` (*boolean*) - Open site +- `admin` (*boolean*) - Open Netlify site + +| Subcommand | description | +|:--------------------------- |:-----| +| [`open:admin`](/docs/commands/open.md#openadmin) | Opens current site admin UI in Netlify | +| [`open:site`](/docs/commands/open.md#opensite) | Opens current site url in browser | -| Subcommand | description | -| :----------------------------------------------- | :------------------------------------- | -| [`open:admin`](/docs/commands/open.md#openadmin) | Opens current site admin UI in Netlify | -| [`open:site`](/docs/commands/open.md#opensite) | Opens current site url in browser | **Examples** @@ -34,7 +34,6 @@ netlify open:site ``` --- - ## `open:admin` Opens current site admin UI in Netlify @@ -52,7 +51,6 @@ netlify open:admin ``` --- - ## `open:site` Opens current site url in browser diff --git a/docs/commands/sites.md b/docs/commands/sites.md index 0c7dde6e023..c855e7ce635 100644 --- a/docs/commands/sites.md +++ b/docs/commands/sites.md @@ -6,21 +6,22 @@ description: Manage Netlify sites via the command line # `sites` - Handle various site operations The sites command will help you manage all your sites + **Usage** ```bash netlify sites ``` -| Subcommand | description | -| :---------------------------------------------------- | :-------------------------------- | -| [`sites:create`](/docs/commands/sites.md#sitescreate) | Create an empty site (advanced) | -| [`sites:delete`](/docs/commands/sites.md#sitesdelete) | Delete a site | -| [`sites:list`](/docs/commands/sites.md#siteslist) | List all sites you have access to | +| Subcommand | description | +|:--------------------------- |:-----| +| [`sites:create`](/docs/commands/sites.md#sitescreate) | Create an empty site (advanced) | +| [`sites:delete`](/docs/commands/sites.md#sitesdelete) | Delete a site | +| [`sites:list`](/docs/commands/sites.md#siteslist) | List all sites you have access to | + **Examples** @@ -30,12 +31,12 @@ netlify sites:list ``` --- - ## `sites:create` 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. +Create a blank site that isn't associated with any git remote. Does not link to the current working directory. + **Usage** @@ -45,19 +46,19 @@ netlify sites:create **Flags** -- `name` (_option_) - name of site -- `account-slug` (_option_) - account slug to create the site under -- `with-ci` (_boolean_) - initialize CI hooks during site creation -- `manual` (_boolean_) - Force manual CI setup. Used --with-ci flag +- `name` (*option*) - name of site +- `account-slug` (*option*) - account slug to create the site under +- `with-ci` (*boolean*) - initialize CI hooks during site creation +- `manual` (*boolean*) - Force manual CI setup. Used --with-ci flag --- - ## `sites:delete` Delete a site This command will permanently delete the site on Netlify. Use with caution. + **Usage** ```bash @@ -70,7 +71,7 @@ netlify sites:delete {site-id} **Flags** -- `force` (_boolean_) - delete without prompting (useful for CI) +- `force` (*boolean*) - delete without prompting (useful for CI) **Examples** @@ -79,7 +80,6 @@ netlify site:delete 1234-3262-1211 ``` --- - ## `sites:list` List all sites you have access to @@ -92,7 +92,7 @@ netlify sites:list **Flags** -- `json` (_boolean_) - Output site data as JSON +- `json` (*boolean*) - Output site data as JSON --- diff --git a/docs/commands/status.md b/docs/commands/status.md index 6c6a6144f0f..e3aa724fcd9 100644 --- a/docs/commands/status.md +++ b/docs/commands/status.md @@ -6,7 +6,6 @@ description: Get the current context of the netlify CLI # `status` - Print status information **Usage** @@ -17,14 +16,14 @@ netlify status **Flags** -- `verbose` (_boolean_) - Output system info +- `verbose` (*boolean*) - Output system info -| Subcommand | description | -| :----------------------------------------------------- | :---------------------------------------- | -| [`status:hooks`](/docs/commands/status.md#statushooks) | Print hook information of the linked site | +| Subcommand | description | +|:--------------------------- |:-----| +| [`status:hooks`](/docs/commands/status.md#statushooks) | Print hook information of the linked site | ---- +--- ## `status:hooks` Print hook information of the linked site diff --git a/docs/commands/unlink.md b/docs/commands/unlink.md index 0777512686c..ee7a2818907 100644 --- a/docs/commands/unlink.md +++ b/docs/commands/unlink.md @@ -6,7 +6,6 @@ description: Link an existing site to a local site directory # `unlink` - Unlink a local folder from a Netlify site **Usage** @@ -15,4 +14,5 @@ Unlink a local folder from a Netlify site netlify unlink ``` + diff --git a/docs/commands/watch.md b/docs/commands/watch.md index 014dedb4c4e..2a6bbaa544b 100644 --- a/docs/commands/watch.md +++ b/docs/commands/watch.md @@ -6,7 +6,6 @@ hidden: true # `watch` - Watch for site deploy to finish **Usage** @@ -22,4 +21,5 @@ netlify watch git push && netlify watch ``` + diff --git a/package-lock.json b/package-lock.json index 9ed7725bf93..4bfd297d2e5 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "netlify-cli", - "version": "2.51.0", + "version": "2.52.0", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index f1fd53b6d21..5558423c88c 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "netlify-cli", "description": "Netlify command line tool", - "version": "2.51.0", + "version": "2.52.0", "author": "Netlify Inc.", "contributors": [ "Mathias Biilmann (https://twitter.com/biilmann)",