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.
Pluggable CLI for Netlify. 🎉
$ npm install -g netlify-cli
$ netlify-cli COMMAND
running command...
$ netlify-cli (-v|--version|version)
netlify-cli/2.0.0-alpha.4 darwin-x64 node-v10.8.0
$ netlify-cli --help [COMMAND]
USAGE
$ netlify-cli COMMAND
...
You can also access the cli from the following aliases:
netlifyntlnetlify-cli addonsnetlify-cli addons:create NAMEnetlify-cli addons:delete NAMEnetlify-cli addons:listnetlify-cli addons:update NAMEnetlify-cli deploy [PUBLISHFOLDER]netlify-cli initnetlify-cli linknetlify-cli loginnetlify-cli logoutnetlify-cli sitesnetlify-cli sites:createnetlify-cli sites:delete SITEIDnetlify-cli sites:listnetlify-cli sites:updatenetlify-cli sites:watchnetlify-cli statusnetlify-cli unlinknetlify-cli addons[36mHandle addon operations[39m
USAGE
$ netlify-cli addons
DESCRIPTION
The addons command will help you manage all your netlify addons
EXAMPLES
$ netlify addons:create addon-xyz --value foo
$ netlify addons:update addon-xyz --value bar
$ netlify addons:delete addon-xyz
$ netlify addons:list
See code: src/commands/addons/index.js
netlify-cli addons:create NAMEAdd an addon extension to your site
USAGE
$ netlify-cli addons:create NAME
ARGUMENTS
NAME addon namespace
DESCRIPTION
...
Addons are a way to extend the functionality of your Netlify site
See code: src/commands/addons/create/index.js
netlify-cli addons:delete NAMERemove an addon extension to your site
USAGE
$ netlify-cli addons:delete NAME
ARGUMENTS
NAME addon namespace
DESCRIPTION
...
Addons are a way to extend the functionality of your Netlify site
See code: src/commands/addons/delete/index.js
netlify-cli addons:listlist current site addons
USAGE
$ netlify-cli addons:list
OPTIONS
--json
DESCRIPTION
...
Addons are a way to extend the functionality of your Netlify site
See code: src/commands/addons/list/index.js
netlify-cli addons:update NAMEUpdate an addon extension
USAGE
$ netlify-cli addons:update NAME
ARGUMENTS
NAME addon namespace
DESCRIPTION
...
Addons are a way to extend the functionality of your Netlify site
See code: src/commands/addons/update/index.js
netlify-cli deploy [PUBLISHFOLDER][36mCreate a new deploy from the contents of a folder.[39m
USAGE
$ netlify-cli deploy [PUBLISHFOLDER]
ARGUMENTS
PUBLISHFOLDER folder to deploy (optional)
OPTIONS
--functions=functions
See code: src/commands/deploy/index.js
netlify-cli init[36mConfigure continuous deployment[39m
USAGE
$ netlify-cli init
OPTIONS
--force
--manual
See code: src/commands/init.js
netlify-cli link[36mLink a local repo or project folder to an existing site on Netlify[39m
USAGE
$ netlify-cli link
OPTIONS
--force
--id=id
--name=name
EXAMPLES
$ netlify init --id 123-123-123-123
$ netlify init --name my-site-name
See code: src/commands/link/index.js
netlify-cli login[36mLogin to account[39m
USAGE
$ netlify-cli login
See code: src/commands/login/index.js
netlify-cli logout[36mLogout of account[39m
USAGE
$ netlify-cli logout
See code: src/commands/logout/index.js
netlify-cli sites[36mHandle site operations[39m
USAGE
$ netlify-cli sites
DESCRIPTION
The sites command will help you manage all your sites
EXAMPLES
$ netlify sites:create --name my-new-site
$ netlify sites:update --name my-new-site
$ netlify sites:delete --name my-new-site
$ netlify sites:list
See code: src/commands/sites/index.js
netlify-cli sites:createcreate a site
USAGE
$ netlify-cli sites:create
OPTIONS
-a, --account-slug=account-slug account slug to create the site under
-c, --custom-domain=custom-domain custom domain to use with the site
-i, --session-id=session-id session ID for later site transfers
-n, --name=name name of site
-p, --password=password password protect the site
-s, --force-tls force TLS connections
DESCRIPTION
...
Create an empty site
See code: src/commands/sites/create/index.js
netlify-cli sites:delete SITEIDdelete a site
USAGE
$ netlify-cli sites:delete SITEID
ARGUMENTS
SITEID Site ID to delete
OPTIONS
-n, --name=name name to print
DESCRIPTION
...
Extra documentation goes here
EXAMPLE
$ netlify site:delete 123-432621211
See code: src/commands/sites/delete/index.js
netlify-cli sites:listlist sites
USAGE
$ netlify-cli sites:list
DESCRIPTION
...
Extra documentation goes here
See code: src/commands/sites/list/index.js
netlify-cli sites:updateupdate a site
USAGE
$ netlify-cli sites:update
OPTIONS
-n, --name=name name to print
DESCRIPTION
...
Extra documentation goes here
See code: src/commands/sites/update/index.js
netlify-cli sites:watchWatch for site deploy to finish
USAGE
$ netlify-cli sites:watch
DESCRIPTION
...
Extra documentation goes here
See code: src/commands/sites/watch/index.js
netlify-cli status[36mPrint currently logged in use[39m
USAGE
$ netlify-cli status
See code: src/commands/status/index.js
netlify-cli unlink[36mUnlink a local repo from a Netlify site[39m
USAGE
$ netlify-cli unlink
See code: src/commands/unlink/index.js
This CLI supercedes our old Go CLI and old Node CLI.
Go CLI commands
via https://github.com/netlify/netlifyctl
Available Commands:
assets # List assets attached to a site
├── add # Add an asset to a site
└── info # Show information for an asset or a group of them
deploy # Deploy your site
form # List forms
└── submissions # list form submissions
help # Help about any command
init # Configure continuous deployment
login # Log user in
site # Handle site operations
├── create # create site
└── update # Update site settings
version
Node CLI Commands
via https://github.com/netlify/netlify-cli
createSite = require("../lib/commands/create_site"),
deleteSite = require("../lib/commands/delete_site"),
deploy = require("../lib/commands/deploy"),
publish = require("../lib/commands/publish"),
init = require("../lib/commands/init"),
list = require("../lib/commands/list_sites"),
updateSite = require("../lib/commands/update_site"),
openSite = require("../lib/commands/open"),
env = require("../lib/commands/env"),
Misc examples
$ git clone git@github.com:netlify/cli.git
$ npm install
$ ./bin/run [command]
When developing, you can use watch mode which will automatically rebuild the cli and run tests with ava:
$ 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.