Code Monkey home page Code Monkey logo

cli's Introduction

Netlify CLI

npm version build status coverage dependencies downloads netlify-status

Welcome to the Netlify CLI! The new 2.0 version was rebuilt from the ground up to help improve the site building experience.

โš ๏ธ If you are looking for docs on Netlify Dev, the netlify-dev-plugin repo was recently merged into this one. See Netlify Dev Docs here.

Table of Contents

Click to expand

Installation

Netlify CLI requires Node.js version 8 or above. To install, run the following command from any directory in your terminal:

npm install netlify-cli -g

Alternatively you may also use Homebrew: brew install netlify-cli (thanks @cglong).

Usage

Installing the CLI globally provides access to the netlify command.

netlify [command]

# Run `help` for detailed information about CLI commands
netlify [command] help

Documentation

To learn how to log in to Netlify and start deploying sites, visit the documentation on Netlify.

For a full command reference, see the list below, or visit cli.netlify.com.

Commands

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

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:delete Delete a site
sites:list List all sites you have access to

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

Local dev server

Subcommand description
dev:exec Exec command

Manage netlify functions

Subcommand description
functions:build build functions locally
functions:create create a new function locally
functions:invoke trigger a function while in netlify dev with simulated data, good for testing function calls including Netlify's Event Triggered Functions

Contributing

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

Development

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!

License

MIT. See LICENSE for more details.

cli's People

Contributors

bcomnes avatar davidwells avatar raeesbhatti avatar biilmann avatar swyxio avatar calavera avatar verythorough avatar sdras avatar jamesgeorge007 avatar sam3d avatar fool avatar mraerino avatar jschatz1 avatar rybit avatar eduardoboucas avatar croaky avatar dlo avatar dmackerman avatar keiko713 avatar kaykayehnn avatar bertday avatar tomdyson avatar xhmikosr avatar thetulga avatar

Watchers

James Cloos 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.