1 | # Netlify CLI
|
2 | [![npm version][npm-img]][npm] [![build status][azure-img]][azure] [![coverage][coverage-img]][coverage] [![dependencies][david-img]][david] [![downloads][dl-img]][dl] [![netlify-status][netlify-img]][netlify]
|
3 |
|
4 | Welcome to the Netlify CLI! The new 2.0 version was rebuilt from the ground up to help improve the site building experience.
|
5 |
|
6 | > ⚠️ **If you are looking for docs or to report an issue on [Netlify Dev](https://www.netlify.com/blog/2019/04/09/netlify-dev--our-entire-platform-right-on-your-laptop/), head to the [netlify-dev-plugin repo](https://github.com/netlify/netlify-dev-plugin#what-is-netlify-dev).** This is a new release, we appreciate your patience and bug reports!
|
7 |
|
8 | ## Table of Contents
|
9 |
|
10 |
|
11 | <details>
|
12 | <summary>Click to expand</summary>
|
13 |
|
14 | - [Installation](#installation)
|
15 | - [Usage](#usage)
|
16 | - [Documentation](#documentation)
|
17 | - [Commands](#commands)
|
18 | * [deploy](#deploy)
|
19 | * [init](#init)
|
20 | * [link](#link)
|
21 | * [login](#login)
|
22 | * [open](#open)
|
23 | * [sites](#sites)
|
24 | * [status](#status)
|
25 | * [unlink](#unlink)
|
26 | * [watch](#watch)
|
27 | - [Contributing](#contributing)
|
28 | - [License](#license)
|
29 |
|
30 | </details>
|
31 |
|
32 |
|
33 | ## Installation
|
34 |
|
35 | Netlify CLI requires [Node.js](https://nodejs.org) version 8 or above. To install, run the following command from any directory in your terminal:
|
36 |
|
37 | ```bash
|
38 | npm install netlify-cli -g
|
39 | ```
|
40 |
|
41 | ## Usage
|
42 |
|
43 | Installing the CLI globally provides access to the `netlify` command.
|
44 |
|
45 | ```sh-session
|
46 | netlify [command]
|
47 |
|
48 | # Run `help` for detailed information about CLI commands
|
49 | netlify [command] help
|
50 | ```
|
51 |
|
52 | ## Documentation
|
53 |
|
54 | To learn how to log in to Netlify and start deploying sites, visit the [documentation on Netlify](https://www.netlify.com/docs/cli).
|
55 |
|
56 | For a full command reference, see the list below, or visit [cli.netlify.com](https://cli.netlify.com/).
|
57 |
|
58 | ## Commands
|
59 |
|
60 |
|
61 | ### [deploy](/docs/deploy.md)
|
62 |
|
63 | Create a new deploy from the contents of a folder
|
64 |
|
65 | ### [init](/docs/init.md)
|
66 |
|
67 | Configure continuous deployment for a new or existing site
|
68 |
|
69 | ### [link](/docs/link.md)
|
70 |
|
71 | Link a local repo or project folder to an existing site on Netlify
|
72 |
|
73 | ### [login](/docs/login.md)
|
74 |
|
75 | Login to your Netlify account
|
76 |
|
77 | ### [open](/docs/open.md)
|
78 |
|
79 | Open settings for the site linked to the current folder
|
80 |
|
81 | | Subcommand | description |
|
82 | |:--------------------------- |:-----|
|
83 | | [`open:admin`](/docs/open.md#openadmin) | Opens current site admin UI in Netlify |
|
84 | | [`open:site`](/docs/open.md#opensite) | Opens current site url in browser |
|
85 |
|
86 |
|
87 | ### [sites](/docs/sites.md)
|
88 |
|
89 | Handle various site operations
|
90 |
|
91 | | Subcommand | description |
|
92 | |:--------------------------- |:-----|
|
93 | | [`sites:create`](/docs/sites.md#sitescreate) | Create an empty site (advanced) |
|
94 | | [`sites:list`](/docs/sites.md#siteslist) | List all sites you have access to |
|
95 |
|
96 |
|
97 | ### [status](/docs/status.md)
|
98 |
|
99 | Print status information
|
100 |
|
101 | | Subcommand | description |
|
102 | |:--------------------------- |:-----|
|
103 | | [`status:hooks`](/docs/status.md#statushooks) | Print hook information of the linked site |
|
104 |
|
105 |
|
106 | ### [unlink](/docs/unlink.md)
|
107 |
|
108 | Unlink a local folder from a Netlify site
|
109 |
|
110 | ### [watch](/docs/watch.md)
|
111 |
|
112 | Watch for site deploy to finish
|
113 |
|
114 |
|
115 |
|
116 |
|
117 | ## Contributing
|
118 |
|
119 | See [CONTRIBUTING.md](CONTRIBUTING.md) for more info on how to make contributions to this project.
|
120 |
|
121 | ## License
|
122 |
|
123 | MIT. See [LICENSE](LICENSE) for more details.
|
124 |
|
125 | [npm-img]: https://img.shields.io/npm/v/netlify-cli.svg
|
126 | [npm]: https://npmjs.org/package/netlify-cli
|
127 | [azure-img]: https://dev.azure.com/netlify/Netlify%20CLI/_apis/build/status/netlify.cli?branchName=master
|
128 | [azure]: https://dev.azure.com/netlify/Netlify%20CLI/_build?definitionId=3
|
129 | [travis-img]: https://img.shields.io/travis/netlify/cli/master.svg
|
130 | [travis]: https://travis-ci.org/netlify/cli
|
131 | [av-img]: https://ci.appveyor.com/api/projects/status/imk2qjc34ly7x11b/branch/master?svg=true
|
132 | [av]: https://ci.appveyor.com/project/netlify/cli
|
133 | [dl-img]: https://img.shields.io/npm/dm/netlify-cli.svg
|
134 | [dl]: https://npmjs.org/package/netlify-cli
|
135 | [coverage-img]: https://img.shields.io/coveralls/netlify/cli/master.svg
|
136 | [coverage]: https://coveralls.io/github/netlify/cli
|
137 | [david-img]: https://david-dm.org/netlify/cli/status.svg
|
138 | [david]: https://david-dm.org/netlify/cli
|
139 | [netlify-img]: https://api.netlify.com/api/v1/badges/d3807379-2dcf-4a43-9c00-e7e8d90ecf70/deploy-status
|
140 | [netlify]: https://app.netlify.com/sites/cli/deploys
|