netlify-cli

What is netlify-cli?

The netlify-cli package is a command-line tool that allows you to interact with Netlify services. It provides functionalities for deploying sites, managing DNS, handling functions, and more, directly from your terminal.

What are netlify-cli's main functionalities?

Deploy a site

This command deploys the site located in the './build' directory to Netlify. It is useful for quickly pushing updates to your site.

netlify deploy --dir=./build

Login to Netlify

This command opens a browser window to authenticate your Netlify account. It is the first step to using other Netlify CLI commands that require authentication.

netlify login

Create a new site

This command creates a new site on Netlify with the specified name 'my-new-site'. It is useful for setting up new projects quickly.

netlify sites:create --name=my-new-site

Manage DNS records

This command adds a DNS record to your Netlify-managed domain. It is useful for configuring custom domains and subdomains.

netlify dns:add --name=subdomain --type=A --value=127.0.0.1

Invoke serverless functions

This command invokes a serverless function named 'my-function' deployed on Netlify. It is useful for testing and debugging serverless functions.

netlify functions:invoke my-function

Other packages similar to netlify-cli

vercel

The Vercel CLI is a command-line tool for interacting with Vercel services. It offers similar functionalities to Netlify CLI, such as deploying sites, managing domains, and handling serverless functions. Vercel is known for its seamless integration with Next.js.

firebase-tools

The Firebase CLI provides a set of tools for managing Firebase projects and apps. It includes functionalities for deploying web apps, managing databases, and handling authentication. While it offers broader services compared to Netlify CLI, it is more focused on mobile and web app development.

aws-cli

The AWS CLI is a unified tool to manage AWS services. It provides extensive functionalities for deploying and managing cloud resources, including S3 for static site hosting and Lambda for serverless functions. It is more complex and feature-rich compared to Netlify CLI, catering to a wider range of cloud services.

README

Interact with Netlify from the comfort of your CLI.

See the CLI command line reference to get started and the docs on using Netlify Dev to run your site locally.

Table of Contents

Click to expand

• Installation
• Usage
• Documentation
• Commands
  • api
  • blobs
  • build
  • completion
  • deploy
  • dev
  • env
  • functions
  • init
  • integration
  • link
  • login
  • open
  • recipes
  • serve
  • sites
  • status
  • switch
  • unlink
  • watch
• Contributing
• Development
• License

Installation

Netlify CLI requires Node.js version 18.14.0 or above. To install, run the following command from any directory in your terminal:

npm install netlify-cli -g

When using the CLI in a CI environment we recommend installing it locally as a development dependency, instead of globally. To install locally, run the following command from the root directory of your project:

npm install --save-dev netlify-cli

Important: Running npm install netlify-cli -g in CI means you're always installing the latest version of the CLI, including breaking changes. When you install locally and use a lock file you guarantee reproducible builds. To manage CLI updates we recommend using an automated tool like renovate or dependabot.

Alternatively you may also use Homebrew: brew install netlify-cli (thanks @cglong).

Usage

Installing the CLI globally provides access to the netlify command.

netlify [command]

# Run `help` for detailed information about CLI commands
netlify [command] help

Documentation

To learn how to log in to Netlify and start deploying sites, visit the documentation on Netlify.

Commands

For a full command reference visit cli.netlify.com.

Contributing

See CONTRIBUTING.md for more info on how to make contributions to this project.

Development

You'll need to follow these steps to run Netlify CLI locally:

uninstall any globally installed versions of netlify-cli
clone and install deps for https://github.com/netlify/cli
npm link from inside the cli folder

Now you're both ready to start testing and to contribute to the project!

License

MIT. See LICENSE for more details.

Changelog

17.23.3 (2024-05-13)

Bug Fixes

• deps: update dependency @netlify/edge-functions to v2.6.1 (#6547) (9fb7d77)
• deps: update dependency @netlify/edge-functions to v2.7.0 (#6570) (366b156)
• deps: update dependency @netlify/zip-it-and-ship-it to v9.32.2 (#6560) (2f67773)
• deps: update dependency semver to v7.6.2 (#6577) (6887884)
• deps: update netlify packages (#6565) (b783823)
• framework detection test race condition (#6564) (a79430f)
• respect excludedPattern defined in netlify.toml (#6533) (1729ef0)
• specified dev command should fix the case of multiple detected commands (#6579) (e48529e)