Skip to content

Commit

Permalink
docs: update paths
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidWells committed Dec 12, 2019
1 parent 242e382 commit 3bb6ed1
Show file tree
Hide file tree
Showing 8 changed files with 175 additions and 175 deletions.
133 changes: 133 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
---
title: Netlify CLI Command List
description: All Netlify CLI commands
---

# Netlify CLI Command List

Welcome to the Netlify CLI! This site provides online access to all help strings in the Netlify CLI. For a more in-depth guide, please see our [Getting Started](https://www.netlify.com/docs/cli/) guide on our main docs site.

If you have questions, ideas, or would like to contribute, check out the [repository on Github](https://github.com/netlify/cli/).

**Install the CLI**

To install the CLI, pop open your terminal and install with `npm`.

```bash
npm install netlify-cli -g
```

**Listing commands**

To get a list of commands, run:

```
netlify help
```

To get a list of available sub-commands, arguments, and flags, run:

```
netlify [command] help
```

## Commands

<!-- AUTO-GENERATED-CONTENT:START (GENERATE_COMMANDS_LIST) -->
### [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 |


### [api](/docs/commands/api.md)

Run any Netlify API method

### [deploy](/docs/commands/deploy.md)

Create a new deploy from the contents of a folder

### [dev](/docs/commands/dev.md)

Local dev server

| 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 |


### [init](/docs/commands/init.md)

Configure continuous deployment for a new or existing site

### [link](/docs/commands/link.md)

Link a local repo or project folder to an existing site on Netlify

### [login](/docs/commands/login.md)

Login to your Netlify account

### [open](/docs/commands/open.md)

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 |


### [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 |


### [status](/docs/commands/status.md)

Print status information

| Subcommand | description |
|:--------------------------- |:-----|
| [`status:hooks`](/docs/commands/status.md#statushooks) | Print hook information of the linked site |


### [switch](/docs/commands/switch.md)

Switch your active Netlify account

### [unlink](/docs/commands/unlink.md)

Unlink a local folder from a Netlify site

### [watch](/docs/commands/watch.md)

Watch for site deploy to finish


<!-- AUTO-GENERATED-CONTENT:END -->
10 changes: 5 additions & 5 deletions docs/commands/addons.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,11 @@ netlify addons

| Subcommand | description |
|:--------------------------- |:-----|
| [`addons:auth`](/commands/addons#addonsauth) | Login to add-on provider |
| [`addons:config`](/commands/addons#addonsconfig) | Configure add-on settings |
| [`addons:create`](/commands/addons#addonscreate) | Add an add-on extension to your site |
| [`addons:delete`](/commands/addons#addonsdelete) | Remove an add-on extension to your site |
| [`addons:list`](/commands/addons#addonslist) | List currently installed add-ons for site |
| [`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**
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ netlify dev

| Subcommand | description |
|:--------------------------- |:-----|
| [`dev:exec`](/commands/dev#devexec) | Exec command |
| [`dev:exec`](/docs/commands/dev.md#devexec) | Exec command |


**Examples**
Expand Down
6 changes: 3 additions & 3 deletions docs/commands/functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ netlify functions

| Subcommand | description |
|:--------------------------- |:-----|
| [`functions:build`](/commands/functions.md#functionsbuild) | Build functions locally |
| [`functions:create`](/commands/functions.md#functionscreate) | Create a new function locally |
| [`functions:invoke`](/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 |
| [`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**
Expand Down
58 changes: 29 additions & 29 deletions docs/commands/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,98 +20,98 @@ netlify [command] help
## Commands

<!-- AUTO-GENERATED-CONTENT:START (GENERATE_COMMANDS_LIST) -->
### [addons](/commands/addons)
### [addons](/docs/commands/addons.md)

(Beta) Manage Netlify Add-ons

| Subcommand | description |
|:--------------------------- |:-----|
| [`addons:auth`](/commands/addons#addonsauth) | Login to add-on provider |
| [`addons:config`](/commands/addons#addonsconfig) | Configure add-on settings |
| [`addons:create`](/commands/addons#addonscreate) | Add an add-on extension to your site |
| [`addons:delete`](/commands/addons#addonsdelete) | Remove an add-on extension to your site |
| [`addons:list`](/commands/addons#addonslist) | List currently installed add-ons for site |
| [`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](/commands/api)
### [api](/docs/commands/api.md)

Run any Netlify API method

### [deploy](/commands/deploy)
### [deploy](/docs/commands/deploy.md)

Create a new deploy from the contents of a folder

### [dev](/commands/dev)
### [dev](/docs/commands/dev.md)

Local dev server

| Subcommand | description |
|:--------------------------- |:-----|
| [`dev:exec`](/commands/dev#devexec) | Exec command |
| [`dev:exec`](/docs/commands/dev.md#devexec) | Exec command |


### [functions](/commands/functions)
### [functions](/docs/commands/functions.md)

Manage netlify functions

| Subcommand | description |
|:--------------------------- |:-----|
| [`functions:build`](/commands/functions#functionsbuild) | Build functions locally |
| [`functions:create`](/commands/functions#functionscreate) | Create a new function locally |
| [`functions:invoke`](/commands/functions#functionsinvoke) | Trigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions |
| [`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](/commands/init)
### [init](/docs/commands/init.md)

Configure continuous deployment for a new or existing site

### [link](/commands/link)
### [link](/docs/commands/link.md)

Link a local repo or project folder to an existing site on Netlify

### [login](/commands/login)
### [login](/docs/commands/login.md)

Login to your Netlify account

### [open](/commands/open)
### [open](/docs/commands/open.md)

Open settings for the site linked to the current folder

| Subcommand | description |
|:--------------------------- |:-----|
| [`open:admin`](/commands/open#openadmin) | Opens current site admin UI in Netlify |
| [`open:site`](/commands/open#opensite) | Opens current site url in browser |
| [`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](/commands/sites)
### [sites](/docs/commands/sites.md)

Handle various site operations

| Subcommand | description |
|:--------------------------- |:-----|
| [`sites:create`](/commands/sites#sitescreate) | Create an empty site (advanced) |
| [`sites:delete`](/commands/sites#sitesdelete) | Delete a site |
| [`sites:list`](/commands/sites#siteslist) | List all sites you have access to |
| [`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](/commands/status)
### [status](/docs/commands/status.md)

Print status information

| Subcommand | description |
|:--------------------------- |:-----|
| [`status:hooks`](/commands/status#statushooks) | Print hook information of the linked site |
| [`status:hooks`](/docs/commands/status.md#statushooks) | Print hook information of the linked site |


### [switch](/commands/switch)
### [switch](/docs/commands/switch.md)

Switch your active Netlify account

### [unlink](/commands/unlink)
### [unlink](/docs/commands/unlink.md)

Unlink a local folder from a Netlify site

### [watch](/commands/watch)
### [watch](/docs/commands/watch.md)

Watch for site deploy to finish

Expand Down
6 changes: 3 additions & 3 deletions docs/commands/sites.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ netlify sites

| Subcommand | description |
|:--------------------------- |:-----|
| [`sites:create`](/commands/sites#sitescreate) | Create an empty site (advanced) |
| [`sites:delete`](/commands/sites#sitesdelete) | Delete a site |
| [`sites:list`](/commands/sites#siteslist) | List all sites you have access to |
| [`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**
Expand Down
2 changes: 1 addition & 1 deletion docs/commands/status.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ netlify status

| Subcommand | description |
|:--------------------------- |:-----|
| [`status:hooks`](/commands/status#statushooks) | Print hook information of the linked site |
| [`status:hooks`](/docs/commands/status.md#statushooks) | Print hook information of the linked site |


---
Expand Down

0 comments on commit 3bb6ed1

Please sign in to comment.