Quickstart

This walks from a fresh machine to a deployed site. It assumes you have access to a podmaker control plane and at least one connected cloud account.

1. Install the CLI

# Homebrew (macOS / Linux)
brew install podmaker/tap/podmakerctl

# or download a release binary and put it on your PATH
curl -fsSL https://get.podmaker.sh/install.sh | sh

Verify:

podmakerctl --version
pdctl --help        # pdctl is the short alias

See CLI install for all methods and shell completion.

2. Authenticate

pdctl login --url https://panel.podmaker.sh
pdctl whoami

This stores a Sanctum bearer token in ~/.podmaker/credentials.toml and the panel URL in ~/.podmaker/config.toml.

3. Generate a plan

pdctl plan generate

Answer the short interview. The CLI emits a topology plan in three cost archetypes — ECONOMY, BALANCED, PERFORMANCE — as a YAML file you can inspect and edit.

pdctl plan estimate plan.yaml     # monthly cost breakdown
pdctl plan validate plan.yaml     # schema check
pdctl plan inspect  plan.yaml     # detailed analysis

4. Apply it

pdctl plan apply plan.yaml
pdctl plan watch <topology-id>    # live rollout over SSE

5. Deploy a site

Write a deploy manifest and apply it:

site.yml

apiVersion: podmaker.sh/v1alpha
kind: Site
metadata:
  name: hello
targets:
  - server: demo-01
source:
  type: git
  repo: https://github.com/podmaker/hello-static.git
runtime:
  type: static

pdctl validate site.yml
pdctl apply -f site.yml

Your site is live. From here:

• Add a custom domain and SSL.
• Connect a private repository.
• Reference secrets from your vault.