@boxes-dev/dvb-runtime 1.0.1104 → 1.0.1105

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.
@@ -6,9 +6,10 @@ this to get the app running on the Template box and verify the setup worked.
6
6
  - `app.entrypoints`: the terminal command(s) a developer runs to work on
7
7
  the app (`npm run dev`, `just dev`, `cargo run`, ...) with a one-line
8
8
  description (what it serves, which port).
9
- - `app.services`: background services expected during development — docker
10
- compose services, workers, queues, emulators — each with the command that
11
- starts it and its HTTP port when it has one (else null).
9
+ - `app.services`: supporting processes the project expects to be running
10
+ during development — databases, docker compose services, workers, queues,
11
+ emulators — each with the command that starts it and its HTTP port when it
12
+ has one (else null).
12
13
 
13
14
  Each service `name` is a unique machine identifier and must match
14
15
  `^[A-Za-z0-9._-]+$`. Use `atlas-local`, not `mongodb (Atlas local)`. The
@@ -32,8 +33,8 @@ app:
32
33
  - command: npm run dev
33
34
  description: Vite dev server on http://localhost:5173
34
35
  services:
35
- - name: redis
36
- command: docker compose -f docker-compose.dev.yml up -d redis
36
+ - name: worker
37
+ command: npm run worker
37
38
  httpPort: null
38
39
  ```
39
40
 
@@ -10,6 +10,12 @@ Ground rules:
10
10
 
11
11
  - Investigation is **read-only**. Do not write, create, modify, delete, or
12
12
  move any project files while investigating.
13
+ - Run setup commands yourself, using your normal tool approvals. Leave to the
14
+ user only the steps that need them, such as signing in, connecting accounts,
15
+ adding a key to a Git host, setup choices, and launch approval. `dvb` stores
16
+ sign-in and setup state in the user's home folder and connects to
17
+ boxes.dev, so a sandboxed shell may block it. If a command is blocked,
18
+ explain what prevented it from running.
13
19
  - Secret **values** never go in the manifest, in chat, or in any command
14
20
  output. Reference files and variable names only.
15
21
  - The user decides. Present findings, ask when evidence is ambiguous, and get
@@ -103,11 +109,21 @@ repository, every repository and top-level file inside it starts selected;
103
109
  keep only what belongs in the project in `project.repositories` and
104
110
  `project.rootEntries`.
105
111
 
112
+ The manifest and its staging folder live outside the project, in boxes.dev's
113
+ folder in the user's home directory, so setup doesn't add files to their
114
+ repositories. Editing them is part of setup, not a change to project files.
115
+ Your harness may ask the user to approve each read or edit outside the
116
+ project. Group related changes into a few edits, and avoid redundant reads
117
+ while you have the current contents. Reread the manifest when the user or
118
+ another process may have changed it.
119
+
106
120
  When the manifest uses managed GitHub access, `start` also checks whether
107
121
  boxes.dev can already use the project's GitHub repositories. If it reports a
108
- GitHub access problem, run `dvb agent-init github connect` before you
109
- investigate, so the user can finish on GitHub while you work. `check` verifies
110
- access again before launch.
122
+ GitHub access problem, follow its printed fix before you investigate, so the
123
+ user can finish on GitHub while you work. When the boxes.dev GitHub App can't
124
+ access a repository, ask the user to choose App access or SSH first (see
125
+ Phase 3), and run `dvb agent-init github connect` only if they choose App
126
+ access. `check` verifies access again before launch.
111
127
 
112
128
  Read any worktree, project-overlap, or skipped-repository explanations printed by `start`.
113
129
  Explain them to the user during review and confirm the intended project scope.
@@ -134,14 +150,21 @@ account, with high reasoning where supported.
134
150
 
135
151
  For GitHub repos, the manifest defaults to `githubAccess: managed` and keeps
136
152
  the seeded GitHub `gitSsh` rows in skip mode. If start or check says GitHub is
137
- not connected, or that the boxes.dev GitHub App can't access a repository, run
138
- `dvb agent-init github connect`, have the user finish in the browser, and then
139
- re-run check. Once GitHub is connected, that command opens GitHub and prints
140
- which account the user should choose. If an installation needs an update,
141
- follow the exact action printed by check.
142
- Set `githubAccess: ssh` and the GitHub `gitSsh` rows to setup only when the user
143
- chooses the SSH alternative. GitLab and other origins continue to use their
144
- seeded `gitSsh` entries.
153
+ not connected, run `dvb agent-init github connect`, have the user finish in the
154
+ browser, and then re-run check.
155
+
156
+ If the boxes.dev GitHub App can't access a repository, ask the user how the
157
+ project should pull and push. App access needs the App installed for the
158
+ repository's owner, and an organization owner may need to approve it. SSH uses
159
+ a key added to the user's own GitHub account. Either one covers pull and push;
160
+ automatic pull request updates and follow-ups need App access. With SSH, the
161
+ user can give the App access later for those features and keep SSH for pull
162
+ and push. For App access, run `dvb agent-init github connect`; it opens GitHub
163
+ and prints which account the user should choose. If an installation needs an
164
+ update, follow the exact action printed by check. Set `githubAccess: ssh` and
165
+ the GitHub `gitSsh` rows to setup only when the user chooses SSH, and keep the
166
+ user's choice when access changes later. GitLab and other origins continue to
167
+ use their seeded `gitSsh` entries.
145
168
 
146
169
  Separately, `dvb agent-init github cli status` shows whether boxes.dev will
147
170
  sign the `gh` command into the user's connected GitHub account on their boxes.
@@ -229,7 +252,8 @@ extra resources are idle; the choice also applies to future devboxes. Do not
229
252
  promise an in-place resize later.
230
253
 
231
254
  If your harness supports parallel subagents, fan out one investigator per
232
- section (each should read its section guide first). Otherwise investigate
255
+ section (each should read its section guide first and report its findings for
256
+ you to record in the manifest). Otherwise investigate
233
257
  serially — the order above works well.
234
258
 
235
259
  Replace each `TODO(agent)` marker with real findings, or an explicit empty
@@ -18,8 +18,10 @@ gitSsh:
18
18
  Managed access uses the user's existing boxes.dev GitHub connection for the
19
19
  Template box and future devboxes. If needed, run `dvb agent-init github
20
20
  connect`, let the user finish in the browser, and rerun `check`. When a repo
21
- is not covered by the boxes.dev GitHub App, the same command opens the
22
- GitHub page that grants access. Check prints the exact GitHub action when a
21
+ is not covered by the boxes.dev GitHub App, ask the user whether to give the
22
+ App access or use SSH. For App access, the same command opens the GitHub page
23
+ that grants access; an organization owner may need to approve it. Check
24
+ prints the exact GitHub action when a
23
25
  repo is not writable or an installation needs updated access. Do not put any returned URL, connection
24
26
  id, repository id, or token in the manifest. Managed access can push changes
25
27
  under `.github/workflows` after every affected installation accepts the shown
@@ -53,8 +55,11 @@ projects. If Cargo's built-in Git client cannot use the configured authenticatio
53
55
  set `CARGO_NET_GIT_FETCH_WITH_CLI=true` during remote setup to make Cargo use Git
54
56
  for fetching. See [Cargo's Git authentication guide](https://doc.rust-lang.org/cargo/appendix/git-authentication.html).
55
57
 
56
- Set `githubAccess: ssh` to use the key flow below for GitHub. Set `skip` to
57
- leave GitHub push/pull unconfigured. Use null only when the project has no
58
+ Set `githubAccess: ssh` to use the key flow below for GitHub. SSH pull and
59
+ push don't need the App, but automatic pull request updates and follow-ups do.
60
+ The user can give the App access later for those features without changing
61
+ Git transport.
62
+ Set `skip` to leave GitHub push/pull unconfigured. Use null only when the project has no
58
63
  standard GitHub origin. GitLab and other hosts always use `gitSsh`.
59
64
 
60
65
  `githubAccess` controls Git transport only. If `templateMaintenance.watches`
@@ -42,7 +42,8 @@ Named setup files keep their own selections. Two modes:
42
42
 
43
43
  - `mode: defaults` (recommended): include untracked files, minus
44
44
  well-known dependency/cache/build folders (node_modules, venvs, build
45
- output, caches). This matches what most users want.
45
+ output, caches) and Git worktrees inside the repository. This matches what
46
+ most users want. A worktree's branch still uploads with the Git history.
46
47
  - `mode: custom`: add include/exclude patterns. Use `base: defaults` to keep
47
48
  the normal exclusions, or `base: all` to start from all eligible files.
48
49
  Omitting `base` retains the older custom behavior: all eligible files.