Netlify CLI deploy command

deploy

Create a new deploy from the contents of a folder Deploys from the build settings found in the netlify.toml file, or settings from the API.

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 - override any linked project in the current working directory.

Lambda functions in the function folder can be in the following configurations for deployment:

Built Go binaries:

functions/
└── nameOfGoFunction

Build binaries of your Go language functions into the functions folder as part of your build process.

Single file Node.js functions:

Build dependency bundled Node.js lambda functions with tools like webpack or browserify into the function folder as part of your build process.

functions/
└── nameOfBundledNodeJSFunction.js

Unbundled Node.js functions that have dependencies outside or inside of the functions folder:

You can ship unbundled Node.js functions with the CLI, utilizing top level project dependencies, or a nested package.json. If you use nested dependencies, be sure to populate the nested node_modules as part of your build process before deploying using npm or yarn.

project/
├── functions
│ ├── functionName/
│ │ ├── functionName.js (Note the folder and the function name need to match)
│ │ ├── package.json
│ │ └── node_modules/
│ └── unbundledFunction.js
├── package.json
├── netlify.toml
└── node_modules/

Any mix of these configurations works as well.

Node.js function entry points

Function entry points are determined by the file name and name of the folder they are in:

functions/
├── aFolderlessFunctionEntrypoint.js
└── functionName/
 ├── notTheEntryPoint.js
 └── functionName.js

Support for package.json’s main field, and intrinsic index.js entrypoints are coming soon.

Usage

netlify deploy

Flags

• alias (string) - Specifies the alias for deployment, the string at the beginning of the deploy subdomain. Useful for creating predictable deployment URLs. Avoid setting an alias string to the same value as a deployed branch. alias doesn’t create a branch deploy and can’t be used in conjunction with the branch subdomain feature. Maximum 37 characters.
• context (string) - Specify a deploy context for environment variables read during the build (”production”, ”deploy-preview”, ”branch-deploy”, ”dev”) or branch:your-branch where your-branch is the name of a branch (default: dev)
• dir (string) - Specify a folder to deploy
• filter (string) - For monorepos, specify the name of the application to run the command in
• functions (string) - Specify a functions folder to deploy
• json (boolean) - Output deployment data as JSON
• message (string) - A short message to include in the deploy log
• no-build (boolean) - Do not run build command before deploying. Only use this if you have no need for a build or your project has already been built.
• open (boolean) - Open project after deploy
• prod-if-unlocked (boolean) - Deploy to production if unlocked, create a draft otherwise
• debug (boolean) - Print debugging information
• auth (string) - Netlify auth token - can be used to run this command without logging in
• prod (boolean) - Deploy to production
• site (string) - A project name or ID to deploy to
• skip-functions-cache (boolean) - Ignore any functions created as part of a previous build or deploy commands, forcing them to be bundled again as part of the deployment
• timeout (string) - Timeout to wait for deployment to finish
• trigger (boolean) - Trigger a new build of your project on Netlify without uploading local files

Examples

netlify deploy
netlify deploy --site my-first-project
netlify deploy --no-build # Deploy without running a build first
netlify deploy --prod
netlify deploy --prod --open
netlify deploy --prod-if-unlocked
netlify deploy --message "A message with an $ENV_VAR"
netlify deploy --auth $NETLIFY_AUTH_TOKEN
netlify deploy --trigger
netlify deploy --context deploy-preview