Skip to content

Latest commit

 

History

History
180 lines (108 loc) · 5.8 KB

index.md

File metadata and controls

180 lines (108 loc) · 5.8 KB
title description
Netlify CLI command reference
All Netlify CLI commands

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

Run any Netlify API method

(Beta) Manage objects in Netlify Blobs

Subcommand description
blobs:delete (Beta) Deletes an object with a given key, if it exists, from a Netlify Blobs store
blobs:get (Beta) Reads 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:list (Beta) Lists objects in a Netlify Blobs store
blobs:set (Beta) Writes 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 on your local machine

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

Stream logs from your site

Subcommand description
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 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

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

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

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