Host CLI Reference

When Kuberfy is installed on your server, a lightweight management wrapper is placed at /usr/local/bin/kuberfy. This utility allows you to control the platform without directly wrestling with raw Docker Swarm commands.

Global Usage

kuberfy <command> [options]

Available Commands

1. Update Platform

Pulls the latest published production image from GitHub Container Registry (ghcr.io/joelveloz/kuberfy:latest) and performs a zero-downtime rolling service update:

kuberfy update

2. Create an Admin or User Account

Creates a new user in the embedded database. If no password is provided, a secure random temporary password will be generated and printed to the terminal:

kuberfy create-user --email user@example.com --role admin

3. Reset User Password

Resets the password for any existing account:

kuberfy set-password --email user@example.com --password "NewSecurePassword123!"

4. View Platform Logs

Tails the live stdout/stderr log stream of the Kuberfy control plane container:

kuberfy logs
# Or follow logs continuously:
kuberfy logs -f

5. Check Platform Status

Inspects the status of the Docker Swarm service and container tasks:

kuberfy status

6. Restart Service

Forces a restart of the Kuberfy service container:

kuberfy restart

Container Entrypoint Subcommands

The compiled single binary inside the container (/kuberfy) also supports direct subcommands for automation and maintenance:

Subcommand	Description
`server`	Starts the Bun + Hono HTTP server and WebSocket server.
`migrate`	Executes pending Drizzle ORM schema migrations against SQLite.
`create-user`	CLI tool for creating users via Better Auth.
`set-password`	CLI tool for updating user password hashes.