cli
Netlify Command Line Interface
File Explorer
Download Latest Version (.zip)- codeql-config.yml
- bug_report.yml
- feature_request.yml
- .gitkeep
- benchmark-post.yml
- benchmark.yml
- codeql.yml
- conventional-commit.yml
- e2e-tests.yml
- format.yml
- fossa.yml
- integration-tests.yml
- lint.yml
- pre-release-sha.yml
- pre-release.yml
- release-please.yml
- typecheck.yml
- unit-tests.yml
- vale.yml
- verify-docs.yml
- .kodiak.toml
- CODEOWNERS
- PULL_REQUEST_TEMPLATE.md
- test-matrix.yml
- promises.js
- fs.js
- write-file-atomic.js
- run.js
- agents.md
- api.md
- blobs.md
- build.md
- claim.md
- clone.md
- completion.md
- create.md
- database.md
- deploy.md
- dev.md
- env.md
- functions.md
- init.md
- link.md
- login.md
- logout.md
- logs.md
- open.md
- recipes.md
- serve.md
- sites.md
- status.md
- switch.md
- teams.md
- unlink.md
- watch.md
- index.md
- install.e2e.ts
- utils.js
- .netlify-function-template.mjs
- {{name}}.js
- .netlify-function-template.mjs
- {{name}}.mjs
- .netlify-function-template.mjs
- {{name}}.js
- .netlify-function-template.mjs
- {{name}}.js
- .netlify-function-template.mjs
- package.json
- {{name}}.mjs
- .netlify-function-template.mjs
- {{name}}.js
- .netlify-function-template.mjs
- {{name}}.js
- .netlify-function-template.mjs
- {{name}}.js
- .netlify-function-template.mjs
- {{name}}.js
- .netlify-function-template.mjs
- {{name}}.ts
- .netlify-function-template.mjs
- package-lock.json
- package.json
- {{name}}.mts
- .netlify-function-template.mjs
- package-lock.json
- package.json
- {{name}}.mts
- .netlify-function-template.mjs
- {{name}}.ts
- .netlify-function-template.mjs
- package-lock.json
- package.json
- {{name}}.mts
- .netlify-function-template.mjs
- {{name}}.ts
- .netlify-function-template.mjs
- {{name}}.ts
- .netlify-function-template.mjs
- package.json
- {{name}}.mts
- .netlify-function-template.mjs
- {{name}}.ts
- .netlify-function-template.mjs
- {{name}}.ts
- .netlify-function-template.mjs
- {{name}}.ts
- .netlify-function-template.mjs
- {{name}}.ts
- bash.sh
- fish.sh
- netlifyPackage.js
- path.ps1
- postinstall.js
- zsh.sh
- error-reporting.ts
- telemetry.js
- favicon.svg
- og.png
- fs.js
- generate-command-data.js
- docs.js
- sync.js
- logo-dark.svg
- logo-light.svg
- font-face.css
- mulishvar-italic-latin-nohint.woff2
- mulishvar-latin-nohint.woff2
- pacaembuvar-latin-nohint.woff2
- colors.css
- custom.css
- sizes.css
- transitions.css
- content.config.ts
- astro.config.js
- config.js
- netlify.toml
- package-lock.json
- package.json
- README.md
- tsconfig.json
- agents-create.ts
- agents-list.ts
- agents-show.ts
- agents-stop.ts
- agents.ts
- constants.ts
- index.ts
- types.ts
- utils.ts
- api.ts
- index.ts
- blobs-delete.ts
- blobs-get.ts
- blobs-list.ts
- blobs-set.ts
- blobs.ts
- build.ts
- index.ts
- claim.ts
- index.ts
- clone.ts
- index.ts
- option_values.ts
- completion.ts
- index.ts
- create-action.ts
- create.ts
- index.ts
- api-errors.ts
- applied-migrations.ts
- constants.ts
- db-connection.ts
- init-data.ts
- meta-commands.ts
- migrations-path.ts
- package-json.ts
- packages.ts
- paths.ts
- pg-client-executor.ts
- psql-formatter.ts
- spawn-async.ts
- timestamp.ts
- database.ts
- db-connect.ts
- db-init.ts
- db-migrate.ts
- db-migration-new.ts
- db-migration-pull.ts
- db-migrations-reset.ts
- db-reset.ts
- db-status.ts
- index.ts
- deploy.ts
- index.ts
- option_values.ts
- dev.ts
- index.ts
- programmatic-netlify-dev.ts
- types.d.ts
- dev-exec.ts
- index.ts
- env-clone.ts
- env-get.ts
- env-import.ts
- env-list.ts
- env-set.ts
- env-unset.ts
- env.ts
- index.ts
- utils.ts
- functions-build.ts
- functions-create.ts
- functions-invoke.ts
- functions-list.ts
- functions-serve.ts
- functions.ts
- index.ts
- constants.ts
- index.ts
- init.ts
- index.ts
- link.ts
- option_values.ts
- index.ts
- login-check.ts
- login-request.ts
- login.ts
- index.ts
- logout.ts
- deploy.ts
- edge-functions.ts
- functions.ts
- build.ts
- index.ts
- log-api.ts
- log-levels.ts
- logs.ts
- index.ts
- open-admin.ts
- open-site.ts
- open.ts
- common.ts
- index.ts
- recipes-list.ts
- recipes.ts
- index.ts
- serve.ts
- index.ts
- sites-create.ts
- sites-delete.ts
- sites-list.ts
- sites-search.ts
- sites.ts
- index.ts
- status-hooks.ts
- status.ts
- index.ts
- switch.ts
- index.ts
- teams-list.ts
- teams.ts
- index.ts
- unlink.ts
- index.ts
- watch.ts
- base-command.ts
- index.ts
- main.ts
- types.d.ts
- blobs.ts
- constants.ts
- generate-autocompletion.ts
- get-autocompletion.ts
- index.ts
- script.ts
- bootstrap.ts
- consts.ts
- editor-helper.ts
- get-directories.ts
- headers.ts
- proxy.ts
- registry.ts
- index.ts
- zisi.ts
- constants.ts
- index.ts
- worker.ts
- index.ts
- index.ts
- background.ts
- config.ts
- form-submissions-handler.ts
- local-proxy.ts
- netlify-function.ts
- registry.ts
- scheduled.ts
- server.ts
- synchronous.ts
- utils.ts
- proxy.ts
- account.ts
- api.ts
- build.ts
- exec-fetcher.ts
- extensions.ts
- fs.ts
- geo-location.ts
- http-agent.ts
- log.ts
- path.ts
- settings.ts
- spinner.ts
- string.ts
- wait-port.ts
- context.ts
- index.ts
- index.ts
- index.ts
- settings.ts
- prepare.ts
- copy-template-dir.ts
- constants.ts
- deploy-site.ts
- drop-api.ts
- file.ts
- hash-config.ts
- hash-edge-functions.ts
- hash-files.ts
- hash-fns.ts
- hasher-segments.ts
- process-files.ts
- status-cb.ts
- upload-files.ts
- upload-source-zip.ts
- util.ts
- deploy-env-vars.ts
- index.ts
- constants.ts
- functions.ts
- get-functions.ts
- index.ts
- requires-site-info-with-project.ts
- requires-site-info.ts
- config-github.ts
- config-manual.ts
- config.ts
- plugins.ts
- utils.ts
- blob-delete-prompts.ts
- blob-set-prompt.ts
- confirm-prompt.ts
- env-clone-prompt.ts
- env-set-prompts.ts
- env-unset-prompts.ts
- prompt-messages.ts
- index.ts
- report-error.ts
- request.ts
- telemetry.ts
- utils.ts
- validation.ts
- index.ts
- build-info.ts
- command-error-handler.ts
- command-helpers.ts
- create-deferred.ts
- create-stream-promise.ts
- detect-server-settings.ts
- dev-server-banner.ts
- dev.ts
- dot-env.ts
- execa.ts
- exit-codes.ts
- feature-flags.ts
- framework-server.ts
- frameworks-api.ts
- get-cli-package-json.ts
- get-repo-data.ts
- get-site.ts
- gh-auth.ts
- gitignore.ts
- headers.ts
- live-tunnel.ts
- multimap.ts
- nodejs-compile-cache.ts
- normalize-repo-url.ts
- object-utilities.ts
- open-browser.ts
- parse-raw-flags.ts
- proxy-server.ts
- proxy.ts
- read-repo-url.ts
- redirects.ts
- request-id.ts
- rules-proxy.ts
- run-build.ts
- run-git.ts
- run-program.ts
- scripted-commands.ts
- shell.ts
- sign-redirect.ts
- static-server.ts
- team.ts
- temporary-file.ts
- types.ts
- validation.ts
- zip.ts
- index.ts
- integration-iscA.ts
- integration-iscB.ts
- integration-manifestA.ts
- integration-manifestB.ts
- integration-manifestC.ts
- manifest.json
- context-with-params.ts
- context.ts
- delete-product.js
- echo-env.ts
- manual-cache-context-with-params.ts
- uncaught-exception.ts
- user-iscA.ts
- user-iscB.ts
- user-tomlA.ts
- user-tomlB.ts
- user-tomlC.ts
- ordertest.html
- edge-function.ts
- netlify.toml
- blobs.ts
- ordertest.html
- netlify.toml
- package-lock.json
- package.json
- echo.js
- identity-validate-background.js
- ping.js
- scheduled-isc-body.js
- scheduled-isc.js
- scheduled-v2.mjs
- scheduled.js
- index.js
- package.json
- netlify.toml
- header-exists.js
- header-missing.js
- header-regex.js
- index.html
- netlify.toml
- blobs.js
- brotli.js
- context.js
- custom-path-catchall.js
- custom-path-excluded.js
- custom-path-expression.js
- custom-path-literal.js
- custom-path-root.js
- delete.js
- favicon.js
- log.js
- ping-ts.ts
- ping.js
- shadow-imagecdn.js
- stream.js
- uncaught-exception.js
- static.html
- products.html
- test.png
- v2-to-custom-without-force.html
- v2-to-legacy-without-force.html
- netlify.toml
- package-lock.json
- package.json
- .gitkeep
- _index.html
- list.html
- _redirects
- .gitignore
- config.toml
- netlify.toml
- package-lock.json
- package.json
- test.jpg
- index.html
- netlify.toml
- package.json
- index.ts
- manifest.yaml
- package.json
- .gitignore
- .npmrc
- package.json
- pnpm-lock.yaml
- pnpm-workspace.yaml
- favicon.ico
- globals.css
- layout.js
- page.js
- page.module.css
- next.svg
- test.txt
- .gitignore
- netlify.toml
- next.config.mjs
- package-lock.json
- package.json
- favicon.ico
- globals.css
- layout.js
- page.js
- page.module.css
- next.svg
- vercel.svg
- .gitignore
- jsconfig.json
- next.config.mjs
- package-lock.json
- package.json
- project.json
- project.json
- nx.json
- package.json
- index.html
- index.js
- manifest.yml
- package.json
- netlify.toml
- framework-detection.test.ts.snap
- bundled-function-1.zip
- agents-create.test.ts
- agents-list.test.ts
- agents-show.test.ts
- agents-stop.test.ts
- fixtures.ts
- blobs-delete.test.ts
- blobs-set.test.ts
- blobs.test.ts
- build-program.test.ts
- build.test.ts
- claim.test.ts
- clone.test.ts
- completion-install.test.ts
- create.test.ts
- deploy-anonymous.test.ts
- deploy-api-routes.ts
- deploy-non-interactive.test.ts
- deploy.test.ts
- ai-gateway.test.ts
- dev-forms-and-redirects.test.ts
- dev-miscellaneous.test.ts
- dev.config.test.ts
- dev.exec.test.ts
- dev.geo.test.ts
- dev.programmatic-netlify-dev.test.ts
- dev.test.ts
- dev.zisi.test.ts
- edge-functions.test.ts
- functions.test.ts
- images.test.ts
- redirects.test.ts
- responses.dev.test.ts
- scheduled-functions.test.ts
- serve.test.ts
- v2-api.test.ts
- didyoumean.test.ts.snap
- didyoumean.test.ts
- env.test.ts.snap
- api-routes.ts
- env-clone.test.ts
- env-get.test.ts
- env-list.test.ts
- env-set.test.ts
- env-unset.test.ts
- env.test.ts
- envelope.test.ts.snap
- envelope.test.ts
- error-handling.test.ts
- functions-create.test.ts.snap
- functions-create.test.ts
- functions-invoke.test.ts
- functions-serve.test.ts
- functions-with-args.test.ts
- help.test.ts.snap
- help.test.ts
- init.test.ts
- link.test.ts
- functions.test.ts
- recipes.test.ts.snap
- recipes.test.ts
- sites.test.ts
- status.test.ts.snap
- status.test.ts
- teams.test.ts
- hugo.test.ts
- functions-go.test.ts
- functions-rust.test.ts
- ai-gateway-helpers.ts
- call-cli.ts
- cli-path.ts
- curl.ts
- dev-server.ts
- external-server-cli.ts
- external-server.ts
- fixture.ts
- handle-questions.ts
- inquirer-mock-prompt.ts
- mock-api-vitest.ts
- mock-api.ts
- mock-execa.ts
- mock-program.ts
- pause.ts
- site-builder.ts
- snapshots.ts
- framework-detection.test.ts
- rules-proxy.test.ts
- telemetry.test.ts
- api.test.ts
- api-errors.test.ts
- psql-formatter.test.ts
- db-connect.test.ts
- db-init.test.ts
- db-migrate.test.ts
- db-migration-new.test.ts
- db-migration-pull.test.ts
- db-migrations-reset.test.ts
- db-reset.test.ts
- db-status.test.ts
- login-check.test.ts
- login-request.test.ts
- switch.test.ts
- help-format.test.ts
- generate-autocompletion.test.ts.snap
- generate-autocompletion.test.ts
- get-autocompletion.test.ts
- bootstrap.test.ts
- proxy.test.ts
- registry.test.ts
- watch-ignore.test.ts
- watchers.test.ts
- index.test.ts
- index.test.ts
- netlify-function.test.ts
- registry.test.ts
- scheduled.test.ts
- server.test.ts
- account.test.ts
- exec-fetcher.test.ts
- geo-location.test.ts
- http-agent.test.ts
- context.test.ts
- download-context-files.test.ts
- 4.txt
- _.b
- _d
- 5.txt
- 1.txt
- 2.txt
- 3.txt
- _.a
- _c
- {{foo}}.txt
- copy-template-dir.test.ts
- hash-edge-functions.test.ts
- hash-files.test.ts
- hash-fns.test.ts
- upload-files.test.ts
- upload-source-zip.test.ts
- util.test.ts
- deploy-env-vars.test.ts
- index.test.ts
- get-functions.test.ts
- config-github.test.ts
- config-manual.test.ts
- report-error.test.ts
- validation.test.ts
- command-helpers.test.ts
- dot-env.test.ts
- exit-codes.test.ts
- feature-flags.test.ts
- get-cli-package-json.test.ts
- get-repo-data.test.ts
- gh-auth.test.ts
- headers.test.ts
- live-tunnel.test.ts
- normalize-repo-url.test.ts
- object-utilities.test.ts
- parse-raw-flags.test.ts
- read-repo-url.test.ts
- redirects.test.ts
- rules-proxy.test.ts
- scripted-commands.test.ts
- shell.test.ts
- index.d.ts
- index.d.ts
- index.d.ts
- index.d.ts
- index.d.ts
- index.d.ts
- index.d.ts
- .editorconfig
- .gitattributes
- .gitignore
- .oxfmtrc.json
- .vale.ini
- CHANGELOG.md
- CLAUDE.md
- cli.png
- CODE_OF_CONDUCT.md
- codecov.yml
- commitlint.config.js
- context7.json
- CONTRIBUTING.md
- eslint.config.js
- eslint_temporary_suppressions.js
- layout.html
- LICENSE
- package-lock.json
- package.json
- README.md
- renovate.json5
- tsconfig.base.json
- tsconfig.build.json
- tsconfig.json
- vitest.config.ts
- vitest.e2e.config.ts
π Installation Guide
1. Get the code
git clone https://github.com/netlify/cli
Downloads the entire project code from GitHub to your computer.
cd cli
Moves into the project folder you just downloaded.
2. Node.js
Easy RecommendedPrerequisites
npm install netlify-cli -g
Downloads and installs the libraries listed in package.json.
npm install --save-dev netlify-cli
Downloads and installs the libraries listed in package.json.
npm link from inside the cli folder
Type this command into your terminal and run it.
After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
Pulled directly from this repo's README.
// repository documentation
Was this content helpful?
(0 ratings)