diff --git a/README.md b/README.md index 46bf1e59b67..7590e23736c 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,21 +97,19 @@ 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) @@ -129,31 +127,28 @@ 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) @@ -167,7 +162,6 @@ 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 71a1e1c09dc..f55ca1c0c5e 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,21 +63,19 @@ 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) @@ -95,31 +93,28 @@ 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) @@ -133,5 +128,4 @@ 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 276e6987bb4..01a3668742d 100644 --- a/docs/commands/addons.md +++ b/docs/commands/addons.md @@ -11,6 +11,7 @@ For more information on add-ons see our [Netlify partner add-ons docs](https://w ## About + (Beta) Manage Netlify Add-ons **Usage** @@ -19,14 +20,13 @@ 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,6 +39,7 @@ netlify addons:auth addon-xyz ``` --- + ## `addons:auth` Login to add-on provider @@ -54,6 +55,7 @@ netlify addons:auth - name - Add-on slug --- + ## `addons:config` Configure add-on settings @@ -69,13 +71,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 @@ -87,13 +89,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 @@ -106,9 +108,10 @@ 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 @@ -121,7 +124,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 dcd6bcb69b3..740a84e8c45 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,5 +34,4 @@ netlify api --list netlify api getSite --data '{ "site_id": "123456"}' ``` - diff --git a/docs/commands/build.md b/docs/commands/build.md index 688097682b3..8daa7914ab2 100644 --- a/docs/commands/build.md +++ b/docs/commands/build.md @@ -5,6 +5,7 @@ title: Netlify CLI build command # `build` + (Beta) Build on your local machine **Usage** @@ -15,8 +16,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** @@ -24,5 +25,4 @@ netlify build netlify build ``` - diff --git a/docs/commands/deploy.md b/docs/commands/deploy.md index bb452b2fb8e..60f093f786a 100644 --- a/docs/commands/deploy.md +++ b/docs/commands/deploy.md @@ -5,6 +5,7 @@ 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. @@ -16,9 +17,7 @@ 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/ @@ -27,9 +26,7 @@ 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. @@ -38,8 +35,7 @@ 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. @@ -59,9 +55,7 @@ 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: @@ -75,7 +69,6 @@ functions/ Support for package.json's main field, and intrinsic index.js entrypoints are coming soon. - **Usage** ```bash @@ -84,17 +77,17 @@ netlify deploy **Flags** -- `dir` (*option*) - Specify a folder to deploy -- `functions` (*option*) - Specify a functions folder to deploy -- `prod` (*boolean*) - Deploy to production -- `branch` (*option*) - Specifies the branch for deployment. Useful for creating specific deployment URL's -- `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 +- `branch` (_option_) - Specifies the branch for deployment. Useful for creating specific deployment URL's +- `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** @@ -107,5 +100,4 @@ netlify deploy --auth $NETLIFY_AUTH_TOKEN netlify deploy --trigger ``` - diff --git a/docs/commands/dev.md b/docs/commands/dev.md index 8aee42d47cb..f2e466c5cdc 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,18 +18,17 @@ 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 - -| Subcommand | description | -|:--------------------------- |:-----| -| [`dev:exec`](/docs/commands/dev.md#devexec) | Exec command | +- `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 | **Examples** @@ -40,12 +39,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 c931da1509c..e3983322436 100644 --- a/docs/commands/functions.md +++ b/docs/commands/functions.md @@ -6,22 +6,21 @@ 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** @@ -31,11 +30,11 @@ netlify functions:build --name function-abc --timeout 30s ``` --- + ## `functions:build` Build functions locally - **Usage** ```bash @@ -44,10 +43,11 @@ 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,6 +76,7 @@ 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 @@ -92,12 +93,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 363c25f9bed..c4630c65298 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,21 +49,19 @@ 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) @@ -81,31 +79,28 @@ 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) @@ -119,5 +114,4 @@ 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 5ddcd1d32c3..70fb85451ba 100644 --- a/docs/commands/init.md +++ b/docs/commands/init.md @@ -6,6 +6,7 @@ description: Initialize a new site locally # `init` + Configure continuous deployment for a new or existing site **Usage** @@ -16,9 +17,8 @@ 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 6d624386842..66ed48b605e 100644 --- a/docs/commands/link.md +++ b/docs/commands/link.md @@ -6,6 +6,7 @@ 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** @@ -16,9 +17,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** @@ -28,5 +29,4 @@ 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 e1e37a8cd0b..93b7922c058 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,7 +19,6 @@ 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 582f650b4d3..a8e2eecbd5d 100644 --- a/docs/commands/logout.md +++ b/docs/commands/logout.md @@ -7,6 +7,7 @@ hidden: true # `logout` + Logout of your Netlify account **Usage** @@ -14,4 +15,5 @@ Logout of your Netlify account ```bash netlify logout ``` + diff --git a/docs/commands/open.md b/docs/commands/open.md index 0217326801f..e0e2f7cb763 100644 --- a/docs/commands/open.md +++ b/docs/commands/open.md @@ -5,6 +5,7 @@ title: Netlify CLI open command # `open` + Open settings for the site linked to the current folder **Usage** @@ -15,14 +16,13 @@ netlify open **Flags** -- `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 | +- `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 | **Examples** @@ -34,6 +34,7 @@ netlify open:site ``` --- + ## `open:admin` Opens current site admin UI in Netlify @@ -51,6 +52,7 @@ netlify open:admin ``` --- + ## `open:site` Opens current site url in browser diff --git a/docs/commands/sites.md b/docs/commands/sites.md index 89f63ec935c..7ff954b960c 100644 --- a/docs/commands/sites.md +++ b/docs/commands/sites.md @@ -6,22 +6,21 @@ 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** @@ -31,12 +30,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** @@ -46,19 +45,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 @@ -71,7 +70,7 @@ netlify sites:delete {site-id} **Flags** -- `force` (*boolean*) - delete without prompting (useful for CI) +- `force` (_boolean_) - delete without prompting (useful for CI) **Examples** @@ -80,6 +79,7 @@ netlify sites:delete 1234-3262-1211 --force ``` --- + ## `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 e3aa724fcd9..6c6a6144f0f 100644 --- a/docs/commands/status.md +++ b/docs/commands/status.md @@ -6,6 +6,7 @@ description: Get the current context of the netlify CLI # `status` + Print status information **Usage** @@ -16,14 +17,14 @@ netlify status **Flags** -- `verbose` (*boolean*) - Output system info - -| Subcommand | description | -|:--------------------------- |:-----| -| [`status:hooks`](/docs/commands/status.md#statushooks) | Print hook information of the linked site | +- `verbose` (_boolean_) - Output system info +| 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 ee7a2818907..0777512686c 100644 --- a/docs/commands/unlink.md +++ b/docs/commands/unlink.md @@ -6,6 +6,7 @@ description: Link an existing site to a local site directory # `unlink` + Unlink a local folder from a Netlify site **Usage** @@ -14,5 +15,4 @@ Unlink a local folder from a Netlify site netlify unlink ``` - diff --git a/docs/commands/watch.md b/docs/commands/watch.md index 2a6bbaa544b..014dedb4c4e 100644 --- a/docs/commands/watch.md +++ b/docs/commands/watch.md @@ -6,6 +6,7 @@ hidden: true # `watch` + Watch for site deploy to finish **Usage** @@ -21,5 +22,4 @@ netlify watch git push && netlify watch ``` -