Skip to content

Commit

Permalink
Merge branch 'master' into raees/dir-command-config
Browse files Browse the repository at this point in the history
  • Loading branch information
RaeesBhatti committed Jun 4, 2020
2 parents 8b0efd6 + 4285208 commit d814a1a
Show file tree
Hide file tree
Showing 18 changed files with 212 additions and 232 deletions.
92 changes: 43 additions & 49 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -68,18 +68,18 @@ For a full command reference, see the list below, or visit [cli.netlify.com](htt
## 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 |

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

Expand All @@ -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)

Expand All @@ -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)

Expand All @@ -167,7 +162,6 @@ Unlink a local folder from a Netlify site

Watch for site deploy to finish


<!-- AUTO-GENERATED-CONTENT:END -->

## Contributing
Expand Down
62 changes: 28 additions & 34 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,18 +34,18 @@ 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 |

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

Expand All @@ -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)

Expand All @@ -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)

Expand All @@ -133,5 +128,4 @@ Unlink a local folder from a Netlify site

Watch for site deploy to finish


<!-- AUTO-GENERATED-CONTENT:END -->
27 changes: 15 additions & 12 deletions docs/commands/addons.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ For more information on add-ons see our [Netlify partner add-ons docs](https://w
## About

<!-- AUTO-GENERATED-CONTENT:START (GENERATE_COMMANDS_DOCS) -->

(Beta) Manage Netlify Add-ons

**Usage**
Expand All @@ -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**

Expand All @@ -39,6 +39,7 @@ netlify addons:auth addon-xyz
```

---

## `addons:auth`

Login to add-on provider
Expand All @@ -54,6 +55,7 @@ netlify addons:auth
- name - Add-on slug

---

## `addons:config`

Configure add-on settings
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -121,7 +124,7 @@ netlify addons:list

**Flags**

- `json` (*boolean*) - Output add-on data as JSON
- `json` (_boolean_) - Output add-on data as JSON

---

Expand Down
7 changes: 3 additions & 4 deletions docs/commands/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)

<!-- AUTO-GENERATED-CONTENT:START (GENERATE_COMMANDS_DOCS) -->

Run any Netlify API method

For more information on available methods checkout https://open-api.netlify.com/ or run "netlify api --list"


**Usage**

```bash
Expand All @@ -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**

Expand All @@ -34,5 +34,4 @@ netlify api --list
netlify api getSite --data '{ "site_id": "123456"}'
```


<!-- AUTO-GENERATED-CONTENT:END -->
Loading

0 comments on commit d814a1a

Please sign in to comment.