version: "1.0.2" name: zeabur-server-rent description: Use when renting a new dedicated server. Use when user wants to buy or provision a server. Use when the user wants a rented server to run ZeaburOS so it can host Zeabur projects. Supports discounted VPS from Linode, DigitalOcean, Hetzner, AWS Lightsail, GCP, Tencent Cloud (騰訊雲), Alibaba Cloud (阿里雲), and Volcano Engine (火山引擎).

Zeabur Server Rent

Always use `npx zeabur@latest` to invoke Zeabur CLI. Never use zeabur directly or any other installation method. If npx is not available, install Node.js first.

Renting provisions the base OS — ZeaburOS is a second step

server rent gives you Ubuntu and SSH, nothing else. Zeabur services are not installed, so a freshly rented server cannot host Zeabur projects yet.

That is intentional, not a failure. The machine is the user's to do as they please: docker compose, 1Panel, 寶塔, or anything else. ZeaburOS — Zeabur's managed environment, built on k3s — is installed afterwards, as a separate step this skill also covers.

Ask which OS the user wants — before renting

There are two outcomes, and they are not interchangeable. Ask explicitly; do not infer from context and do not pick a default:

Phrase it as a question, e.g.:

Do you want this server set up as ZeaburOS (so you can deploy Zeabur projects on it), or left as a plain Ubuntu VPS you manage yourself?

"They said they want to deploy an app" is not an answer to this question — plenty of users deploy with docker compose on their own box. Ask anyway.

⚠️ Renting charges real money — explicit confirmation is REQUIRED

server rent immediately charges the user's payment method (or Zeabur balance). The -y flag skips the CLI's own confirmation prompt, so you are the last line of defense: never run server rent until the user has explicitly confirmed the exact priced option.

Before renting, you MUST present all of the following to the user in one message:

• Provider (e.g. DigitalOcean)
• Region (e.g. New York / nyc3)
• Plan/spec (e.g. s-2vcpu-4gb — 2 vCPU / 4 GB RAM)
• Monthly price (e.g. US$27/month)
• Which OS they chose (from the step above)
• That the charge happens immediately upon rental

Then ask a direct yes/no question, for example:

You are about to rent DigitalOcean New York s-2vcpu-4gb for US$27/month, set up as ZeaburOS. This will charge your payment method now. Confirm purchase?

Only proceed after the user clearly and affirmatively confirms this specific priced option.

Never infer purchase consent from an ambiguous reply — a bare number like "2", an "ok", or a selection the user made before seeing concrete prices does NOT count. A numeric reply is only valid consent if it maps to a numbered option the user already saw with provider, region, spec, and price spelled out. When in doubt, re-confirm instead of renting.

Workflow

1. Browse available options (use the zeabur-server-catalog skill for filtering)

npx zeabur@latest server catalog -i=false

2. Pick provider, region, plan from the JSON output

3. Ask which OS the user wants

See the section above. This determines whether step 6 runs.

4. Present the exact option and get the user's explicit confirmation

Provider, region, spec, monthly price, OS, immediate charge. Do not skip this step even if the user previously asked you to rent a server in general terms.

5. Rent (only after confirmation)

npx zeabur@latest server rent --provider hetzner --region fsn1 --plan CAX11 -y -i=false

Provisioning takes a few minutes. Poll until the machine is up:

npx zeabur@latest server get <server-id> -i=false

Wait for provisioningStatus to become READY and VM STATUS to become RUNNING.

6. If the user chose ZeaburOS: install Zeabur services

Follow "Install ZeaburOS on a server" below. If they chose Ubuntu, you are done — see "Using a plain Ubuntu VPS".

Install ZeaburOS on a server

Only on a machine that is still blank — one just rented, one just reinstalled back to base OS, or a WonderMesh device that stopped at joining the mesh. This installs k3s on top of the running system without wiping it: safe on an empty machine, unpredictable on one that is already in use.

Do not run this on a machine the user has set up. k3s claims ports (6443, the NodePort range, NATS on 4222), rewrites iptables rules, and brings its own container runtime alongside any Docker already there. On a box running docker compose, 1Panel, 寶塔 or similar, whether the install succeeds depends on what is already installed — and it can break what is running.

For those machines, send the user to the dashboard instead: the server's Settings → Danger Zone → Reinstall OS, choosing ZeaburOS. Reinstalling makes the result predictable, and it erases the disk. Say that plainly and tell them to back up first — it is their call to make, not yours.

Switching is destructive in both directions. ZeaburOS → standard distribution and standard distribution → ZeaburOS are both a reinstall, and both wipe the machine.

If the machine is blank, run this.

Not in the Zeabur CLI yet — call the Zeabur GraphQL API directly at https://api.zeabur.com/graphql.

Run this

One block: authenticate, start the install, wait for it. Substitute the server ID and run it as-is — every part of it is load-bearing, and the notes below say why.

SERVER_ID="<server-id>"
 
command -v jq >/dev/null 2>&1 || { echo "jq is required to read the API responses" >&2; exit 1; }
 
# Keep the token out of the process list: write it into a 0600 curl config
# passed with -K, never as -H "Authorization: ..." on the command line.
TOKEN="${ZEABUR_API_KEY:-$(grep '^token:' ~/.config/zeabur/cli.yaml 2>/dev/null | awk '{print $2}')}"
if [ -z "$TOKEN" ]; then
  echo "No Zeabur token found — set ZEABUR_API_KEY or run: npx zeabur@latest auth login" >&2
  exit 1
fi
ZAPI_CFG=$(mktemp)
chmod 600 "$ZAPI_CFG"
trap 'rm -f "$ZAPI_CFG"' EXIT
printf 'header = "Authorization: Bearer %s"\n' "$TOKEN" > "$ZAPI_CFG"
unset TOKEN
 
zapi() {
  curl -sS --max-time 30 -K "$ZAPI_CFG" https://api.zeabur.com/graphql \
    -H "Content-Type: application/json" -d "$1"
}
 
# GraphQL reports failures as HTTP 200 with an `errors` array, so a request that
# "succeeded" can still be a hard failure. Stop on one instead of polling past it.
die_on_error() {
  if printf '%s' "$1" | jq -e 'has("errors")' >/dev/null 2>&1; then
    printf '%s' "$1" | jq -r '.errors[] | "\(.extensions.code // "ERROR"): \(.message)\(if .extensions.description then " — " + .extensions.description else "" end)"' >&2
    exit 1
  fi
}
 
# Start the install. This returns immediately — the work runs in the background.
RESP=$(zapi "{\"query\":\"mutation(\$id: ObjectID!) { installK3s(serverID: \$id) }\",\"variables\":{\"id\":\"$SERVER_ID\"}}")
die_on_error "$RESP"
 
# Wait for it, against a real 15-minute deadline.
DEADLINE=$(( $(date +%s) + 900 ))
while [ "$(date +%s)" -lt "$DEADLINE" ]; do
  sleep 30
  RESP=$(zapi "{\"query\":\"query(\$id: ObjectID!) { server(_id: \$id) { hasK3s provisioningStatus } }\",\"variables\":{\"id\":\"$SERVER_ID\"}}")
  die_on_error "$RESP"
  HAS_K3S=$(printf '%s' "$RESP" | jq -r '.data.server.hasK3s // "unknown"')
  STATUS=$(printf '%s' "$RESP" | jq -r '.data.server.provisioningStatus // "unknown"')
  echo "hasK3s=$HAS_K3S provisioningStatus=$STATUS"
  if [ "$HAS_K3S" = "true" ]; then echo "ZeaburOS is installed"; exit 0; fi
  if [ "$STATUS" = "FAILED" ]; then echo "Install failed: $RESP" >&2; exit 1; fi
done
echo "Still installing after 15 minutes — check the server's page in the dashboard" >&2
exit 2

Why each part is the way it is:

• The mutation returning does not mean the install finished. The work runs in the background — SSH into the machine, install k3s, wait for the node to come up — and takes several minutes. A true response only means it was accepted and started. Never report success off the mutation alone.
• Success is `hasK3s: true`, not `provisioningStatus: "READY"`. The status goes READY → INITIALIZING → READY, so READY is also the state before the install starts. Polling for it reports success the moment you look too early — and it will look right, because the machine really is READY.
• `FAILED` is checked separately, so a broken install ends the wait instead of running out the clock.
• Every response is checked for `errors` first. GraphQL returns failures as HTTP 200 with an errors array and no data, so an unauthorized token, a bad server ID, or any of the precondition failures below would otherwise read as "still installing" and burn the full 15 minutes before reporting nothing useful. extensions.code is the machine-readable code from the table below; extensions.description is the user-facing explanation.
• Parse with `jq`, not by grepping the raw JSON. grep '"hasK3s":true' breaks the moment the response is formatted with a space after the colon, and it fails open — a missed match looks like "still installing". For the same reason the block refuses to start without jq rather than silently mis-parsing.
• The wait is a deadline, not a counter. 30 × sleep 30 runs past 15 minutes once request time is added; comparing against a timestamp means the stated bound is the real one.
• Stop if no token was found. Continuing sends an unauthenticated request, and the resulting 401 reads as "the server is broken" rather than "you are not logged in".
• The `trap` removes the curl config even if a command in between fails. Each tool/Bash invocation is a fresh shell, so keep the whole block together — $ZAPI_CFG does not survive into the next one.

Prefer ZEABUR_API_KEY if it is set; otherwise the token comes from ~/.config/zeabur/cli.yaml, written by npx zeabur@latest auth login (use the zeabur-auth skill if the user is not logged in).

Errors

The mutation fails up front in these cases. Relay the meaning, not the raw GraphQL error:

If the mutation times out at the transport layer, never blind-retry. The install may already be running server-side. Poll the query above first, and only resend the mutation when the server is back in the documented pre-install state — hasK3s: false and provisioningStatus: "READY".

Never auto-retry a `FAILED` install. FAILED is terminal and means the install genuinely broke on the machine; retrying just repeats it. Report the failure and let the user decide.

Payment Errors

If the user has no credit card bound or insufficient balance, the CLI returns:

ERROR  Rent server failed: please bind a credit card or recharge credits first
INFO   Please bind a credit card or top up your balance at: https://zeabur.com/account/billing

Action: Direct the user to https://zeabur.com/account/billing to add a payment method or top up balance, then retry.

Using a plain Ubuntu VPS

Nothing else is needed — SSH in and set the machine up however the user likes (docker compose, 1Panel, 寶塔, …). Use the zeabur-server-ssh skill:

npx zeabur@latest server exec --id <server-id> -- <command>

kubectl does not exist on such a machine, and there are no Zeabur services to manage.

Do not run `zeabur-project-create` against a server that is not running ZeaburOS. It has no Zeabur services, so creating a project on it will fail — install ZeaburOS first.