devlanes 0.13.1 → 0.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,17 +1,143 @@
1
+ <p align="center">
2
+ <b>Using devlanes?</b> Please consider <a href="https://github.com/sponsors/arthurfiorette" target="_blank">donating</a> to support my open source work ❤️
3
+ <br />
4
+ <sup>
5
+ Help devlanes grow! Star and share this amazing repository with your friends and co-workers!
6
+ </sup>
7
+ </p>
8
+
9
+ <br />
10
+
11
+ <p align="center" title="devlanes">
12
+ <a href="https://devlanes.run" target="_blank" rel="noopener noreferrer">
13
+ <img src="https://devlanes.run/assets/banner.png" alt="devlanes: Sandboxes for your agents. localhost for you." />
14
+ </a>
15
+ </p>
16
+
17
+ <br />
18
+
19
+ <p align="center">
20
+ <a title="Apache-2.0 license" target="_blank" href="https://github.com/devlanes-run/devlanes/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/github/license/devlanes-run/devlanes"></a>
21
+ <a title="Latest release" target="_blank" href="https://github.com/devlanes-run/devlanes/releases/latest"><img alt="Release" src="https://img.shields.io/github/v/release/devlanes-run/devlanes"></a>
22
+ <a title="CI" target="_blank" href="https://github.com/devlanes-run/devlanes/actions/workflows/ci.yml"><img alt="CI" src="https://img.shields.io/github/actions/workflow/status/devlanes-run/devlanes/ci.yml?branch=main&label=ci"></a>
23
+ <a title="npm package" target="_blank" href="https://www.npmjs.com/package/devlanes"><img alt="Downloads" src="https://img.shields.io/npm/dw/devlanes?style=flat"></a>
24
+ <a title="Last commit" target="_blank" href="https://github.com/devlanes-run/devlanes/commits/main"><img alt="Last commit" src="https://img.shields.io/github/last-commit/devlanes-run/devlanes"></a>
25
+ </p>
26
+
27
+ <br />
28
+ <br />
29
+
1
30
  # devlanes
2
31
 
3
- devlanes manages development environments for macOS and Linux. Each Git worktree becomes a lane with its own ports, hostnames and data, and a per-user daemon runs the services.
32
+ > Sandboxes for your agents. localhost for you.
33
+
34
+ <br />
35
+
36
+ devlanes runs your dev stack once per Git worktree, so you and your coding agents can work on different branches at the same time. Each worktree gets a lane with its own ports, HTTPS hostnames and data. Lanes run on your machine or on a remote one, and open in your browser either way.
37
+
38
+ It runs on macOS, Linux and Windows 11, and it is in beta.
39
+
40
+ <br />
41
+
42
+ - [Read the docs.](https://devlanes.run/docs/)
43
+ - [Browse the examples.](https://devlanes.run/examples/)
44
+
45
+ <br />
46
+
47
+ ## Why devlanes
48
+
49
+ - [A lane per worktree](https://devlanes.run/docs/learn/worktrees/): the main branch at `myapp.localhost`, a feature branch at `myapp1.localhost`, each on its own ports.
50
+ - [HTTPS hostnames](https://devlanes.run/docs/concepts/hostnames-and-https/) with certificates your browser trusts, and no port to remember.
51
+ - [A database per lane](https://devlanes.run/docs/learn/databases/): one Postgres container, and a database in it for each lane.
52
+ - [Coding agents](https://devlanes.run/docs/how-to/agents/set-up/) start, test and stop their own lane through a skill or an MCP server, and leave yours alone.
53
+ - [Remote boxes](https://devlanes.run/docs/learn/remote/): run the lanes on a VPS, a container or a codespace, and open them under the same hostnames.
54
+ - [One daemon](https://devlanes.run/docs/concepts/daemon/) runs the processes, so they keep running after you close the terminal. A CLI and a TUI talk to it.
55
+
56
+ ## Get started
57
+
58
+ Paste this into your coding agent:
59
+
60
+ ```text
61
+ Install the devlanes skill:
62
+ npx skills add devlanes-run/devlanes --skill devlanes
63
+
64
+ Then install devlanes on this machine, set up everything it needs,
65
+ and help me port this project to devlanes from whatever runs it today.
66
+ ```
4
67
 
5
- ## Usage
68
+ Or install it yourself, with the package manager you already use:
6
69
 
7
70
  ```sh
71
+ brew install devlanes-run/tap/devlanes
8
72
  npm install -g devlanes
9
- devlanes --help
73
+ uv tool install devlanes
10
74
  ```
11
75
 
12
- Documentation: https://devlanes.run. Source: https://github.com/devlanes-run/devlanes.
76
+ Or with the install script, on macOS and Linux:
77
+
78
+ ```sh
79
+ curl -fsSL https://devlanes.run/install.sh | sh
80
+ ```
81
+
82
+ On Windows 11:
83
+
84
+ ```powershell
85
+ irm https://devlanes.run/install.ps1 | iex
86
+ ```
13
87
 
14
- ## Shorter name
88
+ [Install devlanes](https://devlanes.run/docs/install/) has the steps that follow the install.
89
+
90
+ You install it once. devlanes then keeps itself up to date in the background, without interrupting your work.
91
+
92
+ ## A project in one file
93
+
94
+ ```yaml
95
+ # devlanes.yaml
96
+ project: myapp
97
+
98
+ services:
99
+ api:
100
+ run_script:
101
+ file: api/package.json
102
+ name: dev
103
+ hosts: "api.${{ lane.domain }}"
104
+ web:
105
+ preset: vite
106
+ run_script:
107
+ file: web/package.json
108
+ name: dev
109
+ env:
110
+ VITE_API_URL: "${{ services.api.public_url }}"
111
+ hosts: "${{ lane.domain }}"
112
+ ```
113
+
114
+ ```sh
115
+ devlanes start
116
+ ```
117
+
118
+ In the main worktree this serves `myapp.localhost` and `api.myapp.localhost` over HTTPS. In a second worktree the same file serves `myapp1.localhost` and `api.myapp1.localhost`, on other ports.
119
+
120
+ ## Documentation
121
+
122
+ The [docs](https://devlanes.run/docs/) start with a [tour](https://devlanes.run/docs/learn/first-service/) that follows one project from a single service to lanes on another machine. `devlanes --help` lists the commands.
123
+
124
+ ## The npm package
125
+
126
+ `npm install -g devlanes` installs the native binary from one of the `@devlanes/<platform>-<arch>` packages, picked by `os`, `cpu` and `libc`. Builds exist for macOS arm64 and x64, for Linux arm64 and x64 with glibc, and for Windows 11 arm64 and x64.
127
+
128
+ On macOS and Linux the postinstall script replaces this package's `bin/devlanes` with that binary, so `devlanes` runs without starting Node. When the script does not run (`--ignore-scripts`, Yarn, Windows) or fails, `bin/devlanes` stays a small Node launcher that starts the binary, and everything works the same. npm 12, pnpm and Bun skip install scripts of dependencies unless allowed: `npm install -g --allow-scripts=devlanes devlanes`, `pnpm approve-builds` or `bun pm trust devlanes`.
129
+
130
+ ### Config schemas
131
+
132
+ The package ships the JSON Schemas of the config files, exported as `devlanes/schema.json` (for `devlanes.yaml` and `devlanes.local.yaml`) and `devlanes/user-schema.json` (for `~/.devlanes/config.yaml`). With devlanes installed in the project (`npm install -D devlanes`), this first line in `devlanes.yaml` makes editors that use yaml-language-server validate and complete the file:
133
+
134
+ ```yaml
135
+ # yaml-language-server: $schema=./node_modules/devlanes/schema.json
136
+ ```
137
+
138
+ yaml-language-server resolves the path from the YAML file's directory, so it fits a `devlanes.yaml` next to `node_modules`. This copy matches the installed version. Without the package in the project, use `https://devlanes.run/v1/schema.json` and `https://devlanes.run/v1/user-schema.json`, which follow the latest stable release.
139
+
140
+ ### Shorter name
15
141
 
16
142
  devlanes ships no `dl` command. To type `dl`, add an alias to your shell config, after the line that loads devlanes completions, so the alias completes like `devlanes`:
17
143
 
@@ -28,22 +154,26 @@ complete -o nospace -o bashdefault -F _clap_complete_devlanes dl
28
154
  alias dl devlanes
29
155
  ```
30
156
 
31
- ## Config schemas
157
+ ## Contributing
32
158
 
33
- The package ships the JSON Schemas of the config files, exported as `devlanes/schema.json` (for `devlanes.yaml` and `devlanes.local.yaml`) and `devlanes/user-schema.json` (for `~/.devlanes/config.yaml`). With devlanes installed in the project (`npm install -D devlanes`), this first line in `devlanes.yaml` makes editors that use yaml-language-server validate and complete the file:
159
+ [CONTRIBUTING.md](https://github.com/devlanes-run/devlanes/blob/main/CONTRIBUTING.md) covers building, testing and the design notes, and [AGENTS.md](https://github.com/devlanes-run/devlanes/blob/main/AGENTS.md) has the conventions for people and agents working on the code.
34
160
 
35
- ```yaml
36
- # yaml-language-server: $schema=./node_modules/devlanes/schema.json
161
+ Every commit on `main` that passes CI is published as the `next` build, so once your pull request is merged you can use it without waiting for a release. On macOS and Linux:
162
+
163
+ ```sh
164
+ curl -fsSL https://devlanes.run/install.sh | sh -s -- --channel next
37
165
  ```
38
166
 
39
- yaml-language-server resolves the path from the YAML file's directory, so it fits a `devlanes.yaml` next to `node_modules`. This copy matches the installed version. Without the package in the project, use `https://devlanes.run/v1/schema.json` and `https://devlanes.run/v1/user-schema.json`, which follow the latest stable release.
167
+ On Windows 11:
40
168
 
41
- ## Behaviour
169
+ ```powershell
170
+ iex "& {$(irm https://devlanes.run/install.ps1)} -Channel next"
171
+ ```
42
172
 
43
- npm installs the native binary from one of the `@devlanes/<platform>-<arch>` packages, picked by `os`, `cpu` and `libc`. Builds exist for macOS arm64 and x64 and for Linux arm64 and x64 with glibc.
173
+ `devlanes update` then moves a `next` install to the latest build of `main`.
44
174
 
45
- The postinstall script replaces this package's `bin/devlanes` with that binary, so `devlanes` runs without starting Node. When the script does not run (`--ignore-scripts`, Yarn) or fails, `bin/devlanes` stays a small Node launcher that starts the binary, and everything works the same. npm 12, pnpm and Bun skip install scripts of dependencies unless allowed: `npm install -g --allow-scripts=devlanes devlanes`, `pnpm approve-builds` or `bun pm trust devlanes`.
175
+ mprocs and dekit informed the terminal interaction. pitchfork, process-compose, devenv, Coasts, portless, kache, overmind and Conductor informed the process and worktree workflows.
46
176
 
47
177
  ## License
48
178
 
49
- Apache-2.0
179
+ Licensed under the **Apache-2.0 License**. See [`LICENSE`](https://github.com/devlanes-run/devlanes/blob/main/LICENSE) for more information.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "devlanes",
3
- "version": "0.13.1",
3
+ "version": "0.14.0",
4
4
  "description": "Development environments in Git worktree lanes",
5
5
  "license": "Apache-2.0",
6
6
  "homepage": "https://devlanes.run",
@@ -30,11 +30,11 @@
30
30
  "node": ">=18"
31
31
  },
32
32
  "optionalDependencies": {
33
- "@devlanes/darwin-arm64": "0.13.1",
34
- "@devlanes/darwin-x64": "0.13.1",
35
- "@devlanes/linux-arm64": "0.13.1",
36
- "@devlanes/linux-x64": "0.13.1",
37
- "@devlanes/win32-arm64": "0.13.1",
38
- "@devlanes/win32-x64": "0.13.1"
33
+ "@devlanes/darwin-arm64": "0.14.0",
34
+ "@devlanes/darwin-x64": "0.14.0",
35
+ "@devlanes/linux-arm64": "0.14.0",
36
+ "@devlanes/linux-x64": "0.14.0",
37
+ "@devlanes/win32-arm64": "0.14.0",
38
+ "@devlanes/win32-x64": "0.14.0"
39
39
  }
40
40
  }
package/schema.json CHANGED
@@ -1338,6 +1338,39 @@
1338
1338
  },
1339
1339
  "type": "object"
1340
1340
  },
1341
+ "InjectedPresetOptions4": {
1342
+ "additionalProperties": false,
1343
+ "description": "Options for `preset: spring-boot`, which sets `SERVER_PORT` to the service's port, binds the app to 127.0.0.1, trusts the devlanes proxy's forwarded headers and turns off LiveReload, whose fixed port 35729 collides between lanes.",
1344
+ "examples": [
1345
+ {
1346
+ "docker_compose": true
1347
+ }
1348
+ ],
1349
+ "markdownDescription": "Options for `preset: spring-boot`, which sets `SERVER_PORT` to the service's port, binds the app to 127.0.0.1, trusts the devlanes proxy's forwarded headers and turns off LiveReload, whose fixed port 35729 collides between lanes.",
1350
+ "properties": {
1351
+ "docker_compose": {
1352
+ "description": "Lets Spring Boot's own Docker Compose support (`spring-boot-docker-compose`) start the project's compose file. Default: `false`, which sets `SPRING_DOCKER_COMPOSE_ENABLED=false`: devlanes already runs the project's containers per lane or shared, and Spring's support would start a second copy for every worktree. Set `true` only when devlanes does not manage those containers.",
1353
+ "examples": [
1354
+ true
1355
+ ],
1356
+ "markdownDescription": "Lets Spring Boot's own Docker Compose support (`spring-boot-docker-compose`) start the project's compose file. Default: `false`, which sets `SPRING_DOCKER_COMPOSE_ENABLED=false`: devlanes already runs the project's containers per lane or shared, and Spring's support would start a second copy for every worktree. Set `true` only when devlanes does not manage those containers.",
1357
+ "type": [
1358
+ "boolean",
1359
+ "null"
1360
+ ]
1361
+ }
1362
+ },
1363
+ "type": "object"
1364
+ },
1365
+ "InjectedPresetOptions5": {
1366
+ "additionalProperties": false,
1367
+ "description": "Options for `preset: quarkus`, which sets the HTTP port and host, lets continuous testing pick a free port and moves the dev-mode debugger from 5005 to `self.ports.debug`, so two lanes can run dev mode side by side. The preset has no settings, so the key can be left out.",
1368
+ "examples": [
1369
+ {}
1370
+ ],
1371
+ "markdownDescription": "Options for `preset: quarkus`, which sets the HTTP port and host, lets continuous testing pick a free port and moves the dev-mode debugger from 5005 to `self.ports.debug`, so two lanes can run dev mode side by side. The preset has no settings, so the key can be left out.",
1372
+ "type": "object"
1373
+ },
1341
1374
  "LanesConfig": {
1342
1375
  "additionalProperties": false,
1343
1376
  "description": "Each Git worktree of the project is a lane with its own ports, hostnames and data. These settings decide which worktrees get a lane, how many ports each lane reserves, and the values each lane computes.",
@@ -1504,20 +1537,20 @@
1504
1537
  "vars": {
1505
1538
  "additionalProperties": {
1506
1539
  "$ref": "#/$defs/Templated_Scalar",
1507
- "description": "Values computed for each lane and read as `${{ lane.<name> }}`, such as a database name, vhost, bucket or Redis index per lane. A var named `domain` replaces the default lane domain, and one named `port` fixes where the lane's port block starts. `${{ domain('pages') }}` gives a name a site of its own in each lane, such as `pages2.localhost` in lane 2. Cannot be combined with `matrix`.",
1540
+ "description": "Values computed for each lane and read as `${{ lane.<name> }}`, such as a database name, vhost, bucket or Redis index per lane. Build names from `${{ lane.name }}`, which is `main` in lane 0 and `lane<N>` in lane N whatever the branch, and numbers from `${{ lane.index }}`. A var named `domain` replaces the default lane domain, and one named `port` fixes where the lane's port block starts. `${{ domain('pages') }}` gives a name a site of its own in each lane, such as `pages2.localhost` in lane 2. Cannot be combined with `matrix`.",
1508
1541
  "examples": [
1509
1542
  "acme_${{ lane.name }}"
1510
1543
  ],
1511
- "markdownDescription": "Values computed for each lane and read as `${{ lane.<name> }}`, such as a database name, vhost, bucket or Redis index per lane. A var named `domain` replaces the default lane domain, and one named `port` fixes where the lane's port block starts. `${{ domain('pages') }}` gives a name a site of its own in each lane, such as `pages2.localhost` in lane 2. Cannot be combined with `matrix`."
1544
+ "markdownDescription": "Values computed for each lane and read as `${{ lane.<name> }}`, such as a database name, vhost, bucket or Redis index per lane. Build names from `${{ lane.name }}`, which is `main` in lane 0 and `lane<N>` in lane N whatever the branch, and numbers from `${{ lane.index }}`. A var named `domain` replaces the default lane domain, and one named `port` fixes where the lane's port block starts. `${{ domain('pages') }}` gives a name a site of its own in each lane, such as `pages2.localhost` in lane 2. Cannot be combined with `matrix`."
1512
1545
  },
1513
1546
  "default": {},
1514
- "description": "Values computed for each lane and read as `${{ lane.<name> }}`, such as a database name, vhost, bucket or Redis index per lane. A var named `domain` replaces the default lane domain, and one named `port` fixes where the lane's port block starts. `${{ domain('pages') }}` gives a name a site of its own in each lane, such as `pages2.localhost` in lane 2. Cannot be combined with `matrix`.",
1547
+ "description": "Values computed for each lane and read as `${{ lane.<name> }}`, such as a database name, vhost, bucket or Redis index per lane. Build names from `${{ lane.name }}`, which is `main` in lane 0 and `lane<N>` in lane N whatever the branch, and numbers from `${{ lane.index }}`. A var named `domain` replaces the default lane domain, and one named `port` fixes where the lane's port block starts. `${{ domain('pages') }}` gives a name a site of its own in each lane, such as `pages2.localhost` in lane 2. Cannot be combined with `matrix`.",
1515
1548
  "examples": [
1516
1549
  {
1517
1550
  "db_name": "acme_${{ lane.name }}"
1518
1551
  }
1519
1552
  ],
1520
- "markdownDescription": "Values computed for each lane and read as `${{ lane.<name> }}`, such as a database name, vhost, bucket or Redis index per lane. A var named `domain` replaces the default lane domain, and one named `port` fixes where the lane's port block starts. `${{ domain('pages') }}` gives a name a site of its own in each lane, such as `pages2.localhost` in lane 2. Cannot be combined with `matrix`.",
1553
+ "markdownDescription": "Values computed for each lane and read as `${{ lane.<name> }}`, such as a database name, vhost, bucket or Redis index per lane. Build names from `${{ lane.name }}`, which is `main` in lane 0 and `lane<N>` in lane N whatever the branch, and numbers from `${{ lane.index }}`. A var named `domain` replaces the default lane domain, and one named `port` fixes where the lane's port block starts. `${{ domain('pages') }}` gives a name a site of its own in each lane, such as `pages2.localhost` in lane 2. Cannot be combined with `matrix`.",
1521
1554
  "type": "object"
1522
1555
  }
1523
1556
  },
@@ -1684,32 +1717,32 @@
1684
1717
  "type": "null"
1685
1718
  }
1686
1719
  ],
1687
- "description": "Set false to skip containers and `infra.setup`, for example to run only a frontend against another lane's backend. Services that reference `infra.*` then fail to resolve. With several profiles active, infra is skipped only when all of them set false. Defaults to true.",
1720
+ "description": "Set false to skip containers and `infra.setup`, for example to run only a frontend against another lane's backend. A value that reads `infra.*` then resolves only while its container already runs, as a shared one another lane started does. Otherwise a service or task whose `env` reads it fails to start, and so does every service and task of the lane when `global_env` or a profile's `env` reads it. With several profiles active, infra is skipped only when all of them set false. Defaults to true.",
1688
1721
  "examples": [
1689
1722
  false,
1690
1723
  true
1691
1724
  ],
1692
- "markdownDescription": "Set false to skip containers and `infra.setup`, for example to run only a frontend against another lane's backend. Services that reference `infra.*` then fail to resolve. With several profiles active, infra is skipped only when all of them set false. Defaults to true."
1725
+ "markdownDescription": "Set false to skip containers and `infra.setup`, for example to run only a frontend against another lane's backend. A value that reads `infra.*` then resolves only while its container already runs, as a shared one another lane started does. Otherwise a service or task whose `env` reads it fails to start, and so does every service and task of the lane when `global_env` or a profile's `env` reads it. With several profiles active, infra is skipped only when all of them set false. Defaults to true."
1693
1726
  },
1694
1727
  "run_scripts": {
1695
1728
  "additionalProperties": {
1696
- "description": "Swap script names for services that use `run_script`: `{ dev: start }` runs the `start` script wherever a service's `run_script` names `dev`. The file stays the same, and each name is swapped once, not chained.",
1729
+ "description": "Swap script names for services that use `run_script`: `{ dev: start }` runs the `start` script wherever a service's `run_script` names `dev`. The file stays the same, and each name is swapped once, not chained. The whole `name` is matched, so a Maven or Gradle `name` such as `spring-boot:run -Pdev` is swapped only by that exact text.",
1697
1730
  "examples": [
1698
1731
  "start"
1699
1732
  ],
1700
- "markdownDescription": "Swap script names for services that use `run_script`: `{ dev: start }` runs the `start` script wherever a service's `run_script` names `dev`. The file stays the same, and each name is swapped once, not chained.",
1733
+ "markdownDescription": "Swap script names for services that use `run_script`: `{ dev: start }` runs the `start` script wherever a service's `run_script` names `dev`. The file stays the same, and each name is swapped once, not chained. The whole `name` is matched, so a Maven or Gradle `name` such as `spring-boot:run -Pdev` is swapped only by that exact text.",
1701
1734
  "minLength": 1,
1702
1735
  "pattern": "\\S",
1703
1736
  "type": "string"
1704
1737
  },
1705
1738
  "default": {},
1706
- "description": "Swap script names for services that use `run_script`: `{ dev: start }` runs the `start` script wherever a service's `run_script` names `dev`. The file stays the same, and each name is swapped once, not chained.",
1739
+ "description": "Swap script names for services that use `run_script`: `{ dev: start }` runs the `start` script wherever a service's `run_script` names `dev`. The file stays the same, and each name is swapped once, not chained. The whole `name` is matched, so a Maven or Gradle `name` such as `spring-boot:run -Pdev` is swapped only by that exact text.",
1707
1740
  "examples": [
1708
1741
  {
1709
1742
  "dev": "start"
1710
1743
  }
1711
1744
  ],
1712
- "markdownDescription": "Swap script names for services that use `run_script`: `{ dev: start }` runs the `start` script wherever a service's `run_script` names `dev`. The file stays the same, and each name is swapped once, not chained.",
1745
+ "markdownDescription": "Swap script names for services that use `run_script`: `{ dev: start }` runs the `start` script wherever a service's `run_script` names `dev`. The file stays the same, and each name is swapped once, not chained. The whole `name` is matched, so a Maven or Gradle `name` such as `spring-boot:run -Pdev` is swapped only by that exact text.",
1713
1746
  "propertyNames": {
1714
1747
  "minLength": 1,
1715
1748
  "pattern": "\\S",
@@ -1953,7 +1986,7 @@
1953
1986
  },
1954
1987
  "RunScript": {
1955
1988
  "additionalProperties": false,
1956
- "description": "Script from a project file, as a mapping with `file` and `name`. devlanes picks the tool from the file name: package.json (the project's package manager), Makefile or `*.mk`, justfile or `*.just`, deno.json, pyproject.toml (uv or poetry) and Cargo.toml (a binary). In `devlanes.local.yaml` or a service that `extends` a template, either key can be left out to keep the inherited one.",
1989
+ "description": "Script from a project file, as a mapping with `file` and `name`. devlanes picks the tool from the file name: package.json (the project's package manager), Makefile or `*.mk`, justfile or `*.just`, Taskfile.yml (task), deno.json, pyproject.toml (uv or poetry), Cargo.toml (a binary), go.mod (a main package), pom.xml (Maven goals) and build.gradle, build.gradle.kts, settings.gradle or settings.gradle.kts (Gradle tasks). Maven and Gradle use the project's wrapper (`mvnw`, `gradlew`) when one exists. In `devlanes.local.yaml` or a service that `extends` a template, either key can be left out to keep the inherited one.",
1957
1990
  "examples": [
1958
1991
  {
1959
1992
  "file": "apps/api/package.json",
@@ -1962,27 +1995,35 @@
1962
1995
  {
1963
1996
  "file": "justfile",
1964
1997
  "name": "fixtures"
1998
+ },
1999
+ {
2000
+ "file": "services/web/pom.xml",
2001
+ "name": "spring-boot:run -Pdev"
1965
2002
  }
1966
2003
  ],
1967
- "markdownDescription": "Script from a project file, as a mapping with `file` and `name`. devlanes picks the tool from the file name: package.json (the project's package manager), Makefile or `*.mk`, justfile or `*.just`, deno.json, pyproject.toml (uv or poetry) and Cargo.toml (a binary). In `devlanes.local.yaml` or a service that `extends` a template, either key can be left out to keep the inherited one.",
2004
+ "markdownDescription": "Script from a project file, as a mapping with `file` and `name`. devlanes picks the tool from the file name: package.json (the project's package manager), Makefile or `*.mk`, justfile or `*.just`, Taskfile.yml (task), deno.json, pyproject.toml (uv or poetry), Cargo.toml (a binary), go.mod (a main package), pom.xml (Maven goals) and build.gradle, build.gradle.kts, settings.gradle or settings.gradle.kts (Gradle tasks). Maven and Gradle use the project's wrapper (`mvnw`, `gradlew`) when one exists. In `devlanes.local.yaml` or a service that `extends` a template, either key can be left out to keep the inherited one.",
1968
2005
  "properties": {
1969
2006
  "file": {
1970
2007
  "description": "File 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.",
1971
2008
  "examples": [
1972
2009
  "apps/api/package.json",
1973
2010
  "Makefile",
1974
- "justfile"
2011
+ "justfile",
2012
+ "pom.xml",
2013
+ "build.gradle.kts"
1975
2014
  ],
1976
2015
  "markdownDescription": "File 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.",
1977
2016
  "type": "string"
1978
2017
  },
1979
2018
  "name": {
1980
- "description": "Script, target, recipe, task or binary name in that file. Required unless an override or `extends` child keeps the inherited name.",
2019
+ "description": "Script, 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.",
1981
2020
  "examples": [
1982
2021
  "dev",
1983
- "fixtures"
2022
+ "fixtures",
2023
+ "spring-boot:run -Pdev",
2024
+ ":web:bootRun --offline"
1984
2025
  ],
1985
- "markdownDescription": "Script, target, recipe, task or binary name in that file. Required unless an override or `extends` child keeps the inherited name.",
2026
+ "markdownDescription": "Script, 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.",
1986
2027
  "type": "string"
1987
2028
  }
1988
2029
  },
@@ -2091,6 +2132,44 @@
2091
2132
  }
2092
2133
  }
2093
2134
  }
2135
+ },
2136
+ {
2137
+ "if": {
2138
+ "required": [
2139
+ "spring-boot"
2140
+ ]
2141
+ },
2142
+ "then": {
2143
+ "properties": {
2144
+ "preset": {
2145
+ "const": "spring-boot",
2146
+ "description": "`spring-boot` options require `preset: spring-boot`.",
2147
+ "examples": [
2148
+ "spring-boot"
2149
+ ],
2150
+ "markdownDescription": "`spring-boot` options require `preset: spring-boot`."
2151
+ }
2152
+ }
2153
+ }
2154
+ },
2155
+ {
2156
+ "if": {
2157
+ "required": [
2158
+ "quarkus"
2159
+ ]
2160
+ },
2161
+ "then": {
2162
+ "properties": {
2163
+ "preset": {
2164
+ "const": "quarkus",
2165
+ "description": "`quarkus` options require `preset: quarkus`.",
2166
+ "examples": [
2167
+ "quarkus"
2168
+ ],
2169
+ "markdownDescription": "`quarkus` options require `preset: quarkus`."
2170
+ }
2171
+ }
2172
+ }
2094
2173
  }
2095
2174
  ],
2096
2175
  "description": "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`.",
@@ -2265,36 +2344,42 @@
2265
2344
  "markdownDescription": "Options for `preset: next`, which adds `--port <self.port> --hostname 127.0.0.1` to the `next dev` command. Without the hostname flag Next listens on `0.0.0.0` instead of loopback."
2266
2345
  },
2267
2346
  "platform": {
2268
- "description": "Runtime of the service: `node`, `bun`, `deno`, `python` or `rust`. It decides which variables devlanes adds, such as the devlanes CA (`NODE_EXTRA_CA_CERTS`, `SSL_CERT_FILE`) and color settings. Detected from the `run_script` file or the working directory when omitted; set it only when detection is wrong. `none` skips detection and adds no platform variables.",
2347
+ "description": "Runtime of the service: `node`, `bun`, `deno`, `python`, `rust`, `go` or `java`. It decides which variables devlanes adds, such as the devlanes CA (`NODE_EXTRA_CA_CERTS`, `SSL_CERT_FILE`, a trust store in `JAVA_TOOL_OPTIONS`) and color settings. Detected from the `run_script` file or the working directory when omitted; set it only when detection is wrong, such as `java` for a `java -jar` command in a folder without a `pom.xml` or Gradle file. `none` skips detection and adds no platform variables.",
2269
2348
  "examples": [
2270
2349
  "node",
2271
2350
  "bun",
2272
2351
  "deno",
2273
2352
  "python",
2274
2353
  "rust",
2354
+ "go",
2355
+ "java",
2275
2356
  "none"
2276
2357
  ],
2277
- "markdownDescription": "Runtime of the service: `node`, `bun`, `deno`, `python` or `rust`. It decides which variables devlanes adds, such as the devlanes CA (`NODE_EXTRA_CA_CERTS`, `SSL_CERT_FILE`) and color settings. Detected from the `run_script` file or the working directory when omitted; set it only when detection is wrong. `none` skips detection and adds no platform variables.",
2358
+ "markdownDescription": "Runtime of the service: `node`, `bun`, `deno`, `python`, `rust`, `go` or `java`. It decides which variables devlanes adds, such as the devlanes CA (`NODE_EXTRA_CA_CERTS`, `SSL_CERT_FILE`, a trust store in `JAVA_TOOL_OPTIONS`) and color settings. Detected from the `run_script` file or the working directory when omitted; set it only when detection is wrong, such as `java` for a `java -jar` command in a folder without a `pom.xml` or Gradle file. `none` skips detection and adds no platform variables.",
2278
2359
  "type": [
2279
2360
  "string",
2280
2361
  "null"
2281
2362
  ]
2282
2363
  },
2283
2364
  "preset": {
2284
- "description": "Framework integration that adds the flags and variables a dev server needs to run in a lane, such as `--port <port> --strictPort --host 127.0.0.1` for `vite`, so you do not pass them yourself. Requires `run_script`; with a hand-written `run`, drop the preset and pass its flags yourself. Its options go under a sibling key with the preset's name, for example `vite: { args: [--open] }`.",
2365
+ "description": "Framework integration that adds the flags and variables a dev server needs to run in a lane, such as `--port <port> --strictPort --host 127.0.0.1` for `vite` or `SERVER_PORT` for `spring-boot`, so you do not pass them yourself. One of `vite`, `next`, `wrangler`, `tauri`, `spring-boot` or `quarkus`. Requires `run_script` (`quarkus` needs a `pom.xml` or `build.gradle(.kts)` one); with a hand-written `run`, drop the preset and pass its flags yourself. Its options go under a sibling key with the preset's name, for example `vite: { args: [--open] }`.",
2285
2366
  "enum": [
2286
2367
  "vite",
2287
2368
  "next",
2288
2369
  "wrangler",
2289
- "tauri"
2370
+ "tauri",
2371
+ "spring-boot",
2372
+ "quarkus"
2290
2373
  ],
2291
2374
  "examples": [
2292
2375
  "vite",
2293
2376
  "next",
2294
2377
  "wrangler",
2295
- "tauri"
2378
+ "tauri",
2379
+ "spring-boot",
2380
+ "quarkus"
2296
2381
  ],
2297
- "markdownDescription": "Framework integration that adds the flags and variables a dev server needs to run in a lane, such as `--port <port> --strictPort --host 127.0.0.1` for `vite`, so you do not pass them yourself. Requires `run_script`; with a hand-written `run`, drop the preset and pass its flags yourself. Its options go under a sibling key with the preset's name, for example `vite: { args: [--open] }`.",
2382
+ "markdownDescription": "Framework integration that adds the flags and variables a dev server needs to run in a lane, such as `--port <port> --strictPort --host 127.0.0.1` for `vite` or `SERVER_PORT` for `spring-boot`, so you do not pass them yourself. One of `vite`, `next`, `wrangler`, `tauri`, `spring-boot` or `quarkus`. Requires `run_script` (`quarkus` needs a `pom.xml` or `build.gradle(.kts)` one); with a hand-written `run`, drop the preset and pass its flags yourself. Its options go under a sibling key with the preset's name, for example `vite: { args: [--open] }`.",
2298
2383
  "type": [
2299
2384
  "string",
2300
2385
  "null"
@@ -2319,6 +2404,14 @@
2319
2404
  ],
2320
2405
  "markdownDescription": "Run the service in a pseudoterminal, so it sees a terminal as it would in your shell and you can type into it from the TUI. Set false to use pipes instead: stdin is empty and stdout and stderr are read separately. Defaults to true."
2321
2406
  },
2407
+ "quarkus": {
2408
+ "$ref": "#/$defs/InjectedPresetOptions5",
2409
+ "description": "Options for `preset: quarkus`, which sets the HTTP port and host, lets continuous testing pick a free port and moves the dev-mode debugger from 5005 to `self.ports.debug`, so two lanes can run dev mode side by side. The preset has no settings, so the key can be left out.",
2410
+ "examples": [
2411
+ {}
2412
+ ],
2413
+ "markdownDescription": "Options for `preset: quarkus`, which sets the HTTP port and host, lets continuous testing pick a free port and moves the dev-mode debugger from 5005 to `self.ports.debug`, so two lanes can run dev mode side by side. The preset has no settings, so the key can be left out."
2414
+ },
2322
2415
  "ready": {
2323
2416
  "anyOf": [
2324
2417
  {
@@ -2396,7 +2489,7 @@
2396
2489
  "type": "null"
2397
2490
  }
2398
2491
  ],
2399
- "description": "Script 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`, `deno.json`, `pyproject.toml`, `Cargo.toml`), runs the script in that file's directory and checks that it exists before starting. 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.",
2492
+ "description": "Script 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.",
2400
2493
  "examples": [
2401
2494
  {
2402
2495
  "file": "apps/api/package.json",
@@ -2405,9 +2498,23 @@
2405
2498
  {
2406
2499
  "file": "justfile",
2407
2500
  "name": "fixtures"
2501
+ },
2502
+ {
2503
+ "file": "services/web/pom.xml",
2504
+ "name": "spring-boot:run -Pdev"
2505
+ }
2506
+ ],
2507
+ "markdownDescription": "Script 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."
2508
+ },
2509
+ "spring-boot": {
2510
+ "$ref": "#/$defs/InjectedPresetOptions4",
2511
+ "description": "Options for `preset: spring-boot`, which sets `SERVER_PORT` to the service's port, binds the app to 127.0.0.1, trusts the devlanes proxy's forwarded headers and turns off LiveReload, whose fixed port 35729 collides between lanes.",
2512
+ "examples": [
2513
+ {
2514
+ "docker_compose": true
2408
2515
  }
2409
2516
  ],
2410
- "markdownDescription": "Script 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`, `deno.json`, `pyproject.toml`, `Cargo.toml`), runs the script in that file's directory and checks that it exists before starting. 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."
2517
+ "markdownDescription": "Options for `preset: spring-boot`, which sets `SERVER_PORT` to the service's port, binds the app to 127.0.0.1, trusts the devlanes proxy's forwarded headers and turns off LiveReload, whose fixed port 35729 collides between lanes."
2411
2518
  },
2412
2519
  "stop": {
2413
2520
  "anyOf": [
@@ -2998,6 +3105,10 @@
2998
3105
  {
2999
3106
  "file": "justfile",
3000
3107
  "name": "fixtures"
3108
+ },
3109
+ {
3110
+ "file": "services/web/pom.xml",
3111
+ "name": "spring-boot:run -Pdev"
3001
3112
  }
3002
3113
  ],
3003
3114
  "markdownDescription": "Script to run from a project file, as `{ file, name }`, such as `{ file: apps/api/package.json, name: migrate }`. It runs with that file's tool (the project's package manager for package.json) in the file's directory, and a missing script fails before anything starts. Prefer it to `run` for scripts that live in a file. Use exactly one of `run`, `run_script` or `steps`."
@@ -3269,20 +3380,20 @@
3269
3380
  "global_env": {
3270
3381
  "additionalProperties": {
3271
3382
  "$ref": "#/$defs/Templated_Scalar",
3272
- "description": "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`. Use it for values many units share, such as a database URL built from `${{ infra.postgres.port }}`. Never set `PORT` here: it would replace every service's own port.",
3383
+ "description": "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`. Use it for values many units share, such as a database URL built from `${{ infra.postgres.port }}`. An entry without a value, such as one that reads a container a profile with `infra: false` left stopped, fails every service and task of the lane, so a value only some services need belongs in their `env`. `devlanes exec` leaves such an entry out and names it. Never set `PORT` here: it would replace every service's own port.",
3273
3384
  "examples": [
3274
3385
  "${{ services.api.url }}"
3275
3386
  ],
3276
- "markdownDescription": "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`. Use it for values many units share, such as a database URL built from `${{ infra.postgres.port }}`. Never set `PORT` here: it would replace every service's own port."
3387
+ "markdownDescription": "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`. Use it for values many units share, such as a database URL built from `${{ infra.postgres.port }}`. An entry without a value, such as one that reads a container a profile with `infra: false` left stopped, fails every service and task of the lane, so a value only some services need belongs in their `env`. `devlanes exec` leaves such an entry out and names it. Never set `PORT` here: it would replace every service's own port."
3277
3388
  },
3278
3389
  "default": {},
3279
- "description": "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`. Use it for values many units share, such as a database URL built from `${{ infra.postgres.port }}`. Never set `PORT` here: it would replace every service's own port.",
3390
+ "description": "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`. Use it for values many units share, such as a database URL built from `${{ infra.postgres.port }}`. An entry without a value, such as one that reads a container a profile with `infra: false` left stopped, fails every service and task of the lane, so a value only some services need belongs in their `env`. `devlanes exec` leaves such an entry out and names it. Never set `PORT` here: it would replace every service's own port.",
3280
3391
  "examples": [
3281
3392
  {
3282
3393
  "API_URL": "${{ services.api.url }}"
3283
3394
  }
3284
3395
  ],
3285
- "markdownDescription": "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`. Use it for values many units share, such as a database URL built from `${{ infra.postgres.port }}`. Never set `PORT` here: it would replace every service's own port.",
3396
+ "markdownDescription": "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`. Use it for values many units share, such as a database URL built from `${{ infra.postgres.port }}`. An entry without a value, such as one that reads a container a profile with `infra: false` left stopped, fails every service and task of the lane, so a value only some services need belongs in their `env`. `devlanes exec` leaves such an entry out and names it. Never set `PORT` here: it would replace every service's own port.",
3286
3397
  "type": "object"
3287
3398
  },
3288
3399
  "infra": {
package/user-schema.json CHANGED
@@ -402,6 +402,7 @@
402
402
  "http_port": 80,
403
403
  "https_port": 443,
404
404
  "lan": false,
405
+ "server_timing": true,
405
406
  "via": true
406
407
  }
407
408
  ],
@@ -443,6 +444,16 @@
443
444
  "markdownDescription": "Accept connections from other devices on the network; defaults to false, which refuses every peer that is not this machine. Those devices must still resolve the hostnames to this machine and trust the CA.",
444
445
  "type": "boolean"
445
446
  },
447
+ "server_timing": {
448
+ "default": true,
449
+ "description": "Add a `Server-Timing` header to every response, after any the service sent, with the time devlanes added (`devlanes`), waits for a starting service or a frozen lane (`devlanes-wait`), the connection to the service (`devlanes-connect`) and the service's own time (`devlanes-upstream`). Browser dev tools show these in the request's Timing tab. For a lane on a remote box, `devlanes-upstream` includes the connection to the box, which `devlanes-tunnel` estimates from its latest ping. Defaults to true; set false if a client or test compares response headers exactly.",
450
+ "examples": [
451
+ true,
452
+ false
453
+ ],
454
+ "markdownDescription": "Add a `Server-Timing` header to every response, after any the service sent, with the time devlanes added (`devlanes`), waits for a starting service or a frozen lane (`devlanes-wait`), the connection to the service (`devlanes-connect`) and the service's own time (`devlanes-upstream`). Browser dev tools show these in the request's Timing tab. For a lane on a remote box, `devlanes-upstream` includes the connection to the box, which `devlanes-tunnel` estimates from its latest ping. Defaults to true; set false if a client or test compares response headers exactly.",
455
+ "type": "boolean"
456
+ },
446
457
  "via": {
447
458
  "default": true,
448
459
  "description": "Add `Via: 1.1 devlanes.run` to every response the proxy forwards from a service (`1.1 devlanes.run (remote)` for lanes on a remote box), so a client can tell that devlanes sat in between. Defaults to true; set false if a client or test compares response headers exactly.",
@@ -1522,6 +1533,7 @@
1522
1533
  "http_port": 80,
1523
1534
  "https_port": 443,
1524
1535
  "lan": false,
1536
+ "server_timing": true,
1525
1537
  "via": true
1526
1538
  },
1527
1539
  "description": "Ports of the daemon's HTTP/HTTPS proxy, which serves every `hosts` entry, and whether other devices on the network may connect to it.",
@@ -1530,6 +1542,7 @@
1530
1542
  "http_port": 80,
1531
1543
  "https_port": 443,
1532
1544
  "lan": false,
1545
+ "server_timing": true,
1533
1546
  "via": true
1534
1547
  }
1535
1548
  ],