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.
Click to expand
Prerequisites
To install the Netlify CLI, run the following command in your terminal:
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
The following environment variables can be used to override configuration file lookups and prompts:
NETLIFY_AUTH_TOKEN
- an access token to use when authenticating commands. KEEP THIS VALUE PRIVATENETLIFY_SITE_ID
- force the cli to think the cwd is linked to this site id. This can be made public.
Please see the getting started guide on our docs website:
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.
See CONTRIBUTING.md for more info on how to make contributions to this project.
MIT. See LICENSE for more details.