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.
Welcome to the Netlify CLI! The new 2.0 version (now in beta) was rebuilt from the ground up to help improve the site building experience.
Prerequisites
To install the Netlify CLI, run the following command in your terminal window:
npm install netlify-cli@next -g
After installing the CLI globally, connect the CLI to your Netlify account with the following command:
netlify login
This will open a browser window, asking you to log in with Netlify and grant access to Netlify CLI. This will store your Netlify access token in your home folder, under ~/.netlify/config.json.
netlify [command]
# Run `help` for detailed information about CLI commands
netlify [command] help
Netlify's continuous deployment will automatically deploy new versions of your site when you push commits to your connected Git repository.
To setup continuous deployment with the CLI, run:
netlify init
In order to connect your repository for continuous deployment, Netlify CLI will need access to create a deploy key and a webhook on the github repository. When you run the command above, you'll be prompted to log in to your GitHub account, which will create an account-level access token.
The access token will be stored in your home folder, under .netlify/config.json. Your login password will never be stored. You can revoke the access token at any time from your GitHub account settings.
Linking to a site tells Netlify CLI which site the current directory should deploy to. To do this, run the following command from the base of your project directory:
netlify link
This will add a siteId field to a new file inside your project folder, at .netlify/state.json. To unlink your folder from the site, you can remove this field, or you can run the following command from inside the project folder:
netlify unlink
To create a new Netlify site with the CLI, run the netlify init command in your site folder.
netlify init
Then Choose "Create & configure a new site in Netlify"
Proceed through the prompts to finish configuring your site.
It's also possible to deploy a site manually, without continuous deployment. This method uploads files directly from your local project directory to your site on Netlify.
A common use case for this command is when you're using a separate Continuous Integration (CI) tool, deploying prebuilt files to Netlify at the end of the CI tool tasks.
To do a manual deployment with the CLI run:
netlify deploy
# Optionally pass in the build directory
netlify deploy --dir your-build-directory
# Deploying to production with --prod flag
netlify deploy --dir your-build-directory --prod
This deploy command needs to know which folder to publish, and if your project includes functions, a functions folder to deploy. It will look for this information in three places, in the following order:
By default, all deploys are set to a draft preview URL.
To do a manual deploy to production, use the --prod flag:
# Deploy build folder to production
netlify deploy --prod
# Shorthand -p
netlify deploy -p
Deploying to production will publish the build directory at the live URL of your Netlify site.
Create a new deploy from the contents of a folder
Configure continuous deployment for a new or existing site
Link a local repo or project folder to an existing site on Netlify
Login to your Netlify account
Logout of 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 |
Handle various site operations
| Subcommand | description |
|---|---|
sites:create | Create an empty site (advanced) |
sites:list | List all sites you have access too |
Print status information
| Subcommand | description |
|---|---|
status:hooks | Print hook information of the linked site |
Unlink a local folder from a Netlify site
Watch for site deploy to finish
By default, the CLI collects usage stats from logged in Netlify users. This is to constantly improve the developer experience of the tool and bake in better features.
If you'd like to opt out of sending telemetry data, you can do so with the --telemetry-disable flag
# opt out of telemetry
netlify --telemetry-disable
# turn on telemetry
netlify --telemetry-enable
Or edit the telemetryDisabled property of the ~/.netlify/config.json file in your computers root directory.
$ git clone git@github.com:netlify/cli.git
$ npm install
$ ./bin/run [command]
When developing, you can use watch mode which will automatically run ava tests:
$ npm run watch
FAQs
Netlify command line tool
The npm package netlify-cli receives a total of 104,962 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
The Socket Research Team uncovered a malicious Python package typosquatting the popular 'fabric' SSH library, silently exfiltrating AWS credentials from unsuspecting developers.
Security News
At its inaugural meeting, the JSR Working Group outlined plans for an open governance model and a roadmap to enhance JavaScript package management.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.