Cursor rule

1---
2description:
3globs:
4alwaysApply: false
5---
6# Cloudflare Wrangler CLI Reference Guide
7 
8**Your Task: When interacting with Cloudflare Workers, Pages, or other Cloudflare developer platform resources via the command line, consult this reference guide for the `wrangler` CLI. Use this information to construct appropriate `wrangler` commands based on the user's objectives.**
9 
10*This document is based on `wrangler` CLI help output and provides a comprehensive overview of its commands and structure. For the most specific details on any subcommand or its options, you can also execute `wrangler <command> [subcommand] --help` in a terminal environment if available.* 
11 
12## I. Top-Level Commands
13 
14- `wrangler docs [search...]` — Open Wrangler's command documentation in your browser.
15- `wrangler init [name]` — Initialize a basic Worker project.
16- `wrangler dev [script]` — Start a local development server for your Worker.
17- `wrangler deploy [script]` — Deploy your Worker to Cloudflare.
18- `wrangler deployments` — List and view current and past deployments.
19- `wrangler rollback [version-id]` — Rollback a Worker to a previous deployment version.
20- `wrangler versions` — List, view, upload, and deploy specific Worker versions.
21- `wrangler triggers` — Update deployment triggers [experimental].
22- `wrangler delete [script]` — Delete a Worker from Cloudflare.
23- `wrangler tail [worker]` — Start a real-time log tailing session for a Worker.
24- `wrangler secret` — Manage secrets for a Worker (deprecated for new projects, prefer `.dev.vars` or Secrets Store).
25- `wrangler types [path]` — Generate TypeScript type definitions from your Worker's configuration (`wrangler.toml`).
26 
27## II. Resource Management Commands
28 
29- `wrangler kv` — Manage Workers KV Namespaces (key-value store).
30- `wrangler queues` — Manage Workers Queues (message queues).
31- `wrangler r2` — Manage R2 buckets and objects (object storage).
32- `wrangler d1` — Manage Workers D1 databases (serverless SQL).
33- `wrangler vectorize` — Manage Vectorize indexes (vector embeddings database).
34- `wrangler hyperdrive` — Manage Hyperdrive database accelerators.
35- `wrangler cert` — Manage client mTLS certificates and CA certificate chains [open-beta].
36- `wrangler pages` — Configure and manage Cloudflare Pages projects.
37- `wrangler mtls-certificate` — Manage certificates for mTLS connections between services.
38- `wrangler pubsub` — Manage Pub/Sub brokers for real-time messaging [private beta].
39- `wrangler dispatch-namespace` — Manage dispatch namespaces for Worker-to-Worker communication.
40- `wrangler ai` — Manage AI models and deployments on Workers AI.
41- `wrangler workflows` — Manage Cloudflare Workflows [generally available].
42- `wrangler pipelines` — Manage Cloudflare Pipelines [open-beta].
43- `wrangler login` — Authenticate `wrangler` with your Cloudflare account.
44- `wrangler logout` — Log out from Cloudflare.
45- `wrangler whoami` — Retrieve information about the currently authenticated Cloudflare user.
46- `wrangler secrets-store` — Manage secrets using the centralized Secrets Store [alpha].
47 
48---
49 
50## III. Global Flags (Applicable to most commands)
51 
52- `-c, --config <file>` — Path to a custom `wrangler.toml` configuration file.
53- `--cwd <dir>` — Run `wrangler` as if it were started in the specified directory.
54- `-e, --env <env>` — Specify an environment to use (defined in `wrangler.toml`). Affects operations and selection of `.env`/`.dev.vars` files.
55- `-h, --help` — Show help information for the command or subcommand.
56- `-v, --version` — Show `wrangler` CLI version number.
57 
58---
59 
60## IV. Example Subcommand Structures (Illustrative)
61 
62This section shows the hierarchical structure of some common resource management commands. Use `wrangler <command> <subcommand> --help` for full options at each level.
63 
64### `wrangler kv` (Workers KV)
65- `wrangler kv:namespace create <NAMESPACE_NAME>`
66- `wrangler kv:namespace list`
67- `wrangler kv:namespace delete --namespace-id <ID>`
68- `wrangler kv:key put <KEY> [VALUE] --namespace-id <ID> [--path --preview]`
69- `wrangler kv:key list --namespace-id <ID>`
70- `wrangler kv:key get <KEY> --namespace-id <ID>`
71- `wrangler kv:key delete <KEY> --namespace-id <ID>`
72- `wrangler kv:bulk put <FILENAME.JSON> --namespace-id <ID>` (File format: `[{"key":"foo", "value":"bar"},...]`)
73- `wrangler kv:bulk delete <FILENAME.JSON> --namespace-id <ID>` (File format: `["foo", "bar", ...]`)
74 
75### `wrangler queues` (Workers Queues)
76- `wrangler queues list`
77- `wrangler queues create <QUEUE_NAME>`
78- `wrangler queues update <QUEUE_NAME> [--consumer <WORKER_NAME> --consumer-batch-size <SIZE> ...]`
79- `wrangler queues delete <QUEUE_NAME>`
80- `wrangler queues info <QUEUE_NAME>`
81- `wrangler queues consumer add <QUEUE_NAME> <WORKER_NAME> [--batch-size <SIZE> ...]`
82- `wrangler queues consumer remove <QUEUE_NAME> <WORKER_NAME>`
83- `wrangler queues purge <QUEUE_NAME>`
84 
85### `wrangler r2` (R2 Object Storage)
86- `wrangler r2 object get <BUCKET_NAME>/<OBJECT_KEY> [--file <OUTPUT_FILE>]`
87- `wrangler r2 object put <BUCKET_NAME>/<OBJECT_KEY> --file <SOURCE_FILE> [--content-type <MIME>]`
88- `wrangler r2 object delete <BUCKET_NAME>/<OBJECT_KEY>`
89- `wrangler r2 bucket create <BUCKET_NAME>`
90- `wrangler r2 bucket list`
91- `wrangler r2 bucket info <BUCKET_NAME>`
92- `wrangler r2 bucket delete <BUCKET_NAME>`
93 
94### `wrangler d1` (D1 Serverless SQL)
95- `wrangler d1 list`
96- `wr wrangler d1 info <DATABASE_NAME>`
97- `wrangler d1 create <DATABASE_NAME>`
98- `wrangler d1 delete <DATABASE_NAME>`
99- `wrangler d1 execute <DATABASE_NAME> --command "SELECT * FROM users;"`
100- `wrangler d1 execute <DATABASE_NAME> --file ./migrations/0001_init.sql`
101- `wrangler d1 backup list <DATABASE_NAME>`
102- `wrangler d1 backup create <DATABASE_NAME>`
103- `wrangler d1 backup restore <DATABASE_NAME> <BACKUP_ID>`
104- `wrangler d1 migrations list <DATABASE_NAME>`
105- `wrangler d1 migrations apply <DATABASE_NAME>`
106 
107### `wrangler vectorize` (Vectorize Database)
108- `wrangler vectorize create <INDEX_NAME> --dimensions <NUMBER> --metric <METRIC_TYPE>`
109- `wrangler vectorize delete <INDEX_NAME>`
110- `wrangler vectorize get <INDEX_NAME>`
111- `wrangler vectorize list`
112- `wrangler vectorize query <INDEX_NAME> --vector "[0.1, 0.2, ...]" [--top-k <NUMBER>]`
113- `wrangler vectorize insert <INDEX_NAME> --file <VECTORS_FILE.JSON>` (File: `[{"id":"vec1", "values":[...], "metadata":{...}}, ...]`) 
114 
115*(Other subcommand trees like `hyperdrive`, `pages`, `ai`, etc., follow similar patterns. Consult `wrangler <command> --help` for specifics.)*
116 
117---
118 
119**REMEMBER: This guide is your primary reference for `wrangler` CLI commands, their structure, and common resource management tasks. Use it to accurately construct commands to interact with the Cloudflare developer platform. For detailed options on any specific command, the `--help` flag is your best friend (e.g., `wrangler r2 bucket create --help`).**
120