runwork 0.10.2 → 0.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.
Files changed (49) hide show
  1. package/dist/agents/__tests__/claude-code-stats.test.js +1 -0
  2. package/dist/agents/claude-code.js +1 -1
  3. package/dist/agents/cursor.js +1 -1
  4. package/dist/commands/clone.js +1 -1
  5. package/dist/commands/deploy.js +1 -1
  6. package/dist/commands/dev.d.ts +3 -0
  7. package/dist/commands/dev.js +628 -11
  8. package/dist/commands/info.d.ts +31 -0
  9. package/dist/commands/info.js +37 -0
  10. package/dist/commands/init.js +1 -1
  11. package/dist/dev/__tests__/attach.test.d.ts +1 -0
  12. package/dist/dev/__tests__/attach.test.js +296 -0
  13. package/dist/dev/__tests__/detach.test.d.ts +1 -0
  14. package/dist/dev/__tests__/detach.test.js +404 -0
  15. package/dist/dev/__tests__/preview-url-poller.test.d.ts +1 -0
  16. package/dist/dev/__tests__/preview-url-poller.test.js +149 -0
  17. package/dist/dev/__tests__/session.test.d.ts +1 -0
  18. package/dist/dev/__tests__/session.test.js +347 -0
  19. package/dist/dev/__tests__/stop.test.d.ts +1 -0
  20. package/dist/dev/__tests__/stop.test.js +172 -0
  21. package/dist/dev/attach.d.ts +120 -0
  22. package/dist/dev/attach.js +269 -0
  23. package/dist/dev/detach.d.ts +187 -0
  24. package/dist/dev/detach.js +292 -0
  25. package/dist/dev/preview-url-poller.d.ts +35 -0
  26. package/dist/dev/preview-url-poller.js +50 -0
  27. package/dist/dev/session.d.ts +158 -0
  28. package/dist/dev/session.js +252 -0
  29. package/dist/dev/stop.d.ts +52 -0
  30. package/dist/dev/stop.js +101 -0
  31. package/dist/generated/version.d.ts +1 -1
  32. package/dist/generated/version.js +1 -1
  33. package/dist/git/__tests__/credentials.test.js +1 -1
  34. package/dist/git/auto-commit.js +1 -1
  35. package/dist/git/credentials.js +1 -1
  36. package/dist/git/identity.js +1 -1
  37. package/dist/git/preflight.js +1 -1
  38. package/dist/git/sync.js +1 -1
  39. package/dist/health/checks.js +1 -1
  40. package/dist/template/manifest.js +1 -1
  41. package/dist/ui/__tests__/keyboard.test.js +4 -0
  42. package/dist/ui/keyboard.d.ts +1 -1
  43. package/dist/ui/keyboard.js +4 -0
  44. package/dist/utils/agent-guidance.d.ts +13 -0
  45. package/dist/utils/agent-guidance.js +22 -7
  46. package/dist/utils/subprocess.d.ts +19 -0
  47. package/dist/utils/subprocess.js +27 -0
  48. package/dist/utils/which.js +1 -1
  49. package/package.json +1 -1
@@ -0,0 +1,252 @@
1
+ /**
2
+ * Per-app `runwork dev` session lifecycle primitives.
3
+ *
4
+ * The session file at `<app-dir>/.runwork/dev-session.json` is the durable
5
+ * truth about whether a dev session is running for the current app, on the
6
+ * current machine. Every dev-related command reads from it, writes to it,
7
+ * or treats it as the IPC channel during detach.
8
+ *
9
+ * This module is intentionally pure: it does not start, stop, or signal
10
+ * processes. It only reads/writes the file and reports whether what it
11
+ * finds is alive, stale, or absent. Callers (dev.ts, dev stop, etc.) act
12
+ * on that information.
13
+ *
14
+ * See `docs/plans/2026-05-06-runwork-dev-lifecycle-design.md` for the full
15
+ * lifecycle contract.
16
+ */
17
+ import * as fs from 'fs';
18
+ import * as os from 'os';
19
+ import * as path from 'path';
20
+ export const SESSION_FILE_SCHEMA_VERSION = 1;
21
+ /**
22
+ * Tolerance (ms) when comparing the stored bootTime to the currently
23
+ * computed one. NTP corrections can shift `Date.now()` by a few seconds
24
+ * relative to `os.uptime()`. A reboot is always orders of magnitude
25
+ * larger than this tolerance.
26
+ */
27
+ export const BOOT_TIME_TOLERANCE_MS = 60_000;
28
+ const realDeps = {
29
+ bootTime: currentBootTime,
30
+ pidAlive: isPidAlive,
31
+ };
32
+ /**
33
+ * Resolve a `SessionDeps` against the real defaults, ignoring any
34
+ * `undefined` values in the caller-supplied object. Spreading
35
+ * `{ ...realDeps, ...deps }` directly would let `{ bootTime: undefined }`
36
+ * overwrite the real default with `undefined`, which then crashes when we
37
+ * try to call it. This helper keeps the defaults intact.
38
+ */
39
+ function resolveDeps(deps) {
40
+ if (!deps)
41
+ return realDeps;
42
+ return {
43
+ bootTime: deps.bootTime ?? realDeps.bootTime,
44
+ pidAlive: deps.pidAlive ?? realDeps.pidAlive,
45
+ };
46
+ }
47
+ export function getSessionPaths(appDir) {
48
+ const dir = path.join(appDir, '.runwork');
49
+ return {
50
+ dir,
51
+ file: path.join(dir, 'dev-session.json'),
52
+ tmpFile: path.join(dir, 'dev-session.json.tmp'),
53
+ stdoutLog: path.join(dir, 'dev-stdout.log'),
54
+ stderrLog: path.join(dir, 'dev-stderr.log'),
55
+ };
56
+ }
57
+ /**
58
+ * System boot timestamp in ms. Computed purely from Node's `os.uptime()`
59
+ * (monotonic seconds since boot, available on every platform Node runs
60
+ * on) and the wall clock. No spawning, no native modules.
61
+ *
62
+ * Drift between `Date.now()` and `os.uptime()` from NTP corrections is
63
+ * absorbed by `BOOT_TIME_TOLERANCE_MS` at the comparison site.
64
+ */
65
+ export function currentBootTime() {
66
+ return Date.now() - os.uptime() * 1000;
67
+ }
68
+ export function isBootTimeStale(stored, deps = {}) {
69
+ const d = resolveDeps(deps);
70
+ return Math.abs(d.bootTime() - stored) > BOOT_TIME_TOLERANCE_MS;
71
+ }
72
+ /**
73
+ * Cross-platform PID liveness probe.
74
+ *
75
+ * - Unix: `process.kill(pid, 0)` is signal-zero, a permissions+existence
76
+ * probe. ESRCH for dead, EPERM for "alive but not ours."
77
+ * - Windows: Node maps signal 0 to `OpenProcess(PROCESS_QUERY_LIMITED_-`
78
+ * `INFORMATION)`. Returns success iff the PID exists and the caller
79
+ * has rights, throws otherwise.
80
+ *
81
+ * On any error we return `false`. EPERM in particular ("alive but
82
+ * unprivileged") means the PID belongs to someone else now, so it's not
83
+ * our session even if it's a real process. The bootTime guard catches the
84
+ * rare "PID got reused after a reboot, we still own it" case.
85
+ */
86
+ export function isPidAlive(pid) {
87
+ if (!Number.isInteger(pid) || pid <= 0)
88
+ return false;
89
+ try {
90
+ process.kill(pid, 0);
91
+ return true;
92
+ }
93
+ catch {
94
+ return false;
95
+ }
96
+ }
97
+ /**
98
+ * Validate that a parsed value matches `SessionFile`. Catches schema drift,
99
+ * truncated writes, and tampered files. Anything other than a perfect match
100
+ * is reported as `malformed` -- we don't try to repair partial files.
101
+ */
102
+ function validateSessionFile(raw) {
103
+ if (!raw || typeof raw !== 'object')
104
+ return false;
105
+ const r = raw;
106
+ return (typeof r.version === 'number' &&
107
+ typeof r.pid === 'number' &&
108
+ typeof r.sessionId === 'string' &&
109
+ typeof r.appId === 'string' &&
110
+ typeof r.previewUrl === 'string' &&
111
+ typeof r.startedAt === 'number' &&
112
+ typeof r.bootTime === 'number' &&
113
+ typeof r.cliVersion === 'string' &&
114
+ (r.mode === 'foreground' || r.mode === 'detached'));
115
+ }
116
+ /**
117
+ * Read and parse the session file. Returns `null` for a missing file or
118
+ * any IO/parse error. The caller decides what "missing" vs "malformed"
119
+ * means -- use `getSessionState()` for that distinction.
120
+ */
121
+ export function readSessionFile(appDir) {
122
+ const { file } = getSessionPaths(appDir);
123
+ let raw;
124
+ try {
125
+ raw = fs.readFileSync(file, 'utf-8');
126
+ }
127
+ catch {
128
+ return null;
129
+ }
130
+ let parsed;
131
+ try {
132
+ parsed = JSON.parse(raw);
133
+ }
134
+ catch {
135
+ return null;
136
+ }
137
+ if (!validateSessionFile(parsed))
138
+ return null;
139
+ return parsed;
140
+ }
141
+ /**
142
+ * Write the session file atomically. Writes to `<file>.tmp` first then
143
+ * renames into place. POSIX `rename()` and Windows `MoveFileEx` are both
144
+ * atomic on the same volume, which a sibling temp file always is.
145
+ *
146
+ * Creates `.runwork/` if it doesn't exist. The directory is gitignored at
147
+ * the project-template level.
148
+ */
149
+ export function writeSessionFile(appDir, data) {
150
+ const paths = getSessionPaths(appDir);
151
+ fs.mkdirSync(paths.dir, { recursive: true });
152
+ // We hold the JSON in memory before writing, so a serialization error
153
+ // never leaves a half-written tmp file on disk.
154
+ const json = JSON.stringify(data, null, 2);
155
+ fs.writeFileSync(paths.tmpFile, json, { encoding: 'utf-8' });
156
+ fs.renameSync(paths.tmpFile, paths.file);
157
+ }
158
+ /**
159
+ * Conditional removal: only deletes the session file when its `pid`
160
+ * field matches the caller's. Use this from per-process cleanup paths
161
+ * where another process (e.g., the winner of a startup race) may have
162
+ * overwritten the file with a different owner. Returns `true` when we
163
+ * actually removed it.
164
+ *
165
+ * `removeSessionFile` is the unconditional primitive; this is the
166
+ * "be-a-good-citizen" wrapper for in-process cleanup handlers.
167
+ */
168
+ export function removeSessionFileIfOwned(appDir, pid) {
169
+ const file = readSessionFile(appDir);
170
+ if (!file)
171
+ return false;
172
+ if (file.pid !== pid)
173
+ return false;
174
+ removeSessionFile(appDir);
175
+ return true;
176
+ }
177
+ /**
178
+ * Idempotent removal. Missing file is not an error. We also clear any
179
+ * leftover temp file from a crashed mid-write -- those aren't load-bearing
180
+ * but they're noise and they confuse `ls -la .runwork/`.
181
+ */
182
+ export function removeSessionFile(appDir) {
183
+ const { file, tmpFile } = getSessionPaths(appDir);
184
+ for (const p of [file, tmpFile]) {
185
+ try {
186
+ fs.unlinkSync(p);
187
+ }
188
+ catch {
189
+ // ENOENT is the happy path; any other error is also intentionally
190
+ // swallowed -- removal is best-effort cleanup, not a load-bearing
191
+ // step. The next `runwork dev` will detect a stale file via the
192
+ // PID/bootTime checks regardless.
193
+ }
194
+ }
195
+ }
196
+ /**
197
+ * Determine the live state of the session file in the given app directory.
198
+ *
199
+ * Checks are ordered cheap-to-expensive. The `pidAlive` syscall is last
200
+ * so a malformed or wrong-version file short-circuits before we touch
201
+ * the OS at all.
202
+ *
203
+ * 1. File missing -> `none`
204
+ * 2. File malformed / truncated -> `stale: malformed`
205
+ * 3. Schema version mismatch -> `stale: version-mismatch`
206
+ * 4. App ID mismatch -> `stale: app-id-mismatch`
207
+ * 5. Boot time outside tolerance -> `stale: boot-time-mismatch`
208
+ * 6. PID not alive -> `stale: pid-dead`
209
+ * 7. Otherwise -> `alive`
210
+ */
211
+ export function getSessionState(appDir, expectedAppId, deps = {}) {
212
+ const { file: filePath } = getSessionPaths(appDir);
213
+ if (!fs.existsSync(filePath))
214
+ return { state: 'none' };
215
+ const file = readSessionFile(appDir);
216
+ if (!file)
217
+ return { state: 'stale', reason: 'malformed' };
218
+ if (file.version !== SESSION_FILE_SCHEMA_VERSION) {
219
+ return { state: 'stale', reason: 'version-mismatch', file };
220
+ }
221
+ if (file.appId !== expectedAppId) {
222
+ return { state: 'stale', reason: 'app-id-mismatch', file };
223
+ }
224
+ if (isBootTimeStale(file.bootTime, deps)) {
225
+ return { state: 'stale', reason: 'boot-time-mismatch', file };
226
+ }
227
+ const d = resolveDeps(deps);
228
+ if (!d.pidAlive(file.pid)) {
229
+ return { state: 'stale', reason: 'pid-dead', file };
230
+ }
231
+ return { state: 'alive', file };
232
+ }
233
+ /**
234
+ * Convenience constructor for a fresh session file. Fills in version,
235
+ * startedAt, and bootTime from the runtime; everything else is supplied
236
+ * by the caller. Test code can pass a `deps.bootTime` override to inject
237
+ * a deterministic value.
238
+ */
239
+ export function buildSessionFile(input) {
240
+ const d = resolveDeps(input.deps);
241
+ return {
242
+ version: SESSION_FILE_SCHEMA_VERSION,
243
+ pid: input.pid,
244
+ sessionId: input.sessionId,
245
+ appId: input.appId,
246
+ previewUrl: input.previewUrl,
247
+ startedAt: input.startedAt ?? Date.now(),
248
+ bootTime: d.bootTime(),
249
+ cliVersion: input.cliVersion,
250
+ mode: input.mode,
251
+ };
252
+ }
@@ -0,0 +1,52 @@
1
+ /**
2
+ * Stop a running dev session, identified by the on-disk session file.
3
+ *
4
+ * Termination is platform-aware but the design does NOT depend on the
5
+ * child's cleanup handler running. We always remove the session file
6
+ * ourselves at the end so the next `runwork dev` invocation sees a clean
7
+ * slate even on Windows (no SIGTERM equivalent) or on a kill-9'd Unix
8
+ * process.
9
+ */
10
+ import { type SessionDeps, type SessionStaleReason } from './session.js';
11
+ export type StopOutcome = {
12
+ result: 'no-session';
13
+ } | {
14
+ result: 'stale-cleaned';
15
+ reason: SessionStaleReason;
16
+ pid?: number;
17
+ } | {
18
+ result: 'stopped';
19
+ pid: number;
20
+ gracefully: boolean;
21
+ } | {
22
+ result: 'kill-failed';
23
+ pid: number;
24
+ error: unknown;
25
+ };
26
+ export interface StopDeps extends SessionDeps {
27
+ killProcess?: (pid: number, signal?: NodeJS.Signals | 0) => void;
28
+ sleep?: (ms: number) => Promise<void>;
29
+ platform?: NodeJS.Platform;
30
+ /**
31
+ * Maximum total time to wait for the SIGTERM'd child to exit gracefully
32
+ * before falling back to SIGKILL. Unix-only; ignored on Windows.
33
+ */
34
+ graceTimeoutMs?: number;
35
+ /** Polling interval while waiting for the process to die. */
36
+ pollIntervalMs?: number;
37
+ }
38
+ /**
39
+ * Stop a dev session that may or may not exist for the given app dir.
40
+ *
41
+ * - `state: 'none'` -> exit-code-0 no-op, no session to stop.
42
+ * - `state: 'stale'` -> remove the file, no kill needed (the PID is
43
+ * either dead, mismatched, or a different app altogether).
44
+ * - `state: 'alive'` -> Unix: SIGTERM, wait up to graceTimeoutMs,
45
+ * SIGKILL fallback. Windows: TerminateProcess (signal-less kill);
46
+ * Node has no graceful-shutdown signal that survives the cross-process
47
+ * boundary on Windows.
48
+ *
49
+ * In every "found a file" path the file is removed before returning, so
50
+ * the next `runwork dev` sees a clean slate regardless of how things went.
51
+ */
52
+ export declare function stopSession(appDir: string, expectedAppId: string, deps?: StopDeps): Promise<StopOutcome>;
@@ -0,0 +1,101 @@
1
+ /**
2
+ * Stop a running dev session, identified by the on-disk session file.
3
+ *
4
+ * Termination is platform-aware but the design does NOT depend on the
5
+ * child's cleanup handler running. We always remove the session file
6
+ * ourselves at the end so the next `runwork dev` invocation sees a clean
7
+ * slate even on Windows (no SIGTERM equivalent) or on a kill-9'd Unix
8
+ * process.
9
+ */
10
+ import { getSessionPaths, getSessionState, isPidAlive as defaultIsPidAlive, removeSessionFile, } from './session.js';
11
+ import * as fs from 'fs';
12
+ const defaultStopDeps = {
13
+ killProcess: (pid, signal) => {
14
+ process.kill(pid, signal);
15
+ },
16
+ sleep: (ms) => new Promise((r) => setTimeout(r, ms)),
17
+ platform: process.platform,
18
+ graceTimeoutMs: 5_000,
19
+ pollIntervalMs: 100,
20
+ };
21
+ /**
22
+ * Stop a dev session that may or may not exist for the given app dir.
23
+ *
24
+ * - `state: 'none'` -> exit-code-0 no-op, no session to stop.
25
+ * - `state: 'stale'` -> remove the file, no kill needed (the PID is
26
+ * either dead, mismatched, or a different app altogether).
27
+ * - `state: 'alive'` -> Unix: SIGTERM, wait up to graceTimeoutMs,
28
+ * SIGKILL fallback. Windows: TerminateProcess (signal-less kill);
29
+ * Node has no graceful-shutdown signal that survives the cross-process
30
+ * boundary on Windows.
31
+ *
32
+ * In every "found a file" path the file is removed before returning, so
33
+ * the next `runwork dev` sees a clean slate regardless of how things went.
34
+ */
35
+ export async function stopSession(appDir, expectedAppId, deps = {}) {
36
+ const d = { ...defaultStopDeps, ...deps };
37
+ // StopDeps extends SessionDeps, so we can pass `deps` straight through
38
+ // to getSessionState. Constructing a separate `{ bootTime, pidAlive }`
39
+ // object would smuggle in `undefined` values when the caller didn't
40
+ // override them, which then overwrite the real defaults in getSessionState's
41
+ // own spread. Forwarding the object as-is keeps the defaults intact.
42
+ const state = getSessionState(appDir, expectedAppId, deps);
43
+ if (state.state === 'none') {
44
+ return { result: 'no-session' };
45
+ }
46
+ if (state.state === 'stale') {
47
+ removeSessionFile(appDir);
48
+ return { result: 'stale-cleaned', reason: state.reason, pid: state.file?.pid };
49
+ }
50
+ const { file } = state;
51
+ const pid = file.pid;
52
+ // Unix: SIGTERM, wait, SIGKILL fallback.
53
+ // Windows: signal-less kill (== TerminateProcess via Node).
54
+ const isWindows = d.platform === 'win32';
55
+ const livenessProbe = deps.pidAlive ?? defaultIsPidAlive;
56
+ try {
57
+ if (isWindows) {
58
+ d.killProcess(pid);
59
+ }
60
+ else {
61
+ d.killProcess(pid, 'SIGTERM');
62
+ }
63
+ }
64
+ catch (err) {
65
+ // Even if the kill failed (PID died between state-read and kill, or
66
+ // permission denied), we still want to remove the file so the user
67
+ // isn't stuck. Surface the error as a warning-grade outcome, but
68
+ // clean up.
69
+ removeSessionFile(appDir);
70
+ return { result: 'kill-failed', pid, error: err };
71
+ }
72
+ let gracefully = false;
73
+ if (!isWindows) {
74
+ const deadline = Date.now() + d.graceTimeoutMs;
75
+ while (Date.now() < deadline) {
76
+ if (!livenessProbe(pid)) {
77
+ gracefully = true;
78
+ break;
79
+ }
80
+ // The child cleans up its own session file on SIGTERM, so the file
81
+ // disappearing is also an acceptable "we're done" signal.
82
+ if (!fs.existsSync(getSessionPaths(appDir).file)) {
83
+ gracefully = true;
84
+ break;
85
+ }
86
+ await d.sleep(d.pollIntervalMs);
87
+ }
88
+ if (!gracefully) {
89
+ try {
90
+ d.killProcess(pid, 'SIGKILL');
91
+ }
92
+ catch {
93
+ // Already dead, race-condition'd, or no permission. Either way,
94
+ // we proceed to remove the file -- the goal is "this session is
95
+ // gone from this machine's perspective."
96
+ }
97
+ }
98
+ }
99
+ removeSessionFile(appDir);
100
+ return { result: 'stopped', pid, gracefully };
101
+ }
@@ -1 +1 @@
1
- export declare const VERSION = "0.10.2";
1
+ export declare const VERSION = "0.10.4";
@@ -1,2 +1,2 @@
1
1
  // Auto-generated by scripts/embed-types.ts -- do not edit
2
- export const VERSION = "0.10.2";
2
+ export const VERSION = "0.10.4";
@@ -60,7 +60,7 @@ describe('git/credentials', () => {
60
60
  '--global',
61
61
  '--unset',
62
62
  'credential.https://runwork.ai.helper',
63
- ], { stdio: 'pipe' });
63
+ ], { stdio: 'pipe', windowsHide: true });
64
64
  });
65
65
  it('ignores errors silently', async () => {
66
66
  mockExecFileSync.mockImplementation(() => {
@@ -1,4 +1,4 @@
1
- import { execFileSync } from 'child_process';
1
+ import { execFileSync } from '../utils/subprocess.js';
2
2
  import { readFileSync } from 'fs';
3
3
  import { watch } from 'chokidar';
4
4
  import { join, relative } from 'path';
@@ -1,4 +1,4 @@
1
- import { execFileSync } from 'child_process';
1
+ import { execFileSync } from '../utils/subprocess.js';
2
2
  import { getCredentials } from '../auth/store.js';
3
3
  /**
4
4
  * Build the value we hand to `git config credential.<origin>.helper`.
@@ -1,4 +1,4 @@
1
- import { execFileSync } from 'child_process';
1
+ import { execFileSync } from '../utils/subprocess.js';
2
2
  /**
3
3
  * Default identity used when we cannot derive anything better from the
4
4
  * authenticated credentials. Local-scoped, never written to global config,
@@ -1,4 +1,4 @@
1
- import { execFileSync } from 'child_process';
1
+ import { execFileSync } from '../utils/subprocess.js';
2
2
  import { existsSync } from 'fs';
3
3
  import { win32 as winPath } from 'path';
4
4
  import { homedir } from 'os';
package/dist/git/sync.js CHANGED
@@ -1,4 +1,4 @@
1
- import { execFileSync } from 'child_process';
1
+ import { execFileSync } from '../utils/subprocess.js';
2
2
  import { unlinkSync } from 'fs';
3
3
  import { join } from 'path';
4
4
  export function hasCommits(cwd) {
@@ -1,4 +1,4 @@
1
- import { execFileSync } from 'child_process';
1
+ import { execFileSync } from '../utils/subprocess.js';
2
2
  import { existsSync, readFileSync } from 'fs';
3
3
  import { join, sep } from 'path';
4
4
  import { homedir, platform as osPlatform, arch as osArch } from 'os';
@@ -1,5 +1,5 @@
1
1
  import { createHash } from 'crypto';
2
- import { execFileSync } from 'child_process';
2
+ import { execFileSync } from '../utils/subprocess.js';
3
3
  import { readFileSync, writeFileSync, existsSync, readdirSync, mkdirSync } from 'fs';
4
4
  import { join, relative } from 'path';
5
5
  import { buildIgnoreSets } from '../utils/ignore-matcher.js';
@@ -27,4 +27,8 @@ describe('parseKeypress', () => {
27
27
  it('detects "i" for info', () => {
28
28
  expect(parseKeypress(Buffer.from('i'))).toBe('i');
29
29
  });
30
+ it('detects "s" for stop (used by `runwork dev attach`)', () => {
31
+ expect(parseKeypress(Buffer.from('s'))).toBe('s');
32
+ expect(parseKeypress(Buffer.from('S'))).toBe('s');
33
+ });
30
34
  });
@@ -1,4 +1,4 @@
1
- export type KeyAction = 'o' | 'p' | 'a' | 'e' | 'r' | 'i' | 'quit' | null;
1
+ export type KeyAction = 'o' | 'p' | 'a' | 'e' | 'r' | 'i' | 's' | 'quit' | null;
2
2
  /** Parse a raw stdin buffer into a named action. */
3
3
  export declare function parseKeypress(data: Buffer): KeyAction;
4
4
  export interface KeyboardListener {
@@ -12,6 +12,10 @@ export function parseKeypress(data) {
12
12
  case 'e': return 'e';
13
13
  case 'r': return 'r';
14
14
  case 'i': return 'i';
15
+ // 's' is consumed by `runwork dev attach` to stop the attached
16
+ // session. Other commands ignore it. We parse it centrally so the
17
+ // raw keypress doesn't leak through as a `null` action.
18
+ case 's': return 's';
15
19
  case 'q': return 'quit';
16
20
  default: return null;
17
21
  }
@@ -24,6 +24,19 @@ export interface AgentResponse<T> {
24
24
  }
25
25
  /** Map of key template files and what they're for. */
26
26
  export declare const APP_STRUCTURE: Record<string, string>;
27
+ /**
28
+ * The single most important workflow rule for AI agents working on a
29
+ * Runwork app. Repeated across multiple guides because it's the
30
+ * difference between a working dev cycle and a frustrating one.
31
+ *
32
+ * Rationale -- agents that don't follow this end up:
33
+ * 1. Editing files locally with no preview to verify against.
34
+ * 2. Hitting a single bulk-sync at dev startup that masks which
35
+ * change broke what (instead of incremental per-change syncs).
36
+ * 3. Risking sync conflicts when the local state has diverged from
37
+ * the remote in a way the auto-sync can't reconcile.
38
+ */
39
+ export declare const DEV_FIRST_RULE = "CRITICAL: Always start `runwork dev --detach` BEFORE editing any code in this app. Dev establishes the live sync pipeline -- without it, changes do not flow to the preview, and the dev startup will batch-sync everything at once instead of giving you per-change feedback. To check whether dev is already running for this app, run `runwork info --json` and inspect `localDevSession.state` (alive / stale / none). If alive, just edit. If none or stale, run `runwork dev --detach --json` first, capture the preview URL from the `session_started` event, then proceed with edits.";
27
40
  export declare function buildInitGuide(appName: string, dir: string): AgentGuide;
28
41
  export declare function buildCloneGuide(appName: string, dir: string): AgentGuide;
29
42
  export declare function buildDevSessionGuide(): AgentGuide;
@@ -18,7 +18,21 @@ export const APP_STRUCTURE = {
18
18
  'blueprint.json': 'App feature registry. Update after adding entities, workflows, agents, etc.',
19
19
  'CLAUDE.md': 'Complete framework documentation. Read this before editing anything.',
20
20
  };
21
+ /**
22
+ * The single most important workflow rule for AI agents working on a
23
+ * Runwork app. Repeated across multiple guides because it's the
24
+ * difference between a working dev cycle and a frustrating one.
25
+ *
26
+ * Rationale -- agents that don't follow this end up:
27
+ * 1. Editing files locally with no preview to verify against.
28
+ * 2. Hitting a single bulk-sync at dev startup that masks which
29
+ * change broke what (instead of incremental per-change syncs).
30
+ * 3. Risking sync conflicts when the local state has diverged from
31
+ * the remote in a way the auto-sync can't reconcile.
32
+ */
33
+ export const DEV_FIRST_RULE = 'CRITICAL: Always start `runwork dev --detach` BEFORE editing any code in this app. Dev establishes the live sync pipeline -- without it, changes do not flow to the preview, and the dev startup will batch-sync everything at once instead of giving you per-change feedback. To check whether dev is already running for this app, run `runwork info --json` and inspect `localDevSession.state` (alive / stale / none). If alive, just edit. If none or stale, run `runwork dev --detach --json` first, capture the preview URL from the `session_started` event, then proceed with edits.';
21
34
  const COMMON_TIPS = [
35
+ DEV_FIRST_RULE,
22
36
  'Read CLAUDE.md in the app directory first -- it has complete framework documentation with code examples.',
23
37
  'You do NOT need to run git commands manually. runwork dev handles file syncing automatically. (git itself must be installed on the system -- see dependencies.)',
24
38
  'Do NOT install external AI SDKs (openai, @anthropic-ai/sdk). Use @runworkai/framework/ai instead.',
@@ -39,8 +53,8 @@ export function buildInitGuide(appName, dir) {
39
53
  structure: APP_STRUCTURE,
40
54
  nextSteps: [
41
55
  `cd ${dir}`,
42
- 'runwork dev # start development server -- watches for file changes and syncs automatically',
43
- 'Edit files for your needs (see structure above)',
56
+ 'runwork dev --detach --json # FIRST: start the dev sandbox in the background; capture the preview URL from the session_started event',
57
+ 'THEN edit files for your needs (see structure above) -- changes auto-sync to the preview',
44
58
  'runwork deploy # deploy to production when ready',
45
59
  ],
46
60
  tips: COMMON_TIPS,
@@ -53,9 +67,9 @@ export function buildCloneGuide(appName, dir) {
53
67
  structure: APP_STRUCTURE,
54
68
  nextSteps: [
55
69
  `cd ${dir}`,
56
- 'runwork dev # start development server',
70
+ 'runwork dev --detach --json # FIRST: start dev in the background, capture the preview URL',
57
71
  'Review existing files to understand what is already built',
58
- 'Edit files for your needs',
72
+ 'THEN edit files for your needs -- changes auto-sync to the preview',
59
73
  'runwork deploy # deploy to production when ready',
60
74
  ],
61
75
  tips: [SYSTEM_DEPENDENCIES_NOTE, ...COMMON_TIPS],
@@ -89,17 +103,18 @@ export function buildDeployGuide() {
89
103
  }
90
104
  export function buildInfoGuide() {
91
105
  return {
92
- context: 'This shows the current state of the app: what is deployed, what integrations are connected, and what resources (entities, workflows, agents, etc.) are registered.',
106
+ context: 'This shows the current state of the app: what is deployed, what integrations are connected, and what resources (entities, workflows, agents, etc.) are registered. The `localDevSession` field tells you whether a dev session is already running on this machine -- check it BEFORE starting a new one.',
93
107
  nextSteps: [
94
- 'runwork dev # start development server if not already running',
108
+ 'If localDevSession.state == "alive": dev is already running. Use the URL in localDevSession.previewUrl and proceed with edits.',
109
+ 'If localDevSession.state == "none" or "stale": run `runwork dev --detach --json` BEFORE editing any code. Capture the preview URL from the session_started event.',
95
110
  'runwork deploy # deploy to production when ready',
96
111
  ],
97
112
  tips: [
113
+ DEV_FIRST_RULE,
98
114
  'Entities listed here are the data models available via Entity CRUD methods.',
99
115
  'Workflows listed here can be triggered via their registered endpoints or schedules.',
100
116
  'Agents listed here need frontend pages (conversational) or triggers (task) to be accessible.',
101
117
  'Integrations with connected status are ready to use. Others need setup in workspace settings.',
102
- 'If preview is not active, run runwork dev to start a development session.',
103
118
  ],
104
119
  };
105
120
  }
@@ -0,0 +1,19 @@
1
+ /**
2
+ * Thin wrappers around `child_process.execFileSync` and `spawn` that
3
+ * default `windowsHide: true`. On Windows, every console-subsystem
4
+ * subprocess we spawn (git, where.exe, registry queries) creates its
5
+ * own console window unless this flag is set. With our hot paths --
6
+ * auto-commit's git invocations, manifest's `git ls-files`, the sync
7
+ * loop's git rebase / fetch / push -- a missing flag visibly flashes a
8
+ * console window every few seconds, which Codex Desktop users see as
9
+ * "empty terminals keep popping up."
10
+ *
11
+ * Use these as drop-in replacements for the `child_process` exports.
12
+ * Existing options the caller passes still win (so you can opt back to
13
+ * `windowsHide: false` if you genuinely need the window, e.g. for
14
+ * interactive prompts -- though we don't have any of those in our
15
+ * subprocess paths today).
16
+ */
17
+ import { execFileSync as cpExecFileSync, spawn as cpSpawn } from 'child_process';
18
+ export declare const execFileSync: typeof cpExecFileSync;
19
+ export declare const spawn: typeof cpSpawn;
@@ -0,0 +1,27 @@
1
+ /**
2
+ * Thin wrappers around `child_process.execFileSync` and `spawn` that
3
+ * default `windowsHide: true`. On Windows, every console-subsystem
4
+ * subprocess we spawn (git, where.exe, registry queries) creates its
5
+ * own console window unless this flag is set. With our hot paths --
6
+ * auto-commit's git invocations, manifest's `git ls-files`, the sync
7
+ * loop's git rebase / fetch / push -- a missing flag visibly flashes a
8
+ * console window every few seconds, which Codex Desktop users see as
9
+ * "empty terminals keep popping up."
10
+ *
11
+ * Use these as drop-in replacements for the `child_process` exports.
12
+ * Existing options the caller passes still win (so you can opt back to
13
+ * `windowsHide: false` if you genuinely need the window, e.g. for
14
+ * interactive prompts -- though we don't have any of those in our
15
+ * subprocess paths today).
16
+ */
17
+ import { execFileSync as cpExecFileSync, spawn as cpSpawn, } from 'child_process';
18
+ // We re-export with the *exact* `typeof` signature of the originals so
19
+ // caller-side overload narrowing (encoding -> string vs Buffer return
20
+ // type) keeps working. The implementation forwards through the original
21
+ // after merging in `windowsHide: true` as a default.
22
+ export const execFileSync = ((file, args, options) => {
23
+ return cpExecFileSync(file, args, { windowsHide: true, ...(options ?? {}) });
24
+ });
25
+ export const spawn = ((command, args, options) => {
26
+ return cpSpawn(command, args ?? [], { windowsHide: true, ...(options ?? {}) });
27
+ });
@@ -1,4 +1,4 @@
1
- import { execFileSync } from 'child_process';
1
+ import { execFileSync } from './subprocess.js';
2
2
  import { platform } from 'os';
3
3
  /**
4
4
  * Cross-platform binary detection.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "runwork",
3
- "version": "0.10.2",
3
+ "version": "0.10.4",
4
4
  "description": "CLI for Runwork: develop, preview, and deploy Runwork apps from your local machine.",
5
5
  "license": "UNLICENSED",
6
6
  "author": "Runwork <info@runwork.ai> (https://www.runwork.ai)",