Files
porkbun-skill/README.md

3.0 KiB

Porkbun DNS Management Skill for OpenClaw

Manage Porkbun DNS records and domains via API v3.

Overview

This skill enables OpenClaw to manage DNS records on Porkbun's DNS service. It includes a CLI tool for reliable, deterministic DNS operations.

Installation

For OpenClaw Users

Installation will be available via clawhub.ai once published. The skill file is porkbun.skill.

Manual Installation

  1. Download porkbun.skill
  2. Install in your OpenClaw skills directory
  3. Configure API credentials (see Setup below)

Setup

1. Get API Keys

Generate API keys at: https://porkbun.com/account/api

2. Configure Credentials

Create ~/.config/porkbun/config.json:

{
  "apiKey": "your-porkbun-api-key",
  "secretApiKey": "your-porkbun-secret-key"
}

Important: These keys are sensitive. Keep them secure and don't commit them to git.

3. Enable API Access

For each domain you want to manage:

  1. Go to Domain Management on Porkbun
  2. Click Details next to the domain
  3. Enable "API Access"

Usage

The skill integrates with OpenClaw and provides automated DNS management. Common operations:

  • Create records: A, AAAA, CNAME, MX, TXT, and more
  • List domains and records
  • Update existing records
  • Delete records
  • Batch operations by type/subdomain

Example conversations:

  • "Create an A record for www.example.com pointing to 1.1.1.1"
  • "Update the MX record for example.com to use Google Workspace"
  • "Delete all TXT records for old.example.com"

Features

  • Full API v3 support: All Porkbun DNS endpoints
  • CLI tool included: Deterministic operations via scripts/porkbun-dns.js
  • Comprehensive documentation: Reference guides for all record types
  • Batch operations: Edit/delete multiple records at once
  • Common patterns: Pre-built workflows for websites, email, dynamic DNS

Documentation

Inside the skill:

  • SKILL.md - Main usage guide
  • references/dns-record-types.md - Complete DNS record reference

Online:

Development

Repository Structure

porkbun/
├── SKILL.md                    # Main skill documentation
├── scripts/
│   └── porkbun-dns.js         # CLI tool
└── references/
    └── dns-record-types.md    # DNS reference

Building the .skill file

cd ~/.openclaw/workspace/skills/public/porkbun
zip -r ../porkbun.skill SKILL.md scripts/ references/

Testing

Test connection:

node scripts/porkbun-dns.js ping

List your domains:

node scripts/porkbun-dns.js list

Contributing

This skill is maintained for the OpenClaw community. For issues or improvements:

  1. Check this repository
  2. Open an issue or pull request

License

Provided as-is for use with OpenClaw.