Project file reference
Top-level keys of devlanes.yaml. Each has a page with every key under it.
extends: Other project files this one builds on: one path or a list, relative to this file, such asdevlanes.yamlfor adevlanes.prod.yamlthat runs the same apps another way.global_env: Variables for every service and task of the lane, above devlanes’ own variables (PORT,DEVLANES_*) and below each unit’senvand the profile’senv.infra: Containers the lanes depend on (databases, brokers, object stores), started and waited on before setup, tasks and services, plus the commands that create and remove each lane’s data in them.lanes: Which worktrees get a lane, how many ports each lane reserves, and values computed per lane (lane.<name>).profiles: Named selections of services fordevlanes start --profile <name>.project: Project name, the same in every worktree of the repository.services: Long-running processes of each lane, started together after infrastructure, setup andlane.starttasks.tags: Optional color and description per tag.tasks: One-shot commands such as installs, migrations and seeds, run by hand withdevlanes run <name>or automatically at a lane event set withwhen.templates: Named service settings that services reuse withextends: <template>.
project: acmeservices: api: run_script: file: apps/api/package.json name: devprojectProject name, the same in every worktree of the repository. It builds each lane's default domain (<project>.localhost for lane 0, <project><N>.localhost for lane N), names lanes in commands (acme@2), the containers devlanes creates and DEVLANES_LANE_PROJECT, and other projects reach this one as projects.<project>. Lowercase letters, digits, dots, underscores and dashes.
servicesLong-running processes of each lane, started together after infrastructure, setup and lane.start tasks. Each service gets its own port as PORT and, with hosts, HTTPS hostnames. A service that exits shows as failed and is not restarted.
services.<name>A long-running process started with the lane, such as a dev server or a worker. Each service gets its own port from the lane's block (PORT, ${{ self.port }}); devlanes stops it with the lane and never restarts it when it exits. A service needs run or run_script, directly or through extends.
services.<name>.run_scriptScript to run from a project file, as { file, name }, such as { file: apps/api/package.json, name: dev }. devlanes picks the tool from the file name (package.json, Makefile, justfile, Taskfile.yml, deno.json, pyproject.toml, Cargo.toml, go.mod, pom.xml, build.gradle(.kts), settings.gradle(.kts)), runs the script in that file's directory and checks that it exists before starting. For Maven and Gradle, name is the arguments as typed after mvn or gradle, and Maven or Gradle reports a goal or task that does not exist. Presets need it to place their flags, and a profile's run_scripts can swap the script name. Exactly one of run and run_script is required after templates are applied.
services.<name>.run_script.fileFile that defines the script, relative to the project file's directory, such as apps/api/package.json. The script runs in this file's directory. Required unless an override or extends child keeps the inherited file.
services.<name>.run_script.nameScript, target, recipe, task, binary or package name in that file. For go.mod, a bare name such as api means ./cmd/api, and . or a path with / is relative to go.mod. For pom.xml and Gradle files it is the arguments as typed after mvn or gradle, such as -pl web -am spring-boot:run or :web:bootRun; quote an argument that contains spaces, as in a shell. It must name at least one goal or task. Required unless an override or extends child keeps the inherited name.