browse
netlify/

Netlify CLI

Netlify

Command line interface for deploying, managing, and developing Netlify sites and functions.

Developer PlatformsJSON
01Agent Notes

netlify deploys sites. `netlify deploy` for manual deploys, `netlify dev` for local development, `netlify env` for env vars. Use `--json` for structured output. `ntl` is a short alias for the netlify command.


02Help Output
⬥ Netlify CLI VERSION netlify-cli/24.0.1 darwin-arm64 node-v22.13.1 USAGE $ netlify [COMMAND] COMMANDS $ agents Manage Netlify AI agent tasks $ api Run any Netlify API method $ blobs Manage objects in Netlify Blobs $ build Build on your local machine $ clone Clone a remote repository and link it to an existing project on Netlify $ completion Generate shell completion script $ db Provision a production ready Postgres database with a single command $ deploy Deploy your project to Netlify $ dev Local dev server $ env Control environment variables for the current project $ functions Manage netlify functions $ init Configure continuous deployment for a new or existing project. To create a new project without continuous deployment, use `netlify sites:create` $ link Link a local repo or project folder to an existing project on Netlify $ login Login to your Netlify account $ logs Stream logs from your project $ open Open settings for the project linked to the current folder $ recipes Create and modify files in a project using pre-defined recipes $ serve Build the project for production and serve locally. This does not watch the code for changes, so if you need to rebuild your project then you must exit and run `serve` again. $ sites Handle various project operations $ status Print status information $ switch Switch your active Netlify account $ unlink Unlink a local folder from a Netlify project $ watch Watch for project deploy to finish → For more help with the CLI, visit https://developers.netlify.com/cli → For help with Netlify, visit https://docs.netlify.com → To report a CLI bug, visit https://github.com/netlify/cli/issues

03Authentication
Methods
access-tokenoauth
Env vars
NETLIFY_AUTH_TOKENNETLIFY_SITE_ID
Setupnetlify login

04Install
npm install -g netlify-cli
Download binary →

05Capabilities
Reference
binarynetlify
checknetlify --version
authaccess-token, oauth
formatstext
json flag--json
version24.2.0