banks/cli

New Netlify command line tool, now in beta

netlify-cli [beta]

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.

Table of Contents

Click to expand

• Install & Setup
• Usage
• Getting Started
  • Link to an existing site
  • Create a new site
  • Deploying a site
  • Production Deploys
• Full Command Reference
  • deploy
  • init
  • link
  • login
  • logout
  • open
  • sites
  • status
  • unlink
  • watch
  • telemetry
• Local Development

Installation

Prerequisites

• Node.js 8+.
• Netlify User Account

To install the Netlify CLI, run the following command in your terminal:

npm install netlify-cli@next -g

Usage

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

CI and Environment Variables.

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 PRIVATE
• NETLIFY_SITE_ID - force the cli to think the cwd is linked to this site id. This can be made public.

Getting Started + Docs

Please see the getting started guide on our docs website:

• netlify.com/docs/cli

Full Command Reference

deploy

Create a new deploy from the contents of a folder

init

Configure continuous deployment for a new or existing site

link

Link a local repo or project folder to an existing site on Netlify

login

Login to your Netlify account

logout

Logout of your Netlify account

open

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

sites

Handle various site operations

Subcommand	description
sites:create	Create an empty site (advanced)
sites:list	List all sites you have access too

status

Print status information

Subcommand	description
status:hooks	Print hook information of the linked site

unlink

Unlink a local folder from a Netlify site

watch

Watch for site deploy to finish

telemetry

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.

Contributing

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

License

MIT. See LICENSE for more details.