Netlify CLI

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 or to report an issue on Netlify Dev, head to the netlify-dev-plugin repo. This is a new release, we appreciate your patience and bug reports!

Table of Contents

• Installation
• Usage
• Documentation
• Commands
  • deploy
  • init
  • link
  • login
  • open
  • sites
  • status
  • unlink
  • watch
  • dev
  • functions
• Contributing
• Development
• License

Installation

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

Usage

Installing the CLI globally provides access to the netlify command.

netlify [command]

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

Documentation

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.

Commands

deploy

Create a new deploy from the contents of a folder

init

Configure continuous deployment for a new or existing site

link

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

login

Login to your Netlify account

open

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 |

sites

Handle various site operations

| Subcommand | description | |:--------------------------- |:-----| | sites:create | Create an empty site (advanced) | | sites:list | List all sites you have access to |

status

Print status information

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

unlink

Unlink a local folder from a Netlify site

watch

Watch for site deploy to finish

dev

Local dev server

| Subcommand | description | |:--------------------------- |:-----| | dev:exec | Exec command |

functions

Manage netlify functions

| Subcommand | description | |:--------------------------- |:-----| | functions:build | build functions locally | | functions:create | create a new function locally |

Contributing

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

Development

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!

License

MIT. See LICENSE for more details.