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 site 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 netlify-lambda, 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.auth
(string) - Netlify auth token to deploy withbranch
(string) - Serves the same functionality as —alias. Deprecated and will be removed in future versionsbuild
(boolean) - Run build command before deployingcontext
(string) - Context to use when resolving build configurationdir
(string) - Specify a folder to deployfilter
(string) - For monorepos, specify the name of the application to run the command infunctions
(string) - Specify a functions folder to deployjson
(boolean) - Output deployment data as JSONmessage
(string) - A short message to include in the deploy logopen
(boolean) - Open site after deployprod
(boolean) - Deploy to productionprod-if-unlocked
(boolean) - Deploy to production if unlocked, create a draft otherwisesite
(string) - A site name or ID to deploy toskip-functions-cache
(boolean) - Ignore any functions created as part of a previousbuild
ordeploy
commands, forcing them to be bundled again as part of the deploymenttimeout
(string) - Timeout to wait for deployment to finishtrigger
(boolean) - Trigger a new build of your site on Netlify without uploading local filesdebug
(boolean) - Print debugging information
Examples
netlify deploynetlify deploy --site my-first-sitenetlify deploy --prodnetlify deploy --prod --opennetlify deploy --prod-if-unlockednetlify deploy --message "A message with an $ENV_VAR"netlify deploy --auth $NETLIFY_AUTH_TOKENnetlify deploy --triggernetlify deploy --build --context deploy-preview