Skip to content

Commit ab4e48e

Browse files
biilmannclaude
andcommitted
docs: regenerate command documentation
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 009d87c commit ab4e48e

File tree

21 files changed

+118
-77
lines changed

21 files changed

+118
-77
lines changed

docs/commands/agents.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ netlify agents
2121

2222
**Flags**
2323

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

2828
| Subcommand | description |
2929
|:--------------------------- |:-----|
@@ -91,12 +91,12 @@ netlify agents:list
9191

9292
**Flags**
9393

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

101101
**Examples**
102102

@@ -123,11 +123,11 @@ netlify agents:show
123123

124124
**Flags**
125125

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

132132
**Examples**
133133

@@ -153,11 +153,11 @@ netlify agents:stop
153153

154154
**Flags**
155155

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

162162
**Examples**
163163

docs/commands/api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,10 @@ netlify api
2424

2525
**Flags**
2626

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

3232
**Examples**
3333

docs/commands/blobs.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ netlify blobs
1818

1919
**Flags**
2020

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

2525
| Subcommand | description |
2626
|:--------------------------- |:-----|
@@ -59,10 +59,10 @@ netlify blobs:delete
5959

6060
**Flags**
6161

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

6767
---
6868
## `blobs:get`
@@ -82,10 +82,10 @@ netlify blobs:get
8282

8383
**Flags**
8484

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

9090
---
9191
## `blobs:list`
@@ -104,12 +104,12 @@ netlify blobs:list
104104

105105
**Flags**
106106

107+
- `debug` (*boolean*) - Print debugging information
108+
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
107109
- `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
108110
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
109111
- `json` (*boolean*) - Output list contents as JSON
110112
- `prefix` (*string*) - A string for filtering down the entries; when specified, only the entries whose key starts with that prefix are returned
111-
- `debug` (*boolean*) - Print debugging information
112-
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
113113

114114
---
115115
## `blobs:set`
@@ -130,11 +130,11 @@ netlify blobs:set
130130

131131
**Flags**
132132

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

139139
---
140140

docs/commands/build.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,11 @@ netlify build
1717

1818
**Flags**
1919

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

2727
**Examples**

docs/commands/clone.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ netlify clone
2828

2929
**Flags**
3030

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

3737
**Examples**
3838

docs/commands/completion.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ netlify completion:install
4646

4747
**Flags**
4848

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

5353
---
5454

docs/commands/db.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ netlify db
1919

2020
**Flags**
2121

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

2626
| Subcommand | description |
2727
|:--------------------------- |:-----|
@@ -51,12 +51,12 @@ netlify init
5151
**Flags**
5252

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

6161
**Examples**
6262

docs/commands/dev.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,10 +78,10 @@ netlify dev:exec
7878

7979
**Flags**
8080

81-
- `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)
82-
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
8381
- `debug` (*boolean*) - Print debugging information
8482
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
83+
- `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)
84+
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
8585

8686
**Examples**
8787

docs/commands/env.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ netlify env
1818

1919
**Flags**
2020

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

2525
| Subcommand | description |
2626
|:--------------------------- |:-----|
@@ -56,12 +56,12 @@ netlify env:clone
5656

5757
**Flags**
5858

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

6666
**Examples**
6767

@@ -87,11 +87,11 @@ netlify env:get
8787

8888
**Flags**
8989

90+
- `debug` (*boolean*) - Print debugging information
91+
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
9092
- `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
9193
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
9294
- `json` (*boolean*) - Output environment variables as JSON
93-
- `debug` (*boolean*) - Print debugging information
94-
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
9595
- `scope` (*builds | functions | post-processing | runtime | any*) - Specify a scope
9696

9797
**Examples**
@@ -120,11 +120,11 @@ netlify env:import
120120

121121
**Flags**
122122

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

129129
---
130130
## `env:list`
@@ -139,13 +139,13 @@ netlify env:list
139139

140140
**Flags**
141141

142+
- `debug` (*boolean*) - Print debugging information
143+
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
142144
- `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)
143145
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
144146
- `json` (*boolean*) - Output environment variables as JSON
145-
- `scope` (*builds | functions | post-processing | runtime | any*) - Specify a scope
146-
- `debug` (*boolean*) - Print debugging information
147-
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
148147
- `plain` (*boolean*) - Output environment variables as plaintext
148+
- `scope` (*builds | functions | post-processing | runtime | any*) - Specify a scope
149149

150150
**Examples**
151151

@@ -214,12 +214,12 @@ netlify env:unset
214214

215215
**Flags**
216216

217+
- `debug` (*boolean*) - Print debugging information
218+
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
217219
- `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)
218220
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
219221
- `force` (*boolean*) - Bypasses prompts & Force the command to run.
220222
- `json` (*boolean*) - Output environment variables as JSON
221-
- `debug` (*boolean*) - Print debugging information
222-
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
223223

224224
**Examples**
225225

docs/commands/functions.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ netlify functions
1919

2020
**Flags**
2121

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

2626
| Subcommand | description |
2727
|:--------------------------- |:-----|
@@ -52,11 +52,11 @@ netlify functions:build
5252

5353
**Flags**
5454

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

6161
---
6262
## `functions:create`
@@ -75,13 +75,13 @@ netlify functions:create
7575

7676
**Flags**
7777

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

8686
**Examples**
8787

@@ -149,11 +149,11 @@ netlify functions:list
149149
150150
**Flags**
151151
152+
- `debug` (*boolean*) - Print debugging information
153+
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
152154
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
153155
- `functions` (*string*) - Specify a functions directory to list
154156
- `json` (*boolean*) - Output function data as JSON
155-
- `debug` (*boolean*) - Print debugging information
156-
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
157157
158158
---
159159
## `functions:serve`
@@ -168,12 +168,12 @@ netlify functions:serve
168168
169169
**Flags**
170170
171+
- `debug` (*boolean*) - Print debugging information
172+
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
171173
- `filter` (*string*) - For monorepos, specify the name of the application to run the command in
172174
- `functions` (*string*) - Specify a functions directory to serve
173175
- `offline` (*boolean*) - Disables any features that require network access
174176
- `port` (*string*) - Specify a port for the functions server
175-
- `debug` (*boolean*) - Print debugging information
176-
- `auth` (*string*) - Netlify auth token - can be used to run this command without logging in
177177
178178
---
179179

0 commit comments

Comments
 (0)