Complete command reference

Command syntax

All commands follow gerdoo <command> [subcommand] [args] [flags]. Wherever <slug|id> appears, supply a short name (slug) or service ID. List/read commands accept --json to print raw API output for scripts and CI. The GERDOO_API and GERDOO_TOKEN environment variables override the API address and token.

Authentication and account

Sign in to your Cloud Noce account and manage the CLI token. The token is stored in ~/.config/gerdoo/config.json.

gerdoo login [--no-browser] [--token <grd_...>] [--password] [--api <url>]

Browser sign-in: the CLI displays a short code, opens the Cloud Noce confirmation page and receives its token after you approve. You do not enter your password in the terminal.

gerdoo logout

Remove the saved token and configuration file.

gerdoo whoami

Show the currently signed-in account: name, email and phone number.

Projects (workspaces)

A project is a workspace grouping services, environments and domains.

gerdoo projects [--json]

List your projects with service and server counts.

gerdoo project get <slug|id> [--json]

Show project details, including services and domains.

gerdoo project create --name <n> [--description <d>]

Create a new project.

gerdoo project update <slug|id> [--name <n>] [--description <d>]

Edit the project name or description.

gerdoo project delete <slug|id>

Delete the project with interactive confirmation. Its services and resources must be removed first.

Environments

Manage a project’s production/staging/preview environments and their variables. Identify environments by name or ID.

gerdoo project env <project> list [--json]

List a project’s environments.

gerdoo project env <project> create [flags]

Create an environment in the project.

gerdoo project env <project> get <env> [--json]

Show environment details.

gerdoo project env <project> update <env> [flags]

Edit an environment.

gerdoo project env <project> delete <env>

Delete an environment. The production environment cannot be deleted.

gerdoo project env <project> vars <env> [--json]

List environment variables with masked values.

gerdoo project env <project> vars <env> set KEY=VALUE [--build-time]

Add or edit an environment variable.

gerdoo project env <project> vars <env> rm KEY [KEY...]

Remove one or more environment variables.

Services: listing and creation

gerdoo services [--json]

List all services, including Git and image sources.

gerdoo service create --name <n> --image <img> [flags]

Create a service from a prepared Docker image.

Deploying a local folder

Create or update an always-on service from local source. Works without flags.

gerdoo deploy [dir]

Package and upload the folder (default “.”). Update the linked service, or create a new service if none is linked.

gerdoo service deploy [dir]

Alias for “gerdoo deploy” with the same flags.

Services: configuration and lifecycle

gerdoo service status <slug|id>

Show status, URL, raw TCP endpoint and live CPU/memory usage.

gerdoo service logs <slug|id> [--tail N]

Show the latest container log lines.

gerdoo service stop <slug|id>

Stop a running service (stopped status; volumes are preserved).

gerdoo service start <slug|id>

Start a stopped service again.

gerdoo service restart <slug|id>

Restart a running service without changing its persistent state.

gerdoo service update <slug|id> [flags]

Update the image, branch or variables. Changing an image or variable recreates the service.

gerdoo service delete <slug|id>

Delete the service completely with interactive confirmation.

Environment variables

There are two separate stores: “env” is the service’s simple map; “vars” is the typed variable store with build-time and secret support.

gerdoo service env <slug|id>

List variables in the service’s env map.

gerdoo service env <slug|id> set KEY=VALUE [...]

Add or edit one or more env variables; the service is recreated.

gerdoo service env <slug|id> rm KEY [...]

Remove one or more env variables.

gerdoo service vars <slug|id> [--json]

List typed variables with build/secret indicators.

gerdoo service vars <slug|id> set KEY=VALUE [flags]

Add or edit a variable in the typed store.

gerdoo service vars <slug|id> rm KEY [...]

Remove one or more variables from the typed store.

Custom domains

gerdoo service domains <slug|id> [--json]

List custom domains and required DNS records.

gerdoo service domains <slug|id> add <domain>

Add a custom domain for an HTTP service and show its DNS records.

gerdoo service domains <slug|id> verify <domain|id>

Check the TXT record and verify domain ownership.

gerdoo service domains <slug|id> rm <domain|id>

Remove a custom domain.

Builds, releases and rollback

gerdoo service builds <slug|id> [--json]

List recent service builds.

gerdoo service builds <slug|id> logs <buildId>

Show logs for a specific build.

gerdoo service releases <slug|id> [--json]

List recent service releases.

gerdoo service rollback <slug|id> <buildId>

Return the service to a previously prepared build without rebuilding.

Disk files (volumes)

gerdoo service files <slug|id> [path] [--volume <mount|id>]

Browse a volume’s files.

gerdoo service pull <slug|id> <remote-path> [flags]

Download a file from a volume.

gerdoo service push <slug|id> <local-file> [flags]

Upload a local file to a volume.

Shortcuts and utilities

gerdoo logs <slug|id> [--tail N] [--since 10m] [--grep <pat>] [--level error|warn|info] [--invert]

Shortcut for “gerdoo service logs” with output filtering.

When filtering, the matching count and total inspected line count are also reported, so you can distinguish an absence of logs from a filter with no matches.

gerdoo service exec <slug|id> <command...> [--timeout N]

Execute a one-shot command inside a running container and print its output. Use it for information unavailable in logs, such as an environment variable’s actual value or the presence of a built file. The service must be running.

gerdoo upgrade

Automatically update the CLI to the latest version.

gerdoo version

Show the installed version.