Netlify CLI


Netlify CLI command reference

To get a list of commands, run

netlify help

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

netlify [command] help

Commands

api

Run any Netlify API method

blobs

Manage objects in Netlify Blobs

Subcommanddescription
blobs:deleteDeletes an object with a given key, if it exists, from a Netlify Blobs store
blobs:getReads an object with a given key from a Netlify Blobs store and, if it exists, prints the content to the terminal or saves it to a file
blobs:listLists objects in a Netlify Blobs store
blobs:setWrites to a Netlify Blobs store an object with the data provided in the command or the contents of a file defined by the 'input' parameter

build

Build on your local machine

completion

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:execRuns a command within the netlify dev environment. For example, with environment variables from any installed add-ons

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:serveServe functions locally

init

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

integration

Manage Netlify Integrations built with the Netlify SDK

Subcommanddescription
integration:deployRegister, build, and deploy a private integration on Netlify

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

login

Login to your Netlify account

logs

Stream logs from your site

Subcommanddescription
logs:deploy(Beta) Stream the logs of deploys currently being built to the console
logs:function(Beta) Stream netlify function logs to the console

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

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

Subcommanddescription
recipes:listList the recipes available to create and modify files in a project

serve

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