Netlify command line tool
Last updated a year ago by pimterry .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @httptoolkit/netlify-cli 
SYNC missed versions from official npm registry.

Netlify CLI

npm version build status coverage dependencies downloads netlify-status

Welcome to the Netlify CLI! The new 2.0 version was rebuilt from the ground up to help improve the site building experience.

⚠️ If you are looking for docs on Netlify Dev, the netlify-dev-plugin repo was recently merged into this one. See Netlify Dev Docs here.

Table of Contents

<summary>Click to expand</summary>


Netlify CLI requires Node.js version 8 or above. To install, run the following command from any directory in your terminal:

npm install netlify-cli -g

Alternatively you may also use Homebrew: brew install netlify-cli (thanks @cglong).


Installing the CLI globally provides access to the netlify command.

netlify [command]

# Run `help` for detailed information about CLI commands
netlify [command] help


To learn how to log in to Netlify and start deploying sites, visit the documentation on Netlify.

For a full command reference, see the list below, or visit cli.netlify.com.



(Beta) Manage Netlify Add-ons

Subcommand description
addons:auth Login to add-on provider
addons:config Configure add-on settings
addons:create Add an add-on extension to your site
addons:delete Remove an add-on extension to your site
addons:list List currently installed add-ons for site


Run any Netlify API method


Create a new deploy from the contents of a folder


Local dev server

Subcommand description
dev:exec Exec command


Manage netlify functions

Subcommand description
functions:build build functions locally
functions:create create a new function locally
functions:invoke trigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions


Configure continuous deployment for a new or existing site


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


Login to your Netlify account


Open settings for the site linked to the current folder

Subcommand description
open:admin Opens current site admin UI in Netlify
open:site Opens current site url in browser


Handle various site operations

Subcommand description
sites:create Create an empty site (advanced)
sites:delete Delete a site
sites:list List all sites you have access to


Print status information

Subcommand description
status:hooks Print hook information of the linked site


Switch your active Netlify account


Unlink a local folder from a Netlify site


Watch for site deploy to finish


See CONTRIBUTING.md for more info on how to make contributions to this project.


You'll need to follow these steps to run Netlify CLI locally:

uninstall any globally installed versions of netlify-cli
clone and install deps for https://github.com/netlify/cli
npm link from inside the cli folder

Now you're both ready to start testing and to contribute to the project!


MIT. See LICENSE for more details.

Current Tags

  • 2.19.1-testable                                ...           latest (a year ago)

1 Versions

  • 2.19.1-testable                                ...           a year ago
Maintainers (1)
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 1
Dependencies (78)
Dev Dependencies (30)
Dependents (0)

Copyright 2014 - 2016 © taobao.org |