CLI Reference

Complete reference for every dynamiq CLI command — config, org, project, service, and resource-profiles — with flags and examples.

Complete reference for the dynamiq command. For installation and first-time setup, start with the CLI Overview. Command groups accept singular and plural aliases interchangeably: org/orgs, project/projects, service/services, resource-profile/resource-profiles.

dynamiq [--version] [-v|--verbose] [-h|--help] <group> <command> [flags]

Options marked prompted are asked for interactively when omitted, so every command can run fully non-interactively in CI by passing its flags.

`dynamiq config`

Run without a subcommand to configure the CLI interactively:

dynamiq config

Prompts for the API host (Enter keeps https://api.getdynamiq.ai) and your API key — a Personal Access Token. Saved values are reused by all commands.

`dynamiq config show`

Print the current configuration with the API key masked:

dynamiq config show

Current Dynamiq CLI configuration:
DYNAMIQ API HOST: https://api.getdynamiq.ai
DYNAMIQ API KEY: dyn_...
DYNAMIQ ORG ID: 0d4f9a36-...
DYNAMIQ PROJECT ID: 7b1c2d8e-...

`dynamiq org`

`dynamiq org list`

List organizations your token can access, as an ID / Name table:

dynamiq org list

`dynamiq org set`

Set the current organization. Validates the ID against the API before saving it to your config:

dynamiq org set --id <org-id>

--idstringrequired

Organization ID (prompted if omitted).

`dynamiq project`

Both commands require an organization to be set first.

`dynamiq project list`

List projects in the current organization:

dynamiq project list

`dynamiq project set`

Set the current project (validated against the API):

dynamiq project set --id <project-id>

--idstringrequired

Project ID (prompted if omitted).

`dynamiq service`

Manage service deployments — custom containers run on platform infrastructure.

`dynamiq service list`

List services in the current project with their ID, name, access type, category, and hostname:

dynamiq service list

`dynamiq service get`

Print all fields of one service:

dynamiq service get --id <service-id>

--idstringrequired

Service ID (prompted if omitted).

`dynamiq service create`

Create a service record in the current project:

dynamiq service create --name qa-service --access private

--namestringrequired

Service name (prompted if omitted).

--accessprivate | public

Endpoint access control. Defaults to private.

--categorystring

Service category. Defaults to service.

`dynamiq service deploy`

Start a deployment for a service — either building from a source directory (the default) or running a prebuilt image:

# Build from source: archives the directory and lets the platform run the Docker build
dynamiq service deploy --id <service-id> \
  --source ./ \
  --docker-file Dockerfile \
  --env-secret OPENAI_API_KEY "$OPENAI_API_KEY" \
  --env LOG_LEVEL info \
  --min-replicas 1 --max-replicas 3

# Or deploy a prebuilt image
dynamiq service deploy --id <service-id> --image registry.example.com/qa-service:1.0.0

--idstringrequired

Service ID (prompted if omitted).

--sourcepath

Source directory to archive and upload. Defaults to ./. Ignored when --image is set.

--docker-contextstring

Docker build context inside the source. Defaults to .

--docker-filestring

Dockerfile path inside the source. Defaults to Dockerfile.

--imagestring

Prebuilt image reference. Skips the source upload and build.

--cpu-requests / --cpu-limitsstring

CPU request/limit. Defaults: 100m / 200m.

--memory-requests / --memory-limitsstring

Memory request/limit. Defaults: 256Mi / 512Mi.

--resource-profilestring

Resource profile ID — replaces the four explicit resource flags.

--env NAME VALUEpair, repeatable

Plain environment variable.

--env-secret NAME VALUEpair, repeatable

Environment variable stored as a secret.

--commandstring, repeatable

Container entrypoint command override.

--argsstring, repeatable

Arguments for the command.

--min-replicas / --max-replicasint

Autoscaling bounds. Defaults: 1 / 2.

--target-cpu-utilizationint

Average CPU utilization the autoscaler targets. Defaults to 80.

With --source, the CLI packages the directory as a .tar.gz and uploads it with the deployment configuration to POST /v1/services/{id}/deploy; with --image it sends the configuration only. On success it prints Deployment successfully started with docker build. (or ... with image.).

`dynamiq service status`

Show the latest deployment of a service:

dynamiq service status --id <service-id>

--idstringrequired

Service ID (prompted if omitted).

`dynamiq service update`

Update a service's access type or description. At least one flag is required:

dynamiq service update --id <service-id> --access public --description "Public QA endpoint"

--idstringrequired

Service ID (prompted if omitted).

--accessprivate | public

New endpoint access control.

--descriptionstring

New description.

`dynamiq service delete`

Delete a service:

dynamiq service delete --id <service-id>

--idstringrequired

Service ID (prompted if omitted).

`dynamiq resource-profiles`

`dynamiq resource-profiles list`

List predefined container sizes you can pass to service deploy --resource-profile:

dynamiq resource-profiles list --purpose service

--purposeinference | service | fine_tuning

Which profile family to list. Defaults to service.

--sort-byname | sort_order | description

Sort key. Defaults to sort_order.

--page-sizeint

Page size. Defaults to 100.

`dynamiq config`

`dynamiq config show`

`dynamiq org`

`dynamiq org list`

`dynamiq org set`

`dynamiq project`

`dynamiq project list`

`dynamiq project set`

`dynamiq service`

`dynamiq service list`

`dynamiq service get`

`dynamiq service create`

`dynamiq service deploy`

`dynamiq service status`

`dynamiq service update`

`dynamiq service delete`

`dynamiq resource-profiles`

`dynamiq resource-profiles list`

Next steps

CLI Overview

Deploy from the SDK

Service Deployments

On this page