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