@clipboard-health/groundcrew 4.10.2 → 4.10.4
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 +8 -6
- package/dist/commands/doctor.js +1 -1
- package/dist/commands/setupWorkspace.js +1 -1
- package/dist/commands/status.d.ts.map +1 -1
- package/dist/commands/status.js +14 -20
- package/dist/lib/config.d.ts.map +1 -1
- package/dist/lib/config.js +6 -10
- package/dist/lib/localRunner.js +1 -1
- package/dist/lib/pullRequests.d.ts +7 -2
- package/dist/lib/pullRequests.d.ts.map +1 -1
- package/dist/lib/pullRequests.js +7 -4
- package/dist/lib/util.d.ts.map +1 -1
- package/dist/lib/util.js +8 -1
- package/docs/configuration.md +3 -1
- package/docs/ticket-sources.md +26 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -20,10 +20,6 @@
|
|
|
20
20
|
<a href="./static/demo.tape"><img alt="Groundcrew dispatching tickets into tmux panes with coding agents running in parallel" src="./static/demo.gif" width="800"></a>
|
|
21
21
|
</p>
|
|
22
22
|
|
|
23
|
-
<p align="center">
|
|
24
|
-
VHS source: <a href="./static/demo.tape">static/demo.tape</a>.
|
|
25
|
-
</p>
|
|
26
|
-
|
|
27
23
|
Groundcrew watches assigned tickets, creates isolated worktrees, launches agent CLIs in dedicated terminals, and leaves each ticket's work on its own PR-ready branch. For the backstory, read _[Tickets to pull requests while you sleep](https://www.clipboardworks.com/resources/blog/tickets-to-pull-requests-while-you-sleep)_.
|
|
28
24
|
|
|
29
25
|
## Why
|
|
@@ -43,13 +39,13 @@ Groundcrew watches assigned tickets, creates isolated worktrees, launches agent
|
|
|
43
39
|
- **git:** e.g., `brew install git`, `apt install git`.
|
|
44
40
|
- **A terminal multiplexer:** [tmux](https://github.com/tmux/tmux/wiki/Installing) (cross-platform) or [cmux](https://cmux.com/) (macOS).
|
|
45
41
|
- **An agent CLI:** [Claude Code](https://code.claude.com/docs/en/quickstart) and/or [Codex](https://developers.openai.com/codex/quickstart?setup=cli).
|
|
46
|
-
- **A sandbox runner:** [Docker Sandboxes](https://docs.docker.com/sandboxes/) (cross-platform) or [Safehouse](https://agent-safehouse.dev/) on macOS. Skip only with `--runner none`.
|
|
42
|
+
- **A sandbox runner:** [Docker Sandboxes](https://docs.docker.com/ai/sandboxes/) (cross-platform) or [Safehouse](https://agent-safehouse.dev/) on macOS. Skip only with `--runner none`.
|
|
47
43
|
|
|
48
44
|
## Quickstart
|
|
49
45
|
|
|
50
46
|
```bash
|
|
51
47
|
# 1. Install groundcrew.
|
|
52
|
-
npm install -g @clipboard-health/groundcrew
|
|
48
|
+
npm install -g @clipboard-health/groundcrew@latest
|
|
53
49
|
|
|
54
50
|
# 2. Scaffold a global config. Agents are sandboxed by default
|
|
55
51
|
# (Safehouse/Docker Sandboxes); add --runner none to run unsandboxed on the host.
|
|
@@ -81,6 +77,12 @@ Groundcrew scans `workspace.knownRepositories` to infer which repo a ticket belo
|
|
|
81
77
|
|
|
82
78
|
A ticket blocked by non-terminal blockers is skipped until those blockers are done.
|
|
83
79
|
|
|
80
|
+
### The ticket description is the prompt
|
|
81
|
+
|
|
82
|
+
Groundcrew sends each agent a generic unattended-execution prompt plus the ticket title and description. The prompt says how to work: read the repo instructions, make the smallest sensible change, verify it, and produce the requested output. The ticket description says what to do.
|
|
83
|
+
|
|
84
|
+
Write tickets as complete agent instructions: the goal, the context and constraints, links to logs or screenshots, how to verify, and the output you want. A vague ticket gets a vague PR.
|
|
85
|
+
|
|
84
86
|
## Commands
|
|
85
87
|
|
|
86
88
|
```bash
|
package/dist/commands/doctor.js
CHANGED
|
@@ -244,7 +244,7 @@ function localCapabilityCheck(host, resolved) {
|
|
|
244
244
|
required: false,
|
|
245
245
|
hint: ok
|
|
246
246
|
? "ready"
|
|
247
|
-
: "sdx runner requires `sbx` (Docker Sandboxes) on PATH (install from https://docs.docker.com/sandboxes/)",
|
|
247
|
+
: "sdx runner requires `sbx` (Docker Sandboxes) on PATH (install from https://docs.docker.com/ai/sandboxes/)",
|
|
248
248
|
};
|
|
249
249
|
}
|
|
250
250
|
// resolved === "none"
|
|
@@ -178,7 +178,7 @@ function renderWorkspaceContinuationInstruction(accessHint) {
|
|
|
178
178
|
if (accessHint === undefined) {
|
|
179
179
|
return "";
|
|
180
180
|
}
|
|
181
|
-
return `
|
|
181
|
+
return `Include this workspace continuation note in the output: Workspace attach: \`${accessHint.command}\`.`;
|
|
182
182
|
}
|
|
183
183
|
function recordRunStateBestEffort(arguments_) {
|
|
184
184
|
try {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"status.d.ts","sourceRoot":"","sources":["../../src/commands/status.ts"],"names":[],"mappings":"AAIA,OAAO,EAAc,KAAK,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAanE,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;
|
|
1
|
+
{"version":3,"file":"status.d.ts","sourceRoot":"","sources":["../../src/commands/status.ts"],"names":[],"mappings":"AAIA,OAAO,EAAc,KAAK,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAanE,MAAM,WAAW,aAAa;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AA6mBD,wBAAsB,MAAM,CAAC,MAAM,EAAE,cAAc,EAAE,OAAO,GAAE,aAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAU/F;AAED,wBAAsB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAI7D"}
|
package/dist/commands/status.js
CHANGED
|
@@ -47,7 +47,7 @@ async function writeTicketWorktrees(config, ticket) {
|
|
|
47
47
|
});
|
|
48
48
|
// oxlint-disable-next-line no-await-in-loop -- one gh lookup per worktree is acceptable; multi-worktree-per-ticket is rare.
|
|
49
49
|
const prs = await findPullRequestsForBranch({
|
|
50
|
-
|
|
50
|
+
cwd: entry.dir,
|
|
51
51
|
branchName: entry.branchName,
|
|
52
52
|
});
|
|
53
53
|
writeOutput(`- ${entry.repository} ${entry.kind}`);
|
|
@@ -326,10 +326,10 @@ async function writeInventoryWorktrees(config, probe) {
|
|
|
326
326
|
}
|
|
327
327
|
const runState = runStates.get(entry.ticket);
|
|
328
328
|
const accessHint = accessHints.get(entry.ticket);
|
|
329
|
-
// `collectPullRequests` guarantees an entry for every
|
|
330
|
-
//
|
|
329
|
+
// `collectPullRequests` guarantees an entry for every worktree dir seen
|
|
330
|
+
// in `entries`; the lookup always returns the array.
|
|
331
331
|
/* v8 ignore next @preserve -- defensive fallback for a Map key that collectPullRequests always populates */
|
|
332
|
-
const prs = pullRequests.get(
|
|
332
|
+
const prs = pullRequests.get(entry.dir) ?? [];
|
|
333
333
|
if (index > 0) {
|
|
334
334
|
writeOutput();
|
|
335
335
|
}
|
|
@@ -352,9 +352,6 @@ async function writeInventoryWorktrees(config, probe) {
|
|
|
352
352
|
}
|
|
353
353
|
}
|
|
354
354
|
}
|
|
355
|
-
function pullRequestKey(repository, branchName) {
|
|
356
|
-
return `${repository} ${branchName}`;
|
|
357
|
-
}
|
|
358
355
|
async function collectAccessHints(config, entries) {
|
|
359
356
|
const uniqueTickets = [...new Set(entries.map((entry) => entry.ticket))];
|
|
360
357
|
const results = await Promise.allSettled(uniqueTickets.map(async (ticket) => await workspaces.accessHint(config, ticket)));
|
|
@@ -364,23 +361,20 @@ async function collectAccessHints(config, entries) {
|
|
|
364
361
|
}));
|
|
365
362
|
}
|
|
366
363
|
async function collectPullRequests(entries) {
|
|
367
|
-
//
|
|
368
|
-
//
|
|
369
|
-
//
|
|
370
|
-
const
|
|
364
|
+
// Each worktree dir is unique, so keying by dir collapses nothing in
|
|
365
|
+
// practice; the Map removes duplicates defensively if the same dir
|
|
366
|
+
// appears twice.
|
|
367
|
+
const uniqueByDir = new Map();
|
|
371
368
|
for (const entry of entries) {
|
|
372
|
-
|
|
373
|
-
repository: entry.repository,
|
|
374
|
-
branchName: entry.branchName,
|
|
375
|
-
});
|
|
369
|
+
uniqueByDir.set(entry.dir, { dir: entry.dir, branchName: entry.branchName });
|
|
376
370
|
}
|
|
377
|
-
const results = await Promise.allSettled([...
|
|
378
|
-
const prs = await findPullRequestsForBranch({
|
|
379
|
-
return [
|
|
371
|
+
const results = await Promise.allSettled([...uniqueByDir.entries()].map(async ([dir, { branchName }]) => {
|
|
372
|
+
const prs = await findPullRequestsForBranch({ cwd: dir, branchName });
|
|
373
|
+
return [dir, prs];
|
|
380
374
|
}));
|
|
381
|
-
return new Map([...
|
|
375
|
+
return new Map([...uniqueByDir.keys()].map((dir, index) => {
|
|
382
376
|
const result = results[index];
|
|
383
|
-
return [
|
|
377
|
+
return [dir, result?.status === "fulfilled" ? result.value[1] : []];
|
|
384
378
|
}));
|
|
385
379
|
}
|
|
386
380
|
function writeStraySessions(probe, worktreeTickets) {
|
package/dist/lib/config.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/lib/config.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AACvE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAMrE,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAEvD;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,mBAAmB,GAAG,kBAAkB,CAAC;AAEpE,MAAM,WAAW,YAAY;IAC3B,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;;;;GAKG;AACH,eAAO,MAAM,eAAe,QAAQ,CAAC;AAErC;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAE5D,eAAO,MAAM,uBAAuB,EAAE,SAAS,oBAAoB,EAIzD,CAAC;AAEX;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GAAG,WAAW,GAAG,KAAK,GAAG,MAAM,CAAC;AAEvD;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,WAAW,GAAG,MAAM,CAAC;AAEtD,eAAO,MAAM,qBAAqB,EAAE,SAAS,kBAAkB,EAKrD,CAAC;AAEX;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,+CAA+C;IAC/C,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,eAAe;IAC9B;;;;;;;OAOG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE;QACN,QAAQ,EAAE;YAAE,QAAQ,EAAE,MAAM,CAAC;YAAC,MAAM,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;KACjD,CAAC;IACF;;;;OAIG;IACH,OAAO,CAAC,EAAE,iBAAiB,CAAC;CAC7B;AAED;;;;;;;;GAQG;AACH,KAAK,SAAS,GAAG,eAAe,CAAC,OAAO,CAAC,GAAG;IAAE,QAAQ,EAAE,IAAI,CAAA;CAAE,CAAC;AAC/D,KAAK,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,GAAG;IAC1E,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB,CAAC;AACF,KAAK,mBAAmB,GAAG,0BAA0B,CAAC;AAEtD;;;;;;;;;GASG;AACH,MAAM,WAAW,MAAM;IACrB;;;;;;;;;OASG;IACH,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB,GAAG,CAAC,EAAE;QACJ,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IACF,SAAS,EAAE;QACT,UAAU,EAAE,MAAM,CAAC;QACnB,iBAAiB,EAAE,MAAM,EAAE,CAAC;KAC7B,CAAC;IACF,QAAQ,CAAC,EAAE;QACT,KAAK,CAAC,EAAE,YAAY,CAAC;KACtB,CAAC;IACF,YAAY,CAAC,EAAE;QACb,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,wBAAwB,CAAC,EAAE,MAAM,CAAC;QAClC,sBAAsB,CAAC,EAAE,MAAM,CAAC;KACjC,CAAC;IACF,MAAM,CAAC,EAAE;QACP,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB;;;;;WAKG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;KACnD,CAAC;IACF,OAAO,CAAC,EAAE;QACR,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF;;;;OAIG;IACH,aAAa,CAAC,EAAE,oBAAoB,CAAC;IACrC;;;;OAIG;IACH,KAAK,CAAC,EAAE;QACN,MAAM,CAAC,EAAE,kBAAkB,CAAC;KAC7B,CAAC;IACF,OAAO,CAAC,EAAE;QACR;;;;;WAKG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;OAKG;IACH,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,GAAG,EAAE;QACH,MAAM,EAAE,MAAM,CAAC;QACf,aAAa,EAAE,MAAM,CAAC;KACvB,CAAC;IACF,SAAS,EAAE;QACT,UAAU,EAAE,MAAM,CAAC;QACnB,iBAAiB,EAAE,MAAM,EAAE,CAAC;KAC7B,CAAC;IACF,QAAQ,EAAE;QACR,KAAK,EAAE,YAAY,CAAC;KACrB,CAAC;IACF,YAAY,EAAE;QACZ,iBAAiB,EAAE,MAAM,CAAC;QAC1B,wBAAwB,EAAE,MAAM,CAAC;QACjC,sBAAsB,EAAE,MAAM,CAAC;KAChC,CAAC;IACF,MAAM,EAAE;QACN,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;KAC9C,CAAC;IACF,OAAO,EAAE;QACP,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF;;;OAGG;IACH,aAAa,EAAE,oBAAoB,CAAC;IACpC;;;;OAIG;IACH,KAAK,EAAE;QACL,MAAM,EAAE,kBAAkB,CAAC;KAC5B,CAAC;IACF,OAAO,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED,MAAM,MAAM,gBAAgB,GAAG,KAAK,GAAG,SAAS,GAAG,KAAK,CAAC;AAEzD,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,gBAAgB,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;IACjC,MAAM,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;CAChC;
|
|
1
|
+
{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/lib/config.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;AACvE,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAC;AAMrE,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAEvD;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,mBAAmB,GAAG,kBAAkB,CAAC;AAEpE,MAAM,WAAW,YAAY;IAC3B,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;;;;GAKG;AACH,eAAO,MAAM,eAAe,QAAQ,CAAC;AAErC;;;;;;GAMG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC;AAE5D,eAAO,MAAM,uBAAuB,EAAE,SAAS,oBAAoB,EAIzD,CAAC;AAEX;;;;;;GAMG;AACH,MAAM,MAAM,WAAW,GAAG,WAAW,GAAG,KAAK,GAAG,MAAM,CAAC;AAEvD;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,WAAW,GAAG,MAAM,CAAC;AAEtD,eAAO,MAAM,qBAAqB,EAAE,SAAS,kBAAkB,EAKrD,CAAC;AAEX;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,+CAA+C;IAC/C,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,eAAe;IAC9B;;;;;;;OAOG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE;QACN,QAAQ,EAAE;YAAE,QAAQ,EAAE,MAAM,CAAC;YAAC,MAAM,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;KACjD,CAAC;IACF;;;;OAIG;IACH,OAAO,CAAC,EAAE,iBAAiB,CAAC;CAC7B;AAED;;;;;;;;GAQG;AACH,KAAK,SAAS,GAAG,eAAe,CAAC,OAAO,CAAC,GAAG;IAAE,QAAQ,EAAE,IAAI,CAAA;CAAE,CAAC;AAC/D,KAAK,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC,GAAG;IAC1E,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB,CAAC;AACF,KAAK,mBAAmB,GAAG,0BAA0B,CAAC;AAEtD;;;;;;;;;GASG;AACH,MAAM,WAAW,MAAM;IACrB;;;;;;;;;OASG;IACH,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB,GAAG,CAAC,EAAE;QACJ,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;IACF,SAAS,EAAE;QACT,UAAU,EAAE,MAAM,CAAC;QACnB,iBAAiB,EAAE,MAAM,EAAE,CAAC;KAC7B,CAAC;IACF,QAAQ,CAAC,EAAE;QACT,KAAK,CAAC,EAAE,YAAY,CAAC;KACtB,CAAC;IACF,YAAY,CAAC,EAAE;QACb,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,wBAAwB,CAAC,EAAE,MAAM,CAAC;QAClC,sBAAsB,CAAC,EAAE,MAAM,CAAC;KACjC,CAAC;IACF,MAAM,CAAC,EAAE;QACP,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB;;;;;WAKG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;KACnD,CAAC;IACF,OAAO,CAAC,EAAE;QACR,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF;;;;OAIG;IACH,aAAa,CAAC,EAAE,oBAAoB,CAAC;IACrC;;;;OAIG;IACH,KAAK,CAAC,EAAE;QACN,MAAM,CAAC,EAAE,kBAAkB,CAAC;KAC7B,CAAC;IACF,OAAO,CAAC,EAAE;QACR;;;;;WAKG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;OAKG;IACH,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,GAAG,EAAE;QACH,MAAM,EAAE,MAAM,CAAC;QACf,aAAa,EAAE,MAAM,CAAC;KACvB,CAAC;IACF,SAAS,EAAE;QACT,UAAU,EAAE,MAAM,CAAC;QACnB,iBAAiB,EAAE,MAAM,EAAE,CAAC;KAC7B,CAAC;IACF,QAAQ,EAAE;QACR,KAAK,EAAE,YAAY,CAAC;KACrB,CAAC;IACF,YAAY,EAAE;QACZ,iBAAiB,EAAE,MAAM,CAAC;QAC1B,wBAAwB,EAAE,MAAM,CAAC;QACjC,sBAAsB,EAAE,MAAM,CAAC;KAChC,CAAC;IACF,MAAM,EAAE;QACN,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;KAC9C,CAAC;IACF,OAAO,EAAE;QACP,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF;;;OAGG;IACH,aAAa,EAAE,oBAAoB,CAAC;IACpC;;;;OAIG;IACH,KAAK,EAAE;QACL,MAAM,EAAE,kBAAkB,CAAC;KAC5B,CAAC;IACF,OAAO,EAAE;QACP,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;CACH;AAED,MAAM,MAAM,gBAAgB,GAAG,KAAK,GAAG,SAAS,GAAG,KAAK,CAAC;AAEzD,MAAM,WAAW,YAAY;IAC3B,IAAI,EAAE,gBAAgB,CAAC;IACvB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B,MAAM,EAAE,QAAQ,CAAC,cAAc,CAAC,CAAC;IACjC,MAAM,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAC;CAChC;AAuMD;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,UAAU,EAAE,IAAI,CAAC,eAAe,EAAE,cAAc,CAAC,GAAG,OAAO,CAE1F;AA6FD;;;;GAIG;AACH,wBAAgB,wBAAwB,CACtC,MAAM,EAAE,IAAI,CAAC,cAAc,EAAE,QAAQ,CAAC,EACtC,IAAI,EAAE,MAAM,GACX,OAAO,CAKT;AAqbD,wBAAsB,oBAAoB,IAAI,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CA2B5E;AAED,wBAAsB,UAAU,IAAI,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC,CAGpE"}
|
package/dist/lib/config.js
CHANGED
|
@@ -72,7 +72,7 @@ const MODEL_DEFINITIONS_MIGRATION_MESSAGE = [
|
|
|
72
72
|
"`disabled: true` is no longer supported; remove disabled model entries instead.",
|
|
73
73
|
].join("\n");
|
|
74
74
|
const DEFAULT_PROMPT_INITIAL = [
|
|
75
|
-
"You are working on
|
|
75
|
+
"You are working on ticket {{ticket}} ({{title}}) in the {{worktree}} worktree subdirectory.",
|
|
76
76
|
"",
|
|
77
77
|
"Ticket description:",
|
|
78
78
|
"",
|
|
@@ -80,19 +80,15 @@ const DEFAULT_PROMPT_INITIAL = [
|
|
|
80
80
|
"",
|
|
81
81
|
"## Operating mode",
|
|
82
82
|
"",
|
|
83
|
-
"There is no human watching this session. Do not stop to ask clarifying questions. When the ticket is ambiguous or incomplete, choose the simplest reasonable interpretation consistent with the ticket and the codebase, then document that choice in the
|
|
83
|
+
"There is no human watching this session. Do not stop to ask clarifying questions. When the ticket is ambiguous or incomplete, choose the simplest reasonable interpretation consistent with the ticket and the codebase, then document that choice in the output.",
|
|
84
|
+
"{{workspaceContinuationInstruction}}",
|
|
84
85
|
"",
|
|
85
86
|
"## Workflow",
|
|
86
87
|
"",
|
|
87
|
-
"1. Inspect the
|
|
88
|
+
"1. Inspect the repo instructions and existing patterns before edits.",
|
|
88
89
|
"2. Implement the smallest sensible change that completes the ticket.",
|
|
89
|
-
"3. Run the
|
|
90
|
-
"4.
|
|
91
|
-
"5. If this repository uses GitHub and the `gh` CLI is available and authenticated, open a pull request. If you cannot open one, leave the branch ready and record the blocker.",
|
|
92
|
-
"6. Include `Closes {{ticket}}` in the PR description.",
|
|
93
|
-
"{{workspaceContinuationInstruction}}",
|
|
94
|
-
"",
|
|
95
|
-
"Stop after the branch is ready or the PR is open.",
|
|
90
|
+
"3. Run the repo's documented verification command. If no documented command exists, run the smallest relevant test suite you can find and fix failures you introduced before continuing.",
|
|
91
|
+
"4. Follow the ticket description for output. If no output instructions exist, open a PR with `Closes {{ticket}}` in the description. If you cannot open one, leave the branch ready and record the blocker.",
|
|
96
92
|
].join("\n");
|
|
97
93
|
const ALLOWED_PROMPT_PLACEHOLDERS = new Set([
|
|
98
94
|
"{{ticket}}",
|
package/dist/lib/localRunner.js
CHANGED
|
@@ -42,7 +42,7 @@ export function assertLocalRunnerRequirements(host, runner) {
|
|
|
42
42
|
throw new Error("Local groundcrew runs with the sdx runner require macOS or Linux.");
|
|
43
43
|
}
|
|
44
44
|
if (!host.hasSbx) {
|
|
45
|
-
throw new Error("Local groundcrew runs with the sdx runner require `sbx` (Docker Sandboxes) on PATH. Install from https://docs.docker.com/sandboxes/ and retry.");
|
|
45
|
+
throw new Error("Local groundcrew runs with the sdx runner require `sbx` (Docker Sandboxes) on PATH. Install from https://docs.docker.com/ai/sandboxes/ and retry.");
|
|
46
46
|
}
|
|
47
47
|
return;
|
|
48
48
|
}
|
|
@@ -3,6 +3,11 @@
|
|
|
3
3
|
* `gh` CLI. `crew status` uses this to surface PR links inline; failures
|
|
4
4
|
* (gh not on PATH, not authenticated, non-GitHub remote) are silent — the
|
|
5
5
|
* caller falls back to omitting the row.
|
|
6
|
+
*
|
|
7
|
+
* The lookup runs with `cwd` set to the worktree directory and lets `gh`
|
|
8
|
+
* resolve the GitHub repo from that checkout's own `origin` remote. This
|
|
9
|
+
* handles bare config names, full `owner/repo` slugs, forks, and SSH/HTTPS
|
|
10
|
+
* remotes uniformly — we never reconstruct the slug ourselves.
|
|
6
11
|
*/
|
|
7
12
|
export interface PullRequestSummary {
|
|
8
13
|
url: string;
|
|
@@ -12,8 +17,8 @@ export interface PullRequestSummary {
|
|
|
12
17
|
title: string;
|
|
13
18
|
}
|
|
14
19
|
interface LookupArgs {
|
|
15
|
-
/**
|
|
16
|
-
|
|
20
|
+
/** Worktree directory; `gh` resolves the GitHub repo from its git remote. */
|
|
21
|
+
cwd: string;
|
|
17
22
|
/** Branch name to filter PRs by. */
|
|
18
23
|
branchName: string;
|
|
19
24
|
signal?: AbortSignal;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pullRequests.d.ts","sourceRoot":"","sources":["../../src/lib/pullRequests.ts"],"names":[],"mappings":"AAAA
|
|
1
|
+
{"version":3,"file":"pullRequests.d.ts","sourceRoot":"","sources":["../../src/lib/pullRequests.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAIH,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,0DAA0D;IAC1D,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AASD,UAAU,UAAU;IAClB,6EAA6E;IAC7E,GAAG,EAAE,MAAM,CAAC;IACZ,oCAAoC;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAgDD,wBAAsB,yBAAyB,CAC7C,UAAU,EAAE,UAAU,GACrB,OAAO,CAAC,SAAS,kBAAkB,EAAE,CAAC,CAyBxC"}
|
package/dist/lib/pullRequests.js
CHANGED
|
@@ -3,6 +3,11 @@
|
|
|
3
3
|
* `gh` CLI. `crew status` uses this to surface PR links inline; failures
|
|
4
4
|
* (gh not on PATH, not authenticated, non-GitHub remote) are silent — the
|
|
5
5
|
* caller falls back to omitting the row.
|
|
6
|
+
*
|
|
7
|
+
* The lookup runs with `cwd` set to the worktree directory and lets `gh`
|
|
8
|
+
* resolve the GitHub repo from that checkout's own `origin` remote. This
|
|
9
|
+
* handles bare config names, full `owner/repo` slugs, forks, and SSH/HTTPS
|
|
10
|
+
* remotes uniformly — we never reconstruct the slug ourselves.
|
|
6
11
|
*/
|
|
7
12
|
import { runCommandAsync } from "./commandRunner.js";
|
|
8
13
|
const GH_PR_LIST_LIMIT = 5;
|
|
@@ -48,13 +53,11 @@ function isRawPullRequest(value) {
|
|
|
48
53
|
typeof record["title"] === "string");
|
|
49
54
|
}
|
|
50
55
|
export async function findPullRequestsForBranch(arguments_) {
|
|
51
|
-
const {
|
|
56
|
+
const { cwd, branchName, signal } = arguments_;
|
|
52
57
|
try {
|
|
53
58
|
const output = await runCommandAsync("gh", [
|
|
54
59
|
"pr",
|
|
55
60
|
"list",
|
|
56
|
-
"--repo",
|
|
57
|
-
repository,
|
|
58
61
|
"--head",
|
|
59
62
|
branchName,
|
|
60
63
|
"--state",
|
|
@@ -63,7 +66,7 @@ export async function findPullRequestsForBranch(arguments_) {
|
|
|
63
66
|
String(GH_PR_LIST_LIMIT),
|
|
64
67
|
"--json",
|
|
65
68
|
"url,number,state,title",
|
|
66
|
-
], signal === undefined ? {} : { signal });
|
|
69
|
+
], signal === undefined ? { cwd } : { cwd, signal });
|
|
67
70
|
return parsePullRequests(output);
|
|
68
71
|
}
|
|
69
72
|
catch {
|
package/dist/lib/util.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../src/lib/util.ts"],"names":[],"mappings":"AAIA,wBAAsB,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAoB3E;AAED,wBAAgB,WAAW,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAIlD;AAED,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAGhD;AAQD,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,CAE/C;AAED,wBAAgB,SAAS,IAAI,OAAO,CAEnC;AAWD,wBAAgB,MAAM,IAAI,MAAM,CAE/B;AAED,wBAAgB,QAAQ,IAAI,MAAM,CAEjC;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEjD;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE7C;AAQD,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAE7D;AAED,wBAAsB,uBAAuB,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAOxF;
|
|
1
|
+
{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../../src/lib/util.ts"],"names":[],"mappings":"AAIA,wBAAsB,KAAK,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAoB3E;AAED,wBAAgB,WAAW,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAIlD;AAED,wBAAgB,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAGhD;AAQD,wBAAgB,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI,CAE/C;AAED,wBAAgB,SAAS,IAAI,OAAO,CAEnC;AAWD,wBAAgB,MAAM,IAAI,MAAM,CAE/B;AAED,wBAAgB,QAAQ,IAAI,MAAM,CAEjC;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAEjD;AAED,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE7C;AAQD,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,CAE7D;AAED,wBAAsB,uBAAuB,CAAC,CAAC,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAOxF;AA8BD,iFAAiF;AACjF,wBAAgB,GAAG,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAOzC;AAED;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAS3C;AAED,KAAK,kBAAkB,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,SAAS,MAAM,EAAE,GAAG,SAAS,CAAC;AAUpF,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,GAAG,IAAI,CAiBxF;AAED,wBAAgB,uBAAuB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAGxE;AAED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,CAMzF;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,OAAO,CAAC;IAChB,WAAW,EAAE,MAAM,EAAE,CAAC;CACvB;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,iBAAiB,CAcvF;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAcnD"}
|
package/dist/lib/util.js
CHANGED
|
@@ -91,7 +91,14 @@ function appendLogLine(line) {
|
|
|
91
91
|
}
|
|
92
92
|
}
|
|
93
93
|
function timestamped(message) {
|
|
94
|
-
|
|
94
|
+
// 24-hour, zero-padded fields so stacked log lines align on the colons
|
|
95
|
+
// (e.g. `13:00:16`, not `1:00:16 PM`).
|
|
96
|
+
const timestamp = new Date().toLocaleTimeString(undefined, {
|
|
97
|
+
hour12: false,
|
|
98
|
+
hour: "2-digit",
|
|
99
|
+
minute: "2-digit",
|
|
100
|
+
second: "2-digit",
|
|
101
|
+
});
|
|
95
102
|
return { plain: `[${timestamp}] ${message}`, timestamp };
|
|
96
103
|
}
|
|
97
104
|
/** Important tier: always on the console (dimmed timestamp) and the log file. */
|
package/docs/configuration.md
CHANGED
|
@@ -91,6 +91,8 @@ Rules:
|
|
|
91
91
|
|
|
92
92
|
Groundcrew ships one model-agnostic unattended prompt by default. It tells the agent to make reasonable assumptions, follow repository instructions, run documented verification, review its diff, open a PR when GitHub/`gh` is available, and include a workspace continuation hint when known.
|
|
93
93
|
|
|
94
|
+
This prompt describes how the agent works, not what it does. The task is the ticket description, which groundcrew passes through unchanged. Keep source-specific instructions, acceptance criteria, links, and output requirements in the ticket body. Override `prompts.initial` only to change the execution contract for every dispatched ticket — team-wide review rules, required verification, local tool conventions — not to encode behavior for a single ticket type.
|
|
95
|
+
|
|
94
96
|
For a personal workflow, keep the prompt next to your local config and load it with `readFileSync`:
|
|
95
97
|
|
|
96
98
|
```ts
|
|
@@ -145,7 +147,7 @@ and hook contract.
|
|
|
145
147
|
| `models.definitions.<name>.sandbox` | optional | Docker Sandboxes binding for the model. Required at launch when `local.runner` resolves to `sdx`. Field: `agent` (required sbx agent name). Groundcrew assumes the `groundcrew-<agent>` sandbox already exists. |
|
|
146
148
|
| `models.definitions.<name>.preLaunch` | optional | Host-only shell snippet run before the agent exec and outside Safehouse/sdx. Exports survive into the launch shell; under the default `safehouse` runner they are only forwarded to the agent when listed via `preLaunchEnv` or when `cmd` includes its own `safehouse --env-pass=NAMES`. `{{worktree}}` is substituted. A non-zero exit aborts launch. Not supported when `local.runner` resolves to `sdx` in v1. |
|
|
147
149
|
| `models.definitions.<name>.preLaunchEnv` | optional | Companion to `preLaunch`: list of env var names to append to groundcrew's `safehouse-clearance` `--env-pass=` flag, so `preLaunch` exports reach the agent without overriding `cmd` and losing the project's egress allowlist. Each entry must match `[A-Za-z_][A-Za-z0-9_]*`. Under `runner: "none"` exports already inherit and `preLaunchEnv` is a no-op. An empty array is a uniform no-op in every runner; a non-empty list is rejected when `cmd` already starts with `safehouse` or when `runner` resolves to `sdx`. |
|
|
148
|
-
| `prompts.initial` | unattended template | First message sent to the agent. Placeholders: `{{ticket}}`, `{{worktree}}`, `{{title}}`, `{{description}}`. Override
|
|
150
|
+
| `prompts.initial` | unattended template | First message sent to the agent: the execution wrapper around each ticket. The ticket description is the task-specific prompt. Placeholders: `{{ticket}}`, `{{worktree}}`, `{{title}}`, `{{description}}`. Override only to change the execution contract for every ticket, such as team-wide review rules or tool conventions. |
|
|
149
151
|
| `workspaceKind` | `"auto"` | Terminal session manager. `"auto"` picks `cmux` when on PATH, else `tmux`. Set to `"cmux"` or `"tmux"` to fail loudly when the chosen backend is missing. |
|
|
150
152
|
| `local.runner` | `"auto"` | Local isolation backend. `"auto"` uses `safehouse` on macOS and `sdx` on Linux/WSL. Explicit: `"safehouse"`, `"sdx"`, `"none"`. `"none"` is never picked implicitly. |
|
|
151
153
|
| `logging.file` | XDG state path | Append-mode log file. `log()` / `logEvent()` tee here in addition to stdout. Defaults to `${XDG_STATE_HOME:-$HOME/.local/state}/groundcrew/groundcrew.log`. |
|
package/docs/ticket-sources.md
CHANGED
|
@@ -43,3 +43,29 @@ export default {
|
|
|
43
43
|
```
|
|
44
44
|
|
|
45
45
|
Allowed `status` values are `todo`, `in-progress`, `in-review`, `done`, and `other`. Use `null` for `repository` or `model` when a ticket should not be groundcrew-eligible. `hasMoreBlockers` is optional and defaults to `false`; `sourceRef` is opaque data that groundcrew passes back to your writeback command.
|
|
46
|
+
|
|
47
|
+
## The `description` is the agent's prompt
|
|
48
|
+
|
|
49
|
+
Groundcrew wraps each issue's `description` in its generic unattended-execution prompt and hands it to the agent as the task. It does not pick a different prompt per source or ticket type. Specialized behavior belongs in the `description` your adapter emits, not in groundcrew.
|
|
50
|
+
|
|
51
|
+
So the adapter classifies, enriches, dedupes, and builds the description; groundcrew runs the result. A Datadog flaky-test source emits a description that says how to classify the flake, where the logs are, and what counts as success. A GitHub CI-failure source emits the PR link, the failing workflow, the logs, and whether to open a PR or leave a comment.
|
|
52
|
+
|
|
53
|
+
Example `description` for a CI-failure source:
|
|
54
|
+
|
|
55
|
+
```text
|
|
56
|
+
Investigate the failed CI run for this pull request.
|
|
57
|
+
|
|
58
|
+
Repository: your-org/your-repo
|
|
59
|
+
Pull request: https://github.com/your-org/your-repo/pull/123
|
|
60
|
+
Failing workflow: backend-tests
|
|
61
|
+
Logs: https://...
|
|
62
|
+
|
|
63
|
+
Goal:
|
|
64
|
+
- Decide whether this is a real regression, a flaky test, or an infra issue.
|
|
65
|
+
- If it is a real regression, make the smallest fix.
|
|
66
|
+
- If it is flaky, follow the repo's flaky-test triage pattern.
|
|
67
|
+
- If no code change is right, record that conclusion.
|
|
68
|
+
|
|
69
|
+
Output:
|
|
70
|
+
- Open a PR if a code change is needed; otherwise leave the branch clean and record the conclusion.
|
|
71
|
+
```
|
package/package.json
CHANGED