Skip to content

README.md

Latest commit

 

History

History
74 lines (50 loc) · 4.56 KB

README.md

File metadata and controls

74 lines (50 loc) · 4.56 KB
Raw

Zeabur Toolkit Skills

Agent skills for the Zeabur Toolkit — rent clean VPS machines, manage them, and bind zeabur.app subdomains with HTTPS, all through the Zeabur GraphQL API with plain curl. No CLI, no Zeabur project, no lock-in: the VPS is yours to run however you like.

Works with Claude Code and OpenAI Codex.

Philosophy

The toolkit unbundles the platform: every piece works on its own, and every piece is swappable.

  • Rent a VPS here, run it with anything — k3s, docker compose, 1Panel, bare packages.
  • Bind a zeabur.app subdomain to any public IP — the machine doesn't have to be rented from Zeabur.
  • Get HTTPS from the ZeaburOS ingress-controller (automatic), cert-manager, certbot, or bring your own certificates.

At every fork, skills present Zeabur's recommended way first — then honor whatever the user picks. Recommend, never railroad.

Install

From GitHub (once published):

/plugin marketplace add zeabur/toolkit-skills
/plugin install toolkit@zeabur-toolkit

From a local checkout (for development):

/plugin marketplace add /path/to/toolkit-skills
/plugin install toolkit@zeabur-toolkit

Then create an Access Token (the auth skill walks you through it) and set ZEABUR_API_KEY.

Skills

Skill What it does
auth Get an Access Token from the dashboard, store it safely, verify API access
server-catalog Browse rentable providers / regions / plans with monthly prices (incl. a cheapest-machine sweep)
server-rent Rent a clean Ubuntu VPS (explicit price confirmation, idempotent retry, SSH credentials)
server-manage Status, power on/off, reboot, reinstall (disk-wiping, confirmed)
deploy The router: asks how to run the machine — ZeaburOS (k3s) recommended, vanilla k3s or self-managed if you prefer
build-image Turn a Git repo (public or private, any host) into a container image via Zeabur CI/CD — one-off builds or reusable branch sources
subdomain Claim <label>.zeabur.app, point it at your VPS, wire up HTTPS
kubernetes-workloads kubectl-only workload management on the machine's k3s (deployments, env, resources, replicas)
kubernetes-network Services, Ingress, TLS, internal DNS — kubectl only
kubernetes-storage PVCs, resizing, volume file operations — kubectl only
kubernetes-observability Logs, events, metrics, restart diagnosis — kubectl only

The golden scenario

The end-to-end flow these skills exist for — no Zeabur project is created at any point:

  1. Browse & rent — server-catalog to pick a plan, server-rent to buy it (you confirm the exact price first). A few minutes later you have SSH on a clean Ubuntu box.
  2. Deploy — the deploy skill takes over. If you haven't said how you want to run things, it asks — recommending ZeaburOS (k3s + Zeabur operator), with vanilla upstream k3s as the zero-Zeabur-components alternative. Either way it installs onto the blank machine, pulls the kubeconfig, and runs your image (say, nginx) as a Kubernetes workload via the kubernetes-* skills.
  3. Expose — subdomain claims myapp.zeabur.app and points it at the VPS IP; HTTPS is issued and renewed automatically (built into the ZeaburOS ingress-controller; cert-manager fills that role on vanilla k3s).
  4. Open https://myapp.zeabur.app. Done.

Prefer docker compose, 1Panel, or 寶塔 instead? Just say so (upfront or when asked) — the machine is yours, and deploy follows your choice (with certbot handling HTTPS on that branch).

Coexisting with the zeabur plugin (agent-skills)

Both plugins can be installed side by side — different namespaces, no technical conflict. The zeabur plugin covers the Zeabur PaaS flows (deploying projects, managing services) via the CLI; this plugin covers Toolkit flows (VPS, subdomains) via the GraphQL API. Server-related skills overlap between the two — the toolkit versions are the maintained ones and say so in their descriptions. If your agent picks a CLI-based zeabur-server-* skill for server work, nudge it toward the toolkit ones (or disable the zeabur plugin if you don't deploy Zeabur projects).

Roadmap

  • Build from a local directory (not yet supported by the CI/CD API — Git repositories only for now).
  • Disk attach / traffic-pack queries once the corresponding APIs are finalized.

Releasing

  1. Bump version in plugins/toolkit/.claude-plugin/plugin.json and plugins/toolkit/.codex-plugin/plugin.json (semver).
  2. Push to main — users update with claude plugin update toolkit@zeabur-toolkit.