Docs
Getting started. Four steps.
From an empty server to a running app in a few minutes. Everything below works from the canvas UI or the terminal.
Connect a server
Bring a server you already own — AWS, GCP, DigitalOcean, Hetzner, or any VPS — or let ClikDeploy provision one for you. The on-server agent is the primary control path; an SSH key or cloud OAuth is only used to bootstrap it (and to restore it if it ever goes down). Credentials are stored encrypted.
From the canvas, add a server and follow the install step. From a terminal on the server itself:
clikdeploy server connect agent my-server
Or register a remote machine by IP:
clikdeploy server add my-server 203.0.113.10 ~/.ssh/id_ed25519
Deploy anything
Deploy from the marketplace, from any Docker image, or from a GitHub repository — no config files required. Repos are built through the builder pipeline; logs stream live while it happens, and the recovery system steps in automatically when a deploy hits a snag.
# current directory (uses your git remote) clikdeploy deploy # a marketplace app clikdeploy marketplace deploy n8n # any Docker image clikdeploy docker deploy redis:latest my-cache
Check on things with clikdeploy status and clikdeploy logs -f.
Domains & SSL
Every deployed app is routed through a Caddy reverse proxy, and SSL certificates are included on all plans. Point a custom domain at an app from its Inspector in the canvas, or from the CLI:
clikdeploy apps domain my-app myapp.example.com clikdeploy apps ssl my-app
Optionally connect the Cloudflare API for wildcard DNS and SSL management.
The CLI
Everything above is also available from the terminal. The CLI needs Node.js 18+.
# install curl -fsSL https://clikdeploy.com/cli.sh | bash # or with npm (user-local, no sudo) npm install -g --prefix "$HOME/.local" clikdeploy-cli # log in (email/password, or --google / --github) clikdeploy login
Run clikdeploy --help or clikdeploy <command> --help for the full command reference.
Stuck on something? Ask on Discord or email [email protected].