Giter VIP home page Giter VIP logo

cli's Introduction

netlify-cli [beta]

npm version build status windows build status coverage dependencies downloads

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

Installation

Prerequisites

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:

Full Command Reference

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

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.

cli's People

Contributors

bcomnes avatar davidwells avatar biilmann avatar swyxio avatar calavera avatar verythorough avatar rybit avatar mraerino avatar fool avatar tomdyson avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.