Introduction
# Cloudflare Skill
Connect to [Cloudflare](https://cloudflare.com) API for DNS management, tunnels, and zone administration.
## Setup
### 1. Get Your API Token 1. Go to [dash.cloudflare.com/profile/api-tokens](https://dash.cloudflare.com/profile/api-tokens) 2. Create a token with required permissions: - **Zone:Read** - List domains - **DNS:Edit** - Manage DNS records - **Account:Cloudflare Tunnel:Edit** - Manage tunnels 3. Copy the token
### 2. Configure ```bash # Option A: Store in file (recommended) echo "YOUR_API_TOKEN" > ~/.cloudflare_token chmod 600 ~/.cloudflare_token
# Option B: Environment variable export CLOUDFLARE_API_TOKEN="YOUR_API_TOKEN" ```
### 3. Test Connection ```bash ./scripts/setup.sh ```
---
## Commands
### Zones (Domains)
```bash ./scripts/zones/list.sh # List all zones ./scripts/zones/list.sh --json # JSON output ./scripts/zones/get.sh example.com # Get zone details ```
### DNS Records
```bash # List records ./scripts/dns/list.sh example.com ./scripts/dns/list.sh example.com --type A ./scripts/dns/list.sh example.com --name api
# Create record ./scripts/dns/create.sh example.com \ --type A \ --name api \ --content 1.2.3.4 \ --proxied
# Create CNAME ./scripts/dns/create.sh example.com \ --type CNAME \ --name www \ --content example.com \ --proxied
# Update record ./scripts/dns/update.sh example.com \ --name api \ --type A \ --content 5.6.7.8
# Delete record ./scripts/dns/delete.sh example.com --name api --type A ```
### Tunnels
```bash # List tunnels ./scripts/tunnels/list.sh
# Create tunnel ./scripts/tunnels/create.sh my-tunnel
# Configure tunnel ingress ./scripts/tunnels/configure.sh my-tunnel \ --hostname app.example.com \ --service http://localhost:3000
# Get run token ./scripts/tunnels/token.sh my-tunnel
# Delete tunnel ./scripts/tunnels/delete.sh my-tunnel ```
---
## Token Permissions
| Feature | Required Permission | |---------|-------------------| | List zones | Zone:Read | | Manage DNS | DNS:Edit | | Manage tunnels | Account:Cloudflare Tunnel:Edit |
Create token at: [dash.cloudflare.com/profile/api-tokens](https://dash.cloudflare.com/profile/api-tokens)
---
## Common Workflows
### Point subdomain to server ```bash ./scripts/dns/create.sh mysite.com --type A --name api --content 1.2.3.4 --proxied ```
### Set up tunnel for local service ```bash # 1. Create tunnel ./scripts/tunnels/create.sh webhook-tunnel
# 2. Configure ingress ./scripts/tunnels/configure.sh webhook-tunnel \ --hostname hook.mysite.com \ --service http://localhost:8080
# 3. Add DNS record TUNNEL_ID=$(./scripts/tunnels/list.sh --name webhook-tunnel --quiet) ./scripts/dns/create.sh mysite.com \ --type CNAME \ --name hook \ --content ${TUNNEL_ID}.cfargotunnel.com \ --proxied
# 4. Run tunnel TOKEN=$(./scripts/tunnels/token.sh webhook-tunnel) cloudflared tunnel run --token $TOKEN ```
---
## Output Formats
| Flag | Description | |------|-------------| | `--json` | Raw JSON from API | | `--table` | Formatted table (default) | | `--quiet` | Minimal output (IDs only) |
---
## Troubleshooting
| Error | Solution | |-------|----------| | "No API token found" | Run setup or set CLOUDFLARE_API_TOKEN | | "401 Unauthorized" | Check token is valid | | "403 Forbidden" | Token missing required permission | | "Zone not found" | Verify domain is in your account |