Netlify CLI


Netlify CLI Command List

Welcome to the Netlify CLI! This site provides online access to all help strings in the Netlify CLI. For a more in-depth guide, please see our Getting Started guide on our main docs site.

If you have questions, ideas, or would like to contribute, check out the repository on Github.

Install the CLI

To install the CLI, pop open your terminal and install with npm.

npm install netlify-cli -g

Listing commands

To get a list of commands, run:

netlify help

To get a list of available sub-commands, arguments, and flags, run:

netlify [command] help

Commands

api

Run Netlify API Methods

deploy

Create a new deploy from the contents of a folder

dev

Local dev server

Subcommanddescription
dev:execExec command
dev:execExec command

functions

Manage netlify functions

Subcommanddescription
functions:buildbuild functions locally
functions:createcreate a new function locally
functions:invoketrigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions
functions:buildbuild functions locally
functions:createcreate a new function locally
functions:invoketrigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions

init

Configure continuous deployment for a new or existing site

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

Subcommanddescription
open:adminOpens current site admin UI in Netlify
open:siteOpens current site url in browser

sites

Handle various site operations

Subcommanddescription
sites:createCreate an empty site (advanced)
sites:deleteDelete a site
sites:listList all sites you have access to

status

Print status information

Subcommanddescription
status:hooksPrint hook information of the linked site

Unlink a local folder from a Netlify site

watch

Watch for site deploy to finish