1# Cloudflare Wrangler
2 
3Official CLI for Cloudflare Workers - develop, manage, and deploy Workers from the command line.
4 
5## What is Wrangler?
6 
7Wrangler is the Cloudflare Developer Platform CLI that allows you to:
8- Create, develop, and deploy Workers
9- Manage bindings (KV, D1, R2, Durable Objects, etc.)
10- Configure routing and environments
11- Run local development servers
12- Execute migrations and manage resources
13- Perform integration testing
14 
15## Installation
16 
17```bash
18npm install wrangler --save-dev
19# or globally
20npm install -g wrangler
21```
22 
23Run commands: `npx wrangler <command>` (or `pnpm`/`yarn wrangler`)
24 
25## Reading Order
26 
27| If you want to... | Start here |
28|-------------------|------------|
29| Create/deploy Worker quickly | Essential Commands below → [patterns.md](./patterns.md) §New Worker |
30| Configure bindings (KV, D1, R2) | [configuration.md](./configuration.md) §Bindings |
31| Write integration tests | [api.md](./api.md) §startWorker |
32| Debug production issues | [gotchas.md](./gotchas.md) + Essential Commands §Monitoring |
33| Set up multi-environment workflow | [configuration.md](./configuration.md) §Environments |
34 
35## Essential Commands
36 
37### Project & Development
38```bash
39wrangler init [name]              # Create new project
40wrangler dev                      # Local dev server (fast, simulated)
41wrangler dev --remote             # Dev with remote resources (production-like)
42wrangler deploy                   # Deploy to production
43wrangler deploy --env staging     # Deploy to environment
44wrangler versions list            # List versions
45wrangler rollback [id]            # Rollback deployment
46wrangler login                    # OAuth login
47wrangler whoami                   # Check auth status
48```
49 
50## Resource Management
51 
52### KV
53```bash
54wrangler kv namespace create NAME
55wrangler kv key put "key" "value" --namespace-id=<id>
56wrangler kv key get "key" --namespace-id=<id>
57```
58 
59### D1
60```bash
61wrangler d1 create NAME
62wrangler d1 execute NAME --command "SQL"
63wrangler d1 migrations create NAME "description"
64wrangler d1 migrations apply NAME
65```
66 
67### R2
68```bash
69wrangler r2 bucket create NAME
70wrangler r2 object put BUCKET/key --file path
71wrangler r2 object get BUCKET/key
72```
73 
74### Other Resources
75```bash
76wrangler queues create NAME
77wrangler vectorize create NAME --dimensions N --metric cosine
78wrangler hyperdrive create NAME --connection-string "..."
79wrangler workflows create NAME
80wrangler constellation create NAME
81wrangler pages project create NAME
82wrangler pages deployment create --project NAME --branch main
83```
84 
85### Secrets
86```bash
87wrangler secret put NAME          # Set Worker secret
88wrangler secret list              # List Worker secrets
89wrangler secret delete NAME       # Delete Worker secret
90wrangler secret bulk FILE.json    # Bulk upload from JSON
91 
92# Secrets Store (centralized, reusable across Workers)
93wrangler secrets-store secret create <store-id> --name SECRET_NAME --scopes workers --remote
94wrangler secrets-store secret list <store-id> --remote
95```
96 
97### Monitoring
98```bash
99wrangler tail                     # Real-time logs
100wrangler tail --env production    # Tail specific env
101wrangler tail --status error      # Filter by status
102```
103 
104## In This Reference
105 
106- [configuration.md](./configuration.md) - wrangler.jsonc setup, environments, bindings
107- [api.md](./api.md) - Programmatic API (`startWorker`, `getPlatformProxy`, events)
108- [patterns.md](./patterns.md) - Common workflows and development patterns
109- [gotchas.md](./gotchas.md) - Common pitfalls, limits, and troubleshooting
110 
111## Quick Decision Tree
112 
113```
114Need to test your Worker?
115├─ Testing full Worker with bindings → api.md §startWorker
116├─ Testing individual functions → api.md §getPlatformProxy
117└─ Testing with Vitest → patterns.md §Testing with Vitest
118 
119Need to configure something?
120├─ Bindings (KV, D1, R2, etc.) → configuration.md §Bindings
121├─ Multiple environments → configuration.md §Environments
122├─ Static files → configuration.md §Workers Assets
123└─ Routing → configuration.md §Routing
124 
125Development not working?
126├─ Local differs from production → Use `wrangler dev --remote`
127├─ Bindings not available → gotchas.md §Binding Not Available
128└─ Auth issues → wrangler login
129```
130 
131## See Also
132 
133- [workers](../workers/) - Workers runtime API reference
134- [miniflare](../miniflare/) - Local testing with Miniflare
135- [workerd](../workerd/) - Runtime that powers `wrangler dev`
136