Skip to content

devlanes is in beta and not ready for production use.Report an issue

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 as devlanes.yaml for a devlanes.prod.yaml that 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’s env and the profile’s env.
  • 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 for devlanes 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 and lane.start tasks.
  • tags: Optional color and description per tag.
  • tasks: One-shot commands such as installs, migrations and seeds, run by hand with devlanes run <name> or automatically at a lane event set with when.
  • templates: Named service settings that services reuse with extends: <template>.
devlanes.yaml
project: acme
services:
api:
run_script:
file: apps/api/package.json
name: dev