Skip to content

CLI

conveyor-cli is a small companion binary bundled alongside the main server, for tasks that don’t belong in the web UI.

Conveyor CLI
Commands:
generate-key Generate a new encryption key
user:create Create a new user (interactive)

Generates a random 32-byte key and prints it as 64 hex characters. This is the value you set as CONVEYOR_ENCRYPTION_KEY. It doesn’t touch the database or require any configuration to run.

Terminal window
./conveyor-cli generate-key

In Docker:

Terminal window
docker compose exec conveyor /app/conveyor-cli generate-key

Or, before you have a running container at all:

Terminal window
docker run --rm ghcr.io/smitmartijn/conveyor:latest /app/conveyor-cli generate-key

Creates a new user interactively. It prompts for name, email, and password (password input is hidden). Unlike CONVEYOR_ADMIN_EMAIL/CONVEYOR_ADMIN_PASSWORD, this works at any time, not just on first boot, so it’s the way to add additional users to an existing instance.

This command needs a working configuration (CONVEYOR_ENCRYPTION_KEY and CONVEYOR_DATA_DIR at minimum) since it opens the database directly.

Terminal window
docker compose exec -it conveyor /app/conveyor-cli user:create

From source:

Terminal window
go run ./cmd/cli user:create