@robinpath/cloudflare
v0.1.1
Published
> Cloudflare module for RobinPath.
Downloads
184
Keywords
Readme
@robinpath/cloudflare
Cloudflare module for RobinPath.
Why use this module?
The cloudflare module lets you:
- List Cloudflare zones
- Get details of a specific zone
- Create a new Cloudflare zone
- Delete a Cloudflare zone
- Purge cache for a zone (all or selective by URLs/tags/hosts/prefixes)
All functions are callable directly from RobinPath scripts with a simple, consistent API.
Installation
npm install @robinpath/cloudflareQuick Start
1. Set up credentials
cloudflare.setCredentials "[email protected]" "your-global-api-key"2. List Cloudflare zones
cloudflare.listZones {"name": "example.com"}Available Functions
| Function | Description |
|----------|-------------|
| cloudflare.setToken | Set Cloudflare API token for authentication |
| cloudflare.setCredentials | Set Cloudflare global API key credentials |
| cloudflare.listZones | List Cloudflare zones |
| cloudflare.getZone | Get details of a specific zone |
| cloudflare.createZone | Create a new Cloudflare zone |
| cloudflare.deleteZone | Delete a Cloudflare zone |
| cloudflare.purgeCache | Purge cache for a zone (all or selective by URLs/tags/hosts/prefixes) |
| cloudflare.listDnsRecords | List DNS records for a zone |
| cloudflare.getDnsRecord | Get a specific DNS record |
| cloudflare.createDnsRecord | Create a DNS record in a zone |
| cloudflare.updateDnsRecord | Update an existing DNS record |
| cloudflare.deleteDnsRecord | Delete a DNS record from a zone |
| cloudflare.listWorkers | List Workers scripts for an account |
| cloudflare.getWorkerScript | Get the content of a Worker script |
| cloudflare.deployWorker | Deploy a Worker script |
| cloudflare.deleteWorker | Delete a Worker script |
| cloudflare.listKvNamespaces | List KV namespaces for an account |
| cloudflare.createKvNamespace | Create a KV namespace |
| cloudflare.deleteKvNamespace | Delete a KV namespace |
| cloudflare.kvGet | Read a value from KV storage |
| cloudflare.kvPut | Write a value to KV storage |
| cloudflare.kvDelete | Delete a key from KV storage |
| cloudflare.kvListKeys | List keys in a KV namespace |
| cloudflare.listR2Buckets | List R2 buckets for an account |
| cloudflare.createR2Bucket | Create an R2 bucket |
| cloudflare.deleteR2Bucket | Delete an R2 bucket |
| cloudflare.listPages | List Cloudflare Pages projects |
| cloudflare.getPageProject | Get details of a Cloudflare Pages project |
| cloudflare.getZoneAnalytics | Get analytics data for a zone |
Examples
List Cloudflare zones
cloudflare.listZones {"name": "example.com"}Get details of a specific zone
cloudflare.getZone "zone-id-here"Create a new Cloudflare zone
cloudflare.createZone "example.com" {"accountId": "abc123"}Integration with RobinPath
import { RobinPath } from "@wiredwp/robinpath";
import Module from "@robinpath/cloudflare";
const rp = new RobinPath();
rp.registerModule(Module.name, Module.functions);
rp.registerModuleMeta(Module.name, Module.functionMetadata);
const result = await rp.executeScript(`
cloudflare.setCredentials "[email protected]" "your-global-api-key"
cloudflare.listZones {"name": "example.com"}
`);Full API Reference
See MODULE.md for complete documentation including all parameters, return types, error handling, and advanced examples.
Related Modules
@robinpath/docker— Docker module for complementary functionality@robinpath/git— Git module for complementary functionality@robinpath/github— GitHub module for complementary functionality@robinpath/gitlab— GitLab module for complementary functionality@robinpath/vercel— Vercel module for complementary functionality
License
MIT
