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

Important: When using the CLI in a CI environment we recommend installing it locally. See more here.

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

addons

(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

api

Run any Netlify API method

build

(Beta) Build on your local machine

deploy

Create a new deploy from the contents of a folder

dev

Local dev server

Subcommand	description
`dev:exec`	Exec command
`dev:trace`	Trace command

env

(Beta) Control environment variables for the current site

Subcommand	description
`env:get`	Get resolved value of specified environment variable (includes netlify.toml)
`env:import`	Import and set environment variables from .env file
`env:list`	Lists resolved environment variables for site (includes netlify.toml)
`env:set`	Set value of environment variable
`env:unset`	Unset an environment variable which removes it from the UI

functions

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
`functions:list`	List functions that exist locally
`functions:serve`	(Beta) Serve functions locally

init

Configure continuous deployment for a new or existing site

link

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

lm

Handle Netlify Large Media operations

Subcommand	description
`lm:info`	Show large media requirements information.
`lm:install`	Configures your computer to use Netlify Large Media.
`lm:setup`	Configures your site to use Netlify Large Media.

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:delete`	Delete a site
`sites:list`	List all sites you have access to

status

Print status information

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

switch

Switch your active Netlify account

unlink

Unlink a local folder from a Netlify site

watch

Watch for site deploy to finish

completion

(Beta) Generate shell completion script

Subcommand	description
`completion:generate:alias`	Generates completion script for alias
`completion:generate`	Generates completion script

Getting Started