CLI · CommandsServices

Services

List, inspect, deploy and operate services.

eqs services ls

Lists a space's services, with status and source: the image, or the repository the service is built from.

--space <slug>The space (default: the active space, set with eqs spaces use). Every command on this page takes it

shell

eqs services ls --space my-space

eqs services get <svc>

Details of a service: source, port, scale, its health check (the health path, or a TCP probe), and where it answers: its domains, its address first (the name chosen under the platform's domain, when there is one), each marked address, generated or custom, verified or unverified, with or without TLS, and the generated one with where it redirects and, for a service exposed on a TCP port, its host:port.

shell

eqs services get api-gateway

eqs services create <name>

Creates a service and deploys it from one source: a connected repository (the stack is detected, or a Dockerfile or Compose file in it is built), a prebuilt image, or a marketplace service.

--repo <owner/name>A connected repository, built from --branch (default: main)

--dockerfile [path]With --repo: build from a Dockerfile (default path: Dockerfile)

--composeWith --repo: build from a docker-compose file

--image <ref>A prebuilt image

--catalog <code>A marketplace service: eqs services catalog lists them, and --catalog-version picks the version

--set <key=value>With --catalog: a field's value. Repeatable

--port <n>The port the app listens on

--internalInternal only, with no public domain

--min <n>Minimum instances (0 = scale to zero)

--max <n>Maximum instances

--domain <host>Attach a custom domain once the service is created

--health-path <path>The health check's path: an HTTP GET on it says whether an instance is ready. Without it, a TCP probe on the port

shell

eqs services create api --image registry.example/api:1.4 --port 8080 --health-path /healthz

eqs services update <svc>

Changes a service's image or health path, and starts a rollout. Only the options given change, and with neither the command is refused. An image can only be set on a service deployed from an image.

--image <ref>The image to run

--health-path <path>The health check's path; "" puts the service back on the TCP probe

shell

eqs services update api --health-path /healthz

eqs deploy <svc>

Triggers a new deploy of the service: one built from a repository is rebuilt (build → push → rollout), one deployed from an image rolls it out again. Returns as soon as the rollout is queued, unless --wait is given.

--image <ref>Make this image the service's image and roll it out (a service deployed from an image)

--waitFollow the deployment the command started, reporting each state it enters. Exits 0 once it is running, and non-zero when it fails (printing its log) or when none starts within a minute

--timeout <minutes>With --wait: how many minutes the deployment may take (default: 30). Past that, the command names the deployment and the state it is in, and exits non-zero

shell

eqs deploy api --image registry.example/api:1.5 --wait

eqs restart <svc>

Restarts the service instances.

shell

eqs restart web-frontend

eqs scale <svc>

Adjusts the instance limits (min–max). v2.

--min <n>Minimum (0 = scale to zero)

--max <n>Maximum

shell

eqs scale worker --min 1 --max 6

eqs env ls <svc> · eqs env set <svc> K=V · eqs env rm <svc> K · eqs env apply <svc>

Lists the service's environment variables (names only: values are never returned), sets or removes one, and rolls them out.

--secretWith set: store the value encrypted, in a Secret

--applyWith set: roll the service out now, instead of leaving the change pending

shell

eqs env set api-gateway LOG_LEVEL=debug

Saving a variable does NOT restart anything: the running instances hold the Secret they were rendered with, and that only changes on a rollout. Set the whole group, then roll it once with eqs env apply <svc> — rolling out on every save would restart the service halfway through a connection string. eqs env pending <svc> says whether a rollout is still owed, and clears when any rollout picks the variables up.