Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/commands/agents.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ netlify agents

**Flags**

- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in

| Subcommand | description |
|:--------------------------- |:-----|
Expand Down Expand Up @@ -91,12 +91,12 @@ netlify agents:list

**Flags**

- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `json` (*boolean*) - output result as JSON
- `project` (*string*) - project ID or name (if not in a linked directory)
- `status` (*string*) - filter by status (new, running, done, error, cancelled)
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in

**Examples**

Expand All @@ -123,11 +123,11 @@ netlify agents:show

**Flags**

- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `json` (*boolean*) - output result as JSON
- `project` (*string*) - project ID or name (if not in a linked directory)
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in

**Examples**

Expand All @@ -153,11 +153,11 @@ netlify agents:stop

**Flags**

- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `json` (*boolean*) - output result as JSON
- `project` (*string*) - project ID or name (if not in a linked directory)
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in

**Examples**

Expand Down
4 changes: 2 additions & 2 deletions docs/commands/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@ netlify api

**Flags**

- `data` (*string*) - Data to use
- `list` (*boolean*) - List out available API methods
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `data` (*string*) - Data to use
- `list` (*boolean*) - List out available API methods

**Examples**

Expand Down
18 changes: 9 additions & 9 deletions docs/commands/blobs.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ netlify blobs

**Flags**

- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in

| Subcommand | description |
|:--------------------------- |:-----|
Expand Down Expand Up @@ -59,10 +59,10 @@ netlify blobs:delete

**Flags**

- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `force` (*boolean*) - Bypasses prompts & Force the command to run.
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `force` (*boolean*) - Bypasses prompts & Force the command to run.

---
## `blobs:get`
Expand All @@ -82,10 +82,10 @@ netlify blobs:get

**Flags**

- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `output` (*string*) - Defines the filesystem path where the blob data should be persisted
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `output` (*string*) - Defines the filesystem path where the blob data should be persisted

---
## `blobs:list`
Expand All @@ -104,12 +104,12 @@ netlify blobs:list

**Flags**

- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `directories` (*boolean*) - Indicates that keys with the '/' character should be treated as directories, returning a list of sub-directories at a given level rather than all the keys inside them
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `json` (*boolean*) - Output list contents as JSON
- `prefix` (*string*) - A string for filtering down the entries; when specified, only the entries whose key starts with that prefix are returned
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in

---
## `blobs:set`
Expand All @@ -130,11 +130,11 @@ netlify blobs:set

**Flags**

- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `force` (*boolean*) - Bypasses prompts & Force the command to run.
- `input` (*string*) - Defines the filesystem path where the blob data should be read from
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in

---

Expand Down
4 changes: 2 additions & 2 deletions docs/commands/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ netlify build

**Flags**

- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `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: value of CONTEXT or ”production”)
- `dry` (*boolean*) - Dry run: show instructions without running them
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `offline` (*boolean*) - Disables any features that require network access

**Examples**
Expand Down
4 changes: 2 additions & 2 deletions docs/commands/clone.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ netlify clone

**Flags**

- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `id` (*string*) - ID of existing Netlify project to link to
- `name` (*string*) - Name of existing Netlify project to link to
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in

**Examples**

Expand Down
2 changes: 1 addition & 1 deletion docs/commands/completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,9 @@ netlify completion:install

**Flags**

- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in

---

Expand Down
8 changes: 4 additions & 4 deletions docs/commands/db.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ netlify db

**Flags**

- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in

| Subcommand | description |
|:--------------------------- |:-----|
Expand Down Expand Up @@ -51,12 +51,12 @@ netlify init
**Flags**

- `assume-no` (*boolean*) - Non-interactive setup. Does not initialize any third-party tools/boilerplate. Ideal for CI environments or AI tools.
- `boilerplate` (*drizzle*) - Type of boilerplate to add to your project.
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `overwrite` (*boolean*) - Overwrites existing files that would be created when setting up boilerplate
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `boilerplate` (*drizzle*) - Type of boilerplate to add to your project.
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `no-boilerplate` (*boolean*) - Don't add any boilerplate to your project.
- `overwrite` (*boolean*) - Overwrites existing files that would be created when setting up boilerplate

**Examples**

Expand Down
4 changes: 2 additions & 2 deletions docs/commands/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,10 @@ netlify dev:exec

**Flags**

- `context` (*string*) - Specify a deploy context for environment variables (”production”, ”deploy-preview”, ”branch-deploy”, ”dev”) or `branch:your-branch` where `your-branch` is the name of a branch (default: dev)
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `context` (*string*) - Specify a deploy context for environment variables (”production”, ”deploy-preview”, ”branch-deploy”, ”dev”) or `branch:your-branch` where `your-branch` is the name of a branch (default: dev)
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in

**Examples**

Expand Down
24 changes: 12 additions & 12 deletions docs/commands/env.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,9 @@ netlify env

**Flags**

- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in

| Subcommand | description |
|:--------------------------- |:-----|
Expand Down Expand Up @@ -56,12 +56,12 @@ netlify env:clone

**Flags**

- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `force` (*boolean*) - Bypasses prompts & Force the command to run.
- `from` (*string*) - Project ID (From)
- `to` (*string*) - Project ID (To)
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in

**Examples**

Expand All @@ -87,11 +87,11 @@ netlify env:get

**Flags**

- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `context` (*string*) - Specify a deploy context for environment variables (”production”, ”deploy-preview”, ”branch-deploy”, ”dev”) or `branch:your-branch` where `your-branch` is the name of a branch
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `json` (*boolean*) - Output environment variables as JSON
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `scope` (*builds | functions | post-processing | runtime | any*) - Specify a scope

**Examples**
Expand Down Expand Up @@ -120,11 +120,11 @@ netlify env:import

**Flags**

- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `json` (*boolean*) - Output environment variables as JSON
- `replace-existing` (*boolean*) - Replace all existing variables instead of merging them with the current ones
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in

---
## `env:list`
Expand All @@ -139,13 +139,13 @@ netlify env:list

**Flags**

- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `context` (*string*) - Specify a deploy context for environment variables (”production”, ”deploy-preview”, ”branch-deploy”, ”dev”) or `branch:your-branch` where `your-branch` is the name of a branch (default: all contexts)
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `json` (*boolean*) - Output environment variables as JSON
- `scope` (*builds | functions | post-processing | runtime | any*) - Specify a scope
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `plain` (*boolean*) - Output environment variables as plaintext
- `scope` (*builds | functions | post-processing | runtime | any*) - Specify a scope

**Examples**

Expand Down Expand Up @@ -214,12 +214,12 @@ netlify env:unset

**Flags**

- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `context` (*string*) - Specify a deploy context for environment variables (”production”, ”deploy-preview”, ”branch-deploy”, ”dev”) or `branch:your-branch` where `your-branch` is the name of a branch (default: all contexts)
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `force` (*boolean*) - Bypasses prompts & Force the command to run.
- `json` (*boolean*) - Output environment variables as JSON
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in

**Examples**

Expand Down
18 changes: 9 additions & 9 deletions docs/commands/functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@ netlify functions

**Flags**

- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in

| Subcommand | description |
|:--------------------------- |:-----|
Expand Down Expand Up @@ -52,11 +52,11 @@ netlify functions:build

**Flags**

- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `functions` (*string*) - Specify a functions directory to build to
- `src` (*string*) - Specify the source directory for the functions
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in

---
## `functions:create`
Expand All @@ -75,13 +75,13 @@ netlify functions:create

**Flags**

- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `language` (*string*) - function language
- `name` (*string*) - function name
- `offline` (*boolean*) - Disables any features that require network access
- `url` (*string*) - pull template from URL
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in

**Examples**

Expand Down Expand Up @@ -149,11 +149,11 @@ netlify functions:list

**Flags**

- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `functions` (*string*) - Specify a functions directory to list
- `json` (*boolean*) - Output function data as JSON
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in

---
## `functions:serve`
Expand All @@ -168,12 +168,12 @@ netlify functions:serve

**Flags**

- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `functions` (*string*) - Specify a functions directory to serve
- `offline` (*boolean*) - Disables any features that require network access
- `port` (*string*) - Specify a port for the functions server
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in

---

Expand Down
4 changes: 2 additions & 2 deletions docs/commands/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ netlify init

**Flags**

- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `force` (*boolean*) - Reinitialize CI hooks if the linked project is already configured to use CI
- `git-remote-name` (*string*) - Name of Git remote to use. e.g. "origin"
- `manual` (*boolean*) - Manually configure a git remote for CI
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in


<!-- AUTO-GENERATED-CONTENT:END -->
4 changes: 2 additions & 2 deletions docs/commands/link.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ netlify link

**Flags**

- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
- `git-remote-name` (*string*) - Name of Git remote to use. e.g. "origin"
- `git-remote-url` (*string*) - URL of the repository (or Github `owner/repo`) to link to
- `id` (*string*) - ID of project to link to
- `name` (*string*) - Name of project to link to
- `debug` (*boolean*) - Print debugging information
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in

**Examples**

Expand Down
Loading
Loading