Skip to content

Commit d9b365d

Browse files
committed
Added wrangler commands
1 parent c93a478 commit d9b365d

File tree

1 file changed

+80
-0
lines changed

1 file changed

+80
-0
lines changed

src/content/docs/workers/wrangler/commands.mdx

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Wrangler offers a number of commands to manage your Cloudflare Workers.
3030
- [`secret:bulk`](#secretbulk) - Manage multiple secret variables for a Worker.
3131
- [`tail`](#tail) - Start a session to livestream logs from a deployed Worker.
3232
- [`pages`](#pages) - Configure Cloudflare Pages.
33+
- [`pipelines`](#pipelines) - Configure Cloudflare Pipelines.
3334
- [`queues`](#queues) - Configure Workers Queues.
3435
- [`login`](#login) - Authorize Wrangler with your Cloudflare account using OAuth.
3536
- [`logout`](#logout) - Remove Wrangler’s authorization for accessing your account.
@@ -2116,6 +2117,85 @@ wrangler pages secret bulk [<FILENAME>] [OPTIONS]
21162117
21172118
---
21182119
2120+
## `pipelines`
2121+
:::note
2122+
2123+
Pipelines is currently in open beta. Report Pipelines bugs in [GitHub](https://github.com/cloudflare/workers-sdk/issues/new/choose).
2124+
:::
2125+
2126+
Manage your [Pipelines](/pipelines/) configurations.
2127+
2128+
### `create`
2129+
2130+
Create a new pipeline
2131+
2132+
```txt
2133+
wrangler pipelines create <name> --r2 <r2-bucket-name> [OPTIONS]
2134+
```
2135+
2136+
- `name` string required
2137+
- The name of the pipeline to create
2138+
- `--r2` string required
2139+
- The name of the R2 bucket used as the destination to store the data.
2140+
- `--batch-max-mb` number optional
2141+
- The maximum size a batch before data is written, in megabytes. Default 10 MB.
2142+
- `--batch-max-rows` number optional
2143+
- The maximum number of rows in a batch before data is written. Default 10,000.
2144+
- `--batch-max-seconds` number optional
2145+
- The maximum duration of a batch before data is written, in seconds. Default 10 MB.
2146+
- `--batch-max-mb` number optional
2147+
- The maximum size of a batch before data is written, in megabytes. Default 10 MB.
2148+
- `--compression` string optional
2149+
- Type of compression to apply to output files. Choices: "none", "gzip", "deflate"
2150+
- `--filepath` string optional
2151+
- The path to store files in the destination bucket. Defaults to event_date=${date}/hr=${hr}
2152+
- `--filename` string optional
2153+
- The name of the file in the bucket. Must contain "${slug}". File extension is optional. Defaults to ${slug}-${hr}.json
2154+
2155+
### `update`
2156+
2157+
Update an existing pipeline
2158+
2159+
```txt
2160+
wrangler pipelines create <name> [OPTIONS]
2161+
```
2162+
2163+
- `name` string required
2164+
- The name of the pipeline to update
2165+
- `--r2` string optional
2166+
- The name of the R2 bucket used as the destination to store the data.
2167+
- `--batch-max-mb` number optional
2168+
- The maximum size a batch before data is written, in megabytes. Default 10 MB.
2169+
- `--batch-max-rows` number optional
2170+
- The maximum number of rows in a batch before data is written. Default 10,000.
2171+
- `--batch-max-seconds` number optional
2172+
- The maximum duration of a batch before data is written, in seconds. Default 10 MB.
2173+
- `--batch-max-mb` number optional
2174+
- The maximum size of a batch before data is written, in megabytes. Default 10 MB.
2175+
- `--compression` string optional
2176+
- Type of compression to apply to output files. Choices: "none", "gzip", "deflate"
2177+
- `--filepath` string optional
2178+
- The path to store files in the destination bucket. Defaults to event_date=${date}/hr=${hr}
2179+
- `--filename` string optional
2180+
- The name of the file in the bucket. Must contain "${slug}". File extension is optional. Defaults to ${slug}-${hr}.json
2181+
2182+
### `delete`
2183+
2184+
Deletes an existing pipeline
2185+
2186+
```txt
2187+
wrangler pipelines delete <name> [OPTIONS]
2188+
```
2189+
2190+
### `list`
2191+
2192+
Lists all pipelines in your account.
2193+
2194+
```txt
2195+
wrangler pipelines list [OPTIONS]
2196+
```
2197+
2198+
21192199
## `queues`
21202200
21212201
:::note

0 commit comments

Comments
 (0)