Configuration Options

The acme.config.json file in your project root controls build settings, deployment targets, routing rules, and more. This page documents every supported field.

Example

{
  "name": "my-project",
  "build": {
    "command": "npm run build",
    "output": "./dist",
    "node_version": "20"
  },
  "deploy": {
    "target": "cloudflare-workers",
    "routes": ["example.com/*"],
    "minify": true
  },
  "env": {
    "production": {
      "API_URL": "https://api.example.com"
    },
    "preview": {
      "API_URL": "https://staging-api.example.com"
    }
  }
}

Top-Level Fields

Field	Type	Required	Description
`name`	`string`	Yes	Project name. Must be URL-safe (lowercase, hyphens allowed).
`build`	`object`	No	Build configuration (see below).
`deploy`	`object`	No	Deployment configuration (see below).
`env`	`object`	No	Environment variable overrides keyed by environment name.

`build`

Field	Type	Default	Description
`command`	`string`	`"npm run build"`	Shell command to run during the build step.
`output`	`string`	`"./dist"`	Directory containing the build output, relative to project root.
`node_version`	`string`	`"20"`	Node.js major version used during remote builds.
`install_command`	`string`	`"npm ci"`	Command to install dependencies before building.

`deploy`

Field	Type	Default	Description
`target`	`string`	`"cloudflare-workers"`	Deployment target. Options: `cloudflare-workers`, `docker`, `static`.
`routes`	`string[]`	`[]`	Custom domain routing patterns (e.g., `["example.com/*"]`).
`minify`	`boolean`	`true`	Whether to minify the output during deployment.
`region`	`string`	`"auto"`	Preferred deployment region. Use `"auto"` for global distribution.

`env`

Environment-specific variable overrides. Keys are environment names (production, preview, or custom names), and values are objects mapping variable names to their values.

{
  "env": {
    "production": {
      "DATABASE_URL": "postgres://prod-host:5432/db",
      "LOG_LEVEL": "warn"
    },
    "preview": {
      "DATABASE_URL": "postgres://staging-host:5432/db",
      "LOG_LEVEL": "debug"
    }
  }
}

Validation

Run the following command to validate your configuration file against the schema:

acme config validate

This checks for missing required fields, invalid values, and deprecated options.