Netlify CLI


Available CLI Commands

To get a list of commands, run

netlify help

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

netlify [command] help

Commands

addons

(Beta) Manage Netlify Add-ons

Subcommanddescription
addons:authLogin to add-on provider
addons:configConfigure add-on settings
addons:createAdd an add-on extension to your site
addons:deleteRemove an add-on extension to your site
addons:listList 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

Subcommanddescription
dev:execExec command
dev:traceTrace command

env

(Beta) Control environment variables for the current site

Subcommanddescription
env:getGet resolved value of specified environment variable (includes netlify.toml)
env:importImport and set environment variables from .env file
env:listLists resolved environment variables for site (includes netlify.toml)
env:setSet value of environment variable
env:unsetUnset an environment variable which removes it from the UI

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

init

Configure continuous deployment for a new or existing site

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

lm

Handle Netlify Large Media operations

Subcommanddescription
lm:infoShow large media requirements information.
lm:installConfigures your computer to use Netlify Large Media.
lm:setupConfigures your site to use Netlify Large Media.

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

switch

Switch your active Netlify account

Unlink a local folder from a Netlify site

watch

Watch for site deploy to finish

completion

(Beta) Generate shell completion script

Subcommanddescription
completion:generate:aliasGenerates completion script for alias
completion:generateGenerates completion script