Skip to content

Files

Latest commit

 

History

History
 
 

docs

title description
Netlify CLI Command List
All Netlify CLI commands

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.

Before you begin Make sure you have Node.js version 16.0.0, or later.

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

(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

Run any Netlify API method

(Beta) Build on your local machine

(Beta) Generate shell completion script

Subcommand description
completion:install Generates completion script for your preferred shell

Create a new deploy from the contents of a folder

Local dev server

Subcommand description
dev:exec Exec command

Control environment variables for the current site

Subcommand description
env:clone Clone environment variables from one site to another
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

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

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

Manage Netlify Integrations built with the Netlify SDK

Subcommand description
integration:deploy Register, build, and deploy a private integration on Netlify

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

Login to your Netlify account

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

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

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

(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.

Handle various site operations

Subcommand description
sites:create Create an empty site (advanced)
sites:create-template (Beta) Create a site from a starter template
sites:delete Delete a site
sites:list List all sites you have access to

Print status information

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

Switch your active Netlify account

Unlink a local folder from a Netlify site

Watch for site deploy to finish