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

completion

(Beta) Generate shell completion script

Subcommanddescription
completion:installGenerates completion script for your preferred shell

deploy

Create a new deploy from the contents of a folder

dev

Local dev server

Subcommanddescription
dev:execExec command

env

Control environment variables for the current site

Subcommanddescription
env:cloneClone environment variables from one site to another
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

graph

(Deprecated) Control the Netlify Graph functions for the current site

Subcommanddescription
graph:config:writeWrite a .graphqlrc.json file to the current directory for use with local tooling (e.g. the graphql extension for vscode)
graph:editLaunch the browser to edit your local graph functions from Netlify
graph:handlerGenerate a handler for a Graph operation given its name. See graph:operations for a list of operations.
graph:initInitialize all the resources for Netlify Graph
graph:libraryGenerate the Graph function library
graph:operationsList all of the locally available operations
graph:pullPull your remote Netlify Graph schema locally, and process pending Graph edit events

init

Configure continuous deployment for a new or existing site. To create a new site without continuous deployment, use netlify sites:create

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

recipes

(Beta) Create and modify files in a project using pre-defined recipes

Subcommanddescription
recipes:list(Beta) List the recipes available to create and modify files in a project

serve

(Beta) Build the site for production and serve locally. This does not watch the code for changes, so if you need to rebuild your site then you must exit and run serve again.

sites

Handle various site operations

Subcommanddescription
sites:createCreate an empty site (advanced)
sites:create-template(Beta) Create a site from a starter template
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