netlify-cli
Advanced tools
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.
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=./buildLogin 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 loginCreate 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-siteManage 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.1Invoke 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-functionThe 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.
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.
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.
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.
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).
Installing the CLI globally provides access to the netlify command.
netlify [command]
# Run `help` for detailed information about CLI commands
netlify [command] help
To learn how to log in to Netlify and start deploying sites, visit the documentation on Netlify.
For a full command reference visit cli.netlify.com.
See CONTRIBUTING.md for more info on how to make contributions to this project.
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!
MIT. See LICENSE for more details.
FAQs
Netlify command line tool
The npm package netlify-cli receives a total of 111,587 weekly downloads. As such, netlify-cli popularity was classified as popular.
We found that netlify-cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 21 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.