@dreamlake/dreamlake-cli 0.107.1 → 0.107.2

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.
@@ -1,3 +1,5 @@
1
+ import { bindrsApi } from "./bindrs.js";
2
+ export * from "./bindrs.js";
1
3
  /** Workspace resource APIs. Authentication/ACLs stay in the existing service routes. */
2
4
  import { seg } from "./client.js";
3
5
  import { namespacePath, resourceApi, call, } from "./common.js";
@@ -46,16 +48,8 @@ export function projectsApi(t, namespace) {
46
48
  },
47
49
  /** Mixed project resources, or one bindr's members via the bindr filter. */
48
50
  resourceList: (project, query = {}) => call(t, "GET", path(project) + "/resources", undefined, query),
49
- resources: (project, kind) => resourceApi(t, path(project) + "/" + kind),
50
- bindrs: (project) => ({
51
- ...resourceApi(t, path(project) + "/bindrs"),
52
- addMembers: (name, add) => call(t, "POST", path(project) + "/bindrs/" + seg(name) + "/members", {
53
- add,
54
- }),
55
- removeMembers: (name, remove) => call(t, "DELETE", path(project) + "/bindrs/" + seg(name) + "/members", {
56
- remove,
57
- }),
58
- }),
51
+ resources: (project, kind) => kind === "bindrs" ? bindrsApi(t, namespace, project) : resourceApi(t, path(project) + "/" + kind),
52
+ bindrs: (project) => bindrsApi(t, namespace, project),
59
53
  datasets: (project) => ({
60
54
  ...resourceApi(t, path(project) + "/datasets"),
61
55
  addBindrs: (name, add) => call(t, "POST", path(project) + "/datasets/" + seg(name) + "/bindrs", {
@@ -4,6 +4,7 @@ interface CreateOpts {
4
4
  episode?: string;
5
5
  description?: string;
6
6
  tags?: string;
7
+ yes?: boolean;
7
8
  }
8
9
  export declare function runCreateBindr(name: string, opts: CreateOpts): Promise<number>;
9
10
  export declare function runCreateDataset(name: string, opts: CreateOpts): Promise<number>;
@@ -1,8 +1,5 @@
1
- // `dreamlake create bindr|dataset <name> --project <target> ...`.
2
- // Port of dreamlake-py's cli/commands/create.py.
3
- //
4
- // bindr — members are EPISODES matched by `--episode <glob>` (node path)
5
- // dataset — created empty; add bindrs later via `update dataset`
1
+ import { bindrsApi, BindrMembersError } from "../../api/bindrs.js";
2
+ import { createTransport, namespaceSeg, seg } from "../../api/client.js";
6
3
  import { HttpError, requestJson } from "../client.js";
7
4
  import { resolveNamespace, resolveRemote, resolveToken } from "../config.js";
8
5
  import { fail, ok, splitCsv } from "../helpers.js";
@@ -18,7 +15,7 @@ export async function runCreateBindr(name, opts) {
18
15
  if (!ctx)
19
16
  return 1;
20
17
  const { s, token, remote } = ctx;
21
- const base = `/namespaces/${s.namespace}/projects/${s.project}/bindrs`;
18
+ const base = `/namespaces/${namespaceSeg(s.namespace)}/projects/${seg(s.project)}/bindrs`;
22
19
  let members = [];
23
20
  if (opts.episode) {
24
21
  const episodes = await fetchAllEpisodes(remote, s.namespace, s.project, token, { includeArchived: true });
@@ -30,21 +27,27 @@ export async function runCreateBindr(name, opts) {
30
27
  process.stdout.write(`Matched ${matched.length} episode(s):\n`);
31
28
  for (const ep of matched)
32
29
  process.stdout.write(` ${ep.nodePath ?? ep.name ?? ""}\n`);
33
- const proceed = await confirm(`Create bindr '${name}' with ${matched.length} episodes?`, false);
30
+ const proceed = opts.yes || await confirm(`Create bindr '${name}' with ${matched.length} episodes?`, false);
34
31
  if (!proceed) {
35
32
  process.stdout.write("Cancelled.\n");
36
33
  return 0;
37
34
  }
38
35
  members = matched.map((ep) => ep.id);
39
36
  }
40
- const body = { name, members };
37
+ const body = { name };
41
38
  if (opts.description)
42
39
  body.description = opts.description;
43
40
  const tags = splitCsv(opts.tags);
44
41
  if (tags.length)
45
42
  body.tags = tags;
43
+ let bindrId;
46
44
  try {
47
- await requestJson(remote, base, { method: "POST", token, json: body });
45
+ const created = await requestJson(remote, base, { method: "POST", token, json: body });
46
+ if (!created?.bindr || typeof created.bindr.id !== "string" || !created.bindr.id.trim()) {
47
+ fail(`Bindr creation returned success without a usable Bindr ID. '${name}' may have been created in ${formatProject(s)}; inspect the project before retrying. No episode tagging requests were sent.`);
48
+ return 1;
49
+ }
50
+ bindrId = created.bindr.id;
48
51
  }
49
52
  catch (err) {
50
53
  if (err instanceof HttpError && err.status === 409) {
@@ -58,7 +61,17 @@ export async function runCreateBindr(name, opts) {
58
61
  fail(err.message);
59
62
  return 1;
60
63
  }
64
+ if (members.length) {
65
+ try {
66
+ await bindrsApi(createTransport({ remote, token }), s.namespace, s.project).addMembers(bindrId, members);
67
+ }
68
+ catch (err) {
69
+ fail(`Created bindr '${name}' (${bindrId}), but episode tagging did not complete. ${err instanceof BindrMembersError ? err.message : String(err)}. Inspect this bindr before retrying; it was not deleted.`);
70
+ return 1;
71
+ }
72
+ }
61
73
  ok(`Created bindr: ${name} in ${formatProject(s)}`);
74
+ process.stdout.write(` id: ${bindrId}\n`);
62
75
  if (members.length)
63
76
  process.stdout.write(` episodes: ${members.length}\n`);
64
77
  if (opts.description)
@@ -191,6 +204,7 @@ export function registerCreateCommand(program) {
191
204
  .argument("<name>", "bindr name")
192
205
  .requiredOption("--project <target>", "project scope: space[@namespace]")
193
206
  .option("--episode <glob>", "glob to match episodes by node path")
207
+ .option("--yes", "skip the confirmation prompt")
194
208
  .option("--description <text>", "description")
195
209
  .option("--tags <list>", "comma-separated tags")
196
210
  .action(async (name, opts) => {
@@ -1,10 +1,9 @@
1
- // `dreamlake delete bindr|dataset <name> --project <target> [--yes]`.
2
- // Port of dreamlake-py's cli/commands/delete.py.
1
+ import { seg } from "../../api/client.js";
3
2
  import { HttpError, requestJson } from "../client.js";
4
3
  import { resolveNamespace, resolveRemote, resolveToken } from "../config.js";
5
4
  import { fail, ok } from "../helpers.js";
6
5
  import { confirm } from "../prompt.js";
7
- import { fetchAllEpisodes, fetchProjects, lookupNode, resolveProjectCtx, } from "../resources.js";
6
+ import { fetchAllEpisodes, fetchProjects, lookupNode, resolveProjectCtx, resolveBindr, } from "../resources.js";
8
7
  import { formatProject, parseTarget } from "../target.js";
9
8
  async function runDelete(kind, name, opts) {
10
9
  if (!opts.project) {
@@ -16,6 +15,16 @@ async function runDelete(kind, name, opts) {
16
15
  return 1;
17
16
  const { s, token, remote } = ctx;
18
17
  const proj = formatProject(s);
18
+ let bindrId;
19
+ if (kind === "bindr") {
20
+ try {
21
+ bindrId = (await resolveBindr(ctx, name)).id;
22
+ }
23
+ catch (err) {
24
+ fail(err.message);
25
+ return 1;
26
+ }
27
+ }
19
28
  if (!opts.yes) {
20
29
  const proceed = await confirm(`Delete ${kind} '${name}' from ${proj}?`, false);
21
30
  if (!proceed) {
@@ -25,7 +34,7 @@ async function runDelete(kind, name, opts) {
25
34
  }
26
35
  const collection = kind === "bindr" ? "bindrs" : "datasets";
27
36
  try {
28
- await requestJson(remote, `/namespaces/${s.namespace}/projects/${s.project}/${collection}/${name}`, { method: "DELETE", token });
37
+ await requestJson(remote, bindrId ? `/bindrs/${seg(bindrId)}` : `/namespaces/${seg(s.namespace)}/projects/${seg(s.project)}/${collection}/${seg(name)}`, { method: "DELETE", token });
29
38
  }
30
39
  catch (err) {
31
40
  if (err instanceof HttpError && err.status === 404) {
@@ -80,6 +80,7 @@ export const helpExamples = {
80
80
  "infra transfer create": "dreamlake infra transfer create 616658fd-531c-4bb9-8f52-7ebcbaa350b9 \\\n --request-file stack-transfer.json --confirm --accept-if-authorized",
81
81
  "infra transfer status": "dreamlake infra transfer status 616658fd-531c-4bb9-8f52-7ebcbaa350b1 \\\n --out stack-transfer-acceptance.json",
82
82
  "infra transfer accept": "dreamlake infra transfer accept 616658fd-531c-4bb9-8f52-7ebcbaa350b1 \\\n --request-file stack-transfer-acceptance.json --confirm",
83
+ "install": "# Reinstall and configure the shell selected by SHELL.\ndreamlake install\n# Install a channel without editing shell startup files or user PATH.\ndreamlake install stable --no-modify-path",
83
84
  "jobs register": "dreamlake jobs register --namespace geyang --name train-baseline \\\n --host 0123456789abcdef01234567 --request-id train-baseline-01",
84
85
  "jobs report": "dreamlake jobs report 89abcdef0123456789abcdef --namespace geyang --state running\ndreamlake jobs report 89abcdef0123456789abcdef --namespace geyang \\\n --state succeeded --exit-code 0\ndreamlake jobs report fedcba9876543210fedcba98 --namespace geyang \\\n --state failed --exit-code 7 --message 'Training process exited with an error'",
85
86
  "jobs list": "dreamlake jobs list --namespace geyang\ndreamlake jobs list --namespace geyang --host 0123456789abcdef01234567 --state running\ndreamlake jobs list --namespace geyang --page 2 --page-size 50 --json",
@@ -149,6 +150,7 @@ export const helpExamples = {
149
150
  "ownership snapshot": "dreamlake ownership snapshot 000000000000000000000001 --namespace acme",
150
151
  "ownership snapshot-cleanup": "# Inspect eligibility without deleting anything (the default).\ndreamlake ownership snapshot-cleanup 000000000000000000000001 --namespace acme\n# Delete only after server retention and recovery checks pass.\ndreamlake ownership snapshot-cleanup 000000000000000000000001 --namespace acme --execute",
151
152
  "project move": "# Save a read-only streaming review with its stable request/key.\ndreamlake project move research --namespace personal --to acme --dry-run --out project-move-review.json\n# Confirm that exact saved review; the recipient must accept separately.\ndreamlake project move research --namespace personal --to acme --confirm --request-file project-move-review.json\n# Accept only with verified destination namespace authority, then wait a bounded time.\ndreamlake project move research --namespace personal --to acme --confirm --request-file project-move-review.json --accept-if-authorized --wait",
153
+ "create bindr": "# Seed a Bindr with matching episodes without an interactive prompt.\ndreamlake create bindr front-cam --project my-robots --episode \"camera/front/*\" --yes",
152
154
  "project inspect": "dreamlake project inspect research --namespace acme",
153
155
  "project grants": "dreamlake project grants research --namespace acme",
154
156
  "project grant": "dreamlake project grant research --namespace acme --user teammate --role WRITE\ndreamlake project grant research --namespace acme --team TEAM_ID --role READ",
@@ -1,7 +1,4 @@
1
- // `dreamlake list ...` — assets (default), bindrs, datasets, episodes.
2
- // Port of dreamlake-py's cli/commands/list.py. Where the Python CLI used
3
- // an interactive 20-per-page pager, we fetch all pages and render one
4
- // table (more script-friendly); `--json` emits raw JSON.
1
+ import { seg } from "../../api/client.js";
5
2
  import { resolveNamespace, resolveRemote, resolveToken } from "../config.js";
6
3
  import { emitJson, fail, humanSize, renderTable } from "../helpers.js";
7
4
  import { fetchAllContents, fetchAllEpisodes, fetchAllPages, fetchProjects, nodePathToCommaPrefix, relPathUnder, resolveProjectCtx, } from "../resources.js";
@@ -126,7 +123,7 @@ export async function runListBindrs(opts) {
126
123
  if (!ctx)
127
124
  return 1;
128
125
  const { s, token, remote } = ctx;
129
- const result = await fetchAllPages(remote, `/namespaces/${s.namespace}/projects/${s.project}/bindrs`, token, "bindrs");
126
+ const result = await fetchAllPages(remote, `/namespaces/${seg(s.namespace)}/projects/${seg(s.project)}/bindrs`, token, "bindrs");
130
127
  if (result === "not-found") {
131
128
  process.stdout.write(" (project not found)\n");
132
129
  return 0;
@@ -138,12 +135,13 @@ export async function runListBindrs(opts) {
138
135
  process.stdout.write(`Listing bindrs in ${formatProject(s)}\n\n`);
139
136
  const rows = result.items.map((d) => ({
140
137
  name: String(d.name ?? ""),
141
- files: Array.isArray(d.members) ? d.members.length : 0,
138
+ id: String(d.id ?? ""),
139
+ members: typeof d.memberCount === "number" ? d.memberCount : "?",
142
140
  tags: Array.isArray(d.tags) ? d.tags.join(", ") : "",
143
141
  description: String(d.description ?? "").slice(0, 40),
144
142
  created: String(d.createdAt ?? "").slice(0, 10),
145
143
  }));
146
- process.stdout.write(renderTable(rows, ["name", "files", "tags", "description", "created"]));
144
+ process.stdout.write(renderTable(rows, ["name", "id", "members", "tags", "description", "created"]));
147
145
  process.stdout.write(`\n ${result.total} bindr(s)\n`);
148
146
  return 0;
149
147
  }
@@ -26,6 +26,8 @@ export declare function fetchAllEpisodes(remote: string, namespace: string, proj
26
26
  }): Promise<EpisodeRec[]>;
27
27
  /** Fetch all bindrs in a project (throws on error). */
28
28
  export declare function fetchAllBindrs(remote: string, namespace: string, project: string, token: string): Promise<BindrRec[]>;
29
+ /** Resolve once before a mutation or confirmation; never silently pick a duplicate name. */
30
+ export declare function resolveBindr(ctx: ProjectCtx, nameOrId: string): Promise<BindrRec>;
29
31
  /** Match episodes by glob against their name OR node path (leading "/" stripped). */
30
32
  export declare function matchEpisodes(episodes: EpisodeRec[], pattern: string): EpisodeRec[];
31
33
  /** Match bindrs by glob against their name. */
@@ -1,3 +1,4 @@
1
+ import { seg } from "../api/client.js";
1
2
  // Shared helpers for project-scoped resource commands (list / create /
2
3
  // update / delete of bindrs and datasets). Centralizes project-context
3
4
  // resolution, paginated fetches, and glob matching.
@@ -64,13 +65,26 @@ async function fetchEveryPage(remote, path, token, key) {
64
65
  }
65
66
  /** Fetch all episodes in a project (throws on error). */
66
67
  export async function fetchAllEpisodes(remote, namespace, project, token, options = {}) {
67
- const r = await fetchAllPages(remote, `/namespaces/${namespace}/projects/${project}/episodes${options.includeArchived ? "?includeArchived=true" : ""}`, token, "episodes");
68
+ const r = await fetchAllPages(remote, `/namespaces/${seg(namespace)}/projects/${seg(project)}/episodes${options.includeArchived ? "?includeArchived=true" : ""}`, token, "episodes");
68
69
  return r === "not-found" ? [] : r.items;
69
70
  }
70
71
  /** Fetch all bindrs in a project (throws on error). */
71
72
  export async function fetchAllBindrs(remote, namespace, project, token) {
72
- const r = await fetchAllPages(remote, `/namespaces/${namespace}/projects/${project}/bindrs`, token, "bindrs");
73
- return r === "not-found" ? [] : r.items;
73
+ const result = await requestJson(remote, `/namespaces/${seg(namespace)}/projects/${seg(project)}/bindrs`, { token });
74
+ return result.bindrs;
75
+ }
76
+ /** Resolve once before a mutation or confirmation; never silently pick a duplicate name. */
77
+ export async function resolveBindr(ctx, nameOrId) {
78
+ const rows = await fetchAllBindrs(ctx.remote, ctx.s.namespace, ctx.s.project, ctx.token);
79
+ const byId = rows.find(row => row.id === nameOrId);
80
+ if (byId)
81
+ return byId;
82
+ const matches = rows.filter(row => row.name === nameOrId);
83
+ if (!matches.length)
84
+ throw new Error(`bindr '${nameOrId}' not found in ${ctx.s.project}`);
85
+ if (matches.length > 1)
86
+ throw new Error(`bindr '${nameOrId}' is ambiguous; use its ID (${matches.map(row => row.id).join(", ")})`);
87
+ return matches[0];
74
88
  }
75
89
  /** Match episodes by glob against their name OR node path (leading "/" stripped). */
76
90
  export function matchEpisodes(episodes, pattern) {
@@ -1,5 +1,5 @@
1
1
  // Commander wiring for the self-updating native install.
2
- import { installedVersion, installWarnings, performInstall, shadowingBinary } from "./install.js";
2
+ import { binaryOnPath, installedVersion, installWarnings, performInstall, shadowingBinary } from "./install.js";
3
3
  import { binDir, isNativeInstall, launcherPath, versionsDir } from "./paths.js";
4
4
  import { CHANNELS, isChannel } from "./releases.js";
5
5
  import { activeChannel, pinnedVersion, writeSettings } from "./settings.js";
@@ -12,13 +12,14 @@ export function registerInstallCommand(program) {
12
12
  .command("install")
13
13
  .description("install or re-install the native binary under ~/.local")
14
14
  .argument("[target]", `${CHANNELS.join(" | ")} | version (default: saved channel)`)
15
- .action(async (target) => {
15
+ .option("--no-modify-path", "leave shell startup files and user PATH unchanged")
16
+ .action(async (target, opts) => {
16
17
  try {
17
18
  // install.sh always runs us from a throwaway download, so "you are
18
19
  // now a native install" is only news when the user invoked this
19
20
  // themselves from an npm or from-source copy.
20
21
  const converting = !isNativeInstall() && process.env.DREAMLAKE_BOOTSTRAP !== "1";
21
- const result = await performInstall(target);
22
+ const result = await performInstall(target, { modifyPath: opts.modifyPath });
22
23
  process.stdout.write(`Installed dreamlake ${result.version} → ${result.launcher}\n`);
23
24
  if (converting) {
24
25
  process.stdout.write("This is now a native install under ~/.local; the copy you ran this from is untouched.\n");
@@ -87,6 +88,7 @@ export function registerDoctorCommand(program) {
87
88
  .description("print install and auto-update diagnostics")
88
89
  .action(() => {
89
90
  const shadow = shadowingBinary();
91
+ const found = binaryOnPath();
90
92
  const lines = [
91
93
  `dreamlake ${VERSION}`,
92
94
  `executable: ${process.execPath}`,
@@ -94,7 +96,7 @@ export function registerDoctorCommand(program) {
94
96
  `versions: ${versionsDir()}`,
95
97
  `linked: ${installedVersion() ?? "(none — the launcher is not ours; `dreamlake` may resolve elsewhere)"}`,
96
98
  `native: ${isNativeInstall() ? "yes" : "no"}`,
97
- `on PATH: ${shadow ?? `${launcherPath()} (ours)`}`,
99
+ `on PATH: ${shadow ?? (found ? `${found} (ours)` : "launcher is not available on the current PATH")}`,
98
100
  "",
99
101
  updateStatus(),
100
102
  ];
@@ -4,7 +4,7 @@ export interface InstallResult {
4
4
  /** Previous version the launcher pointed at, if any. */
5
5
  previous: string | null;
6
6
  launcher: string;
7
- /** Set when ~/.local/bin is not yet on PATH and we edited a shell rc. */
7
+ /** Shell edits, skipped setup, and instructions for the calling shell. */
8
8
  pathAdvice: string | null;
9
9
  /** Set when the version is frozen rather than following a channel. */
10
10
  pinned: string | null;
@@ -43,11 +43,15 @@ export declare function installedVersion(): string | null;
43
43
  * failure mode tells you nothing at all.
44
44
  */
45
45
  export declare function shadowingBinary(): string | null;
46
+ /** First executable on PATH, including user-created aliases to our launcher. */
47
+ export declare function binaryOnPath(): string | null;
46
48
  export interface InstallOptions {
47
49
  /** Unattended run by the detached auto-updater: no progress output (it
48
50
  * has no terminal of its own to draw on), and yield to anything the
49
51
  * user did explicitly while the download was in flight. */
50
52
  background?: boolean;
53
+ /** Explicit install only; updates must not edit shell configuration. */
54
+ modifyPath?: boolean;
51
55
  }
52
56
  export declare function performInstall(target?: string, opts?: InstallOptions): Promise<InstallResult>;
53
57
  /**
@@ -8,8 +8,9 @@
8
8
  // instead of requiring every user to re-curl a new script.
9
9
  import { spawnSync } from "node:child_process";
10
10
  import { createHash } from "node:crypto";
11
- import { chmodSync, copyFileSync, existsSync, lstatSync, mkdirSync, readdirSync, readFileSync, readlinkSync, renameSync, rmSync, symlinkSync, writeFileSync, } from "node:fs";
11
+ import { accessSync, constants, statSync, chmodSync, copyFileSync, existsSync, lstatSync, mkdirSync, readdirSync, readFileSync, readlinkSync, renameSync, rmSync, symlinkSync, writeFileSync, } from "node:fs";
12
12
  import { homedir } from "node:os";
13
+ import { binOnPath, configureShellPath } from "./shell-path.js";
13
14
  import path from "node:path";
14
15
  import { binDir, canonical, isWindows, launcherPath, versionFromEntry, versionPath, versionsDir, } from "./paths.js";
15
16
  import { compareVersions, detectPlatform, downloadBinary, fetchManifest, isChannel, resolveChannel, VERSION_RE, } from "./releases.js";
@@ -217,48 +218,6 @@ function prune(keep) {
217
218
  }
218
219
  }
219
220
  // ─── PATH setup ──────────────────────────────────────────────────────
220
- const PATH_MARKER = "# added by the dreamlake installer";
221
- function onPath(dir) {
222
- const entries = (process.env.PATH ?? "").split(path.delimiter).filter(Boolean);
223
- return entries.some((e) => path.resolve(e) === path.resolve(dir));
224
- }
225
- /**
226
- * Config file for the user's login shell, plus the syntax to extend PATH in
227
- * it. Only the active shell is touched: appending to every rc we can find
228
- * means fish users get a line in ~/.bashrc that fish never reads, and
229
- * everyone gets four blocks to clean up at uninstall time for one install.
230
- */
231
- function shellRc() {
232
- const home = homedir();
233
- const shell = path.basename(process.env.SHELL ?? "");
234
- if (shell === "fish") {
235
- return {
236
- file: path.join(home, ".config", "fish", "config.fish"),
237
- // fish_add_path is already a no-op when the entry is present.
238
- line: `\n${PATH_MARKER}\nfish_add_path "$HOME/.local/bin"\n`,
239
- };
240
- }
241
- // Guarded, so re-sourcing the rc in a live shell does not prepend a
242
- // second copy. An unguarded `export PATH=...:$PATH` grows PATH every
243
- // time the file is sourced, and `where dreamlake` starts listing the
244
- // same binary twice. Same shape uv uses in ~/.local/bin/env.
245
- const posixLine = `\n${PATH_MARKER}\n` +
246
- `case ":$PATH:" in\n` +
247
- ` *":$HOME/.local/bin:"*) ;;\n` +
248
- ` *) export PATH="$HOME/.local/bin:$PATH" ;;\n` +
249
- `esac\n`;
250
- if (shell === "zsh")
251
- return { file: path.join(home, ".zshrc"), line: posixLine };
252
- if (shell === "bash") {
253
- // bash reads .bash_profile for login shells and .bashrc otherwise;
254
- // prefer whichever already exists so we extend the user's setup
255
- // instead of creating a second file that shadows it.
256
- const profile = path.join(home, ".bash_profile");
257
- const rc = path.join(home, ".bashrc");
258
- return { file: existsSync(rc) || !existsSync(profile) ? rc : profile, line: posixLine };
259
- }
260
- return { file: path.join(home, ".profile"), line: posixLine };
261
- }
262
221
  /**
263
222
  * Add binDir() to the user's persistent PATH on Windows, via the registry
264
223
  * environment block that PowerShell exposes.
@@ -285,39 +244,6 @@ function ensureOnPathWindows() {
285
244
  return [];
286
245
  return res.stdout?.includes("added") ? ["your user PATH"] : [];
287
246
  }
288
- /**
289
- * Put ~/.local/bin on PATH for the next login shell. Returns the files
290
- * touched (at most one). Idempotent via PATH_MARKER — re-running the
291
- * installer does not stack up duplicate exports.
292
- */
293
- function ensureOnPath() {
294
- if (isWindows)
295
- return onPath(binDir()) ? [] : ensureOnPathWindows();
296
- const { file, line } = shellRc();
297
- let current = "";
298
- try {
299
- current = readFileSync(file, "utf8");
300
- }
301
- catch {
302
- /* new file */
303
- }
304
- if (current.includes(PATH_MARKER)) {
305
- // Earlier versions wrote an unguarded export, which prepends again on
306
- // every `source ~/.zshrc`. Upgrade our own block in place; leaving it
307
- // means the duplicate never goes away for anyone already installed.
308
- const legacy = `${PATH_MARKER}\nexport PATH="$HOME/.local/bin:$PATH"\n`;
309
- if (current.includes(legacy)) {
310
- writeFileSync(file, current.replace(legacy, line.replace(/^\n/, "")));
311
- return [file];
312
- }
313
- return [];
314
- }
315
- if (onPath(binDir()))
316
- return [];
317
- mkdirSync(path.dirname(file), { recursive: true });
318
- writeFileSync(file, current + line);
319
- return [file];
320
- }
321
247
  /**
322
248
  * The `dreamlake` the user's current PATH would actually run, when that is
323
249
  * something other than the launcher we manage.
@@ -329,15 +255,23 @@ function ensureOnPath() {
329
255
  * failure mode tells you nothing at all.
330
256
  */
331
257
  export function shadowingBinary() {
258
+ const candidate = binaryOnPath();
259
+ return candidate && canonical(candidate) !== canonical(launcherPath()) ? candidate : null;
260
+ }
261
+ /** First executable on PATH, including user-created aliases to our launcher. */
262
+ export function binaryOnPath() {
332
263
  const exe = isWindows ? "dreamlake.exe" : "dreamlake";
333
- const ours = canonical(launcherPath());
334
264
  for (const dir of (process.env.PATH ?? "").split(path.delimiter)) {
335
265
  if (!dir)
336
266
  continue;
337
267
  const candidate = path.join(dir, exe);
338
- if (!existsSync(candidate))
339
- continue;
340
- return canonical(candidate) === ours ? null : candidate;
268
+ try {
269
+ if (!statSync(candidate).isFile())
270
+ continue;
271
+ accessSync(candidate, constants.X_OK);
272
+ return candidate;
273
+ }
274
+ catch { /* absent or not executable */ }
341
275
  }
342
276
  return null;
343
277
  }
@@ -372,7 +306,19 @@ export async function performInstall(target, opts = {}) {
372
306
  // a long-lived session does not lose its own executable mid-run.
373
307
  const running = installedVersion();
374
308
  prune([version, ...(running ? [running] : []), ...(previous ? [previous] : [])].filter(Boolean));
375
- const touched = ensureOnPath();
309
+ let pathAdvice = null;
310
+ if (!opts.background && opts.modifyPath !== undefined && !conflict) {
311
+ const modify = opts.modifyPath && process.env.DREAMLAKE_INSTALL_NO_MODIFY_PATH !== "1";
312
+ if (isWindows) {
313
+ const touched = modify ? ensureOnPathWindows() : [];
314
+ pathAdvice = !modify ? "User PATH setup skipped (--no-modify-path or DREAMLAKE_INSTALL_NO_MODIFY_PATH=1)."
315
+ : touched.length ? "Added ~/.local/bin to your user PATH. Open a new terminal to use it."
316
+ : binOnPath() ? null : "Could not confirm user PATH setup. Add ~/.local/bin to your user PATH and open a new terminal.";
317
+ }
318
+ else {
319
+ pathAdvice = configureShellPath(modify);
320
+ }
321
+ }
376
322
  // Only meaningful once the launcher is really ours; a conflict there is
377
323
  // reported on its own and would otherwise produce two warnings for one
378
324
  // problem.
@@ -384,11 +330,7 @@ export async function performInstall(target, opts = {}) {
384
330
  pinned: channel ? null : version,
385
331
  launcherConflict: conflict,
386
332
  shadowedBy,
387
- pathAdvice: touched.length
388
- ? `Added ~/.local/bin to PATH in ${touched.map((f) => f.replace(homedir(), "~")).join(", ")} — open a new shell or run: export PATH="$HOME/.local/bin:$PATH"`
389
- : onPath(binDir())
390
- ? null
391
- : `~/.local/bin is not on your PATH — add it with: export PATH="$HOME/.local/bin:$PATH"`,
333
+ pathAdvice,
392
334
  };
393
335
  }
394
336
  /**
@@ -0,0 +1,4 @@
1
+ export declare function binOnPath(): boolean;
2
+ /** No prompts: --no-modify-path / DREAMLAKE_INSTALL_NO_MODIFY_PATH=1 opt out
3
+ * equally in terminals, curl pipelines, and unattended provisioning. */
4
+ export declare function configureShellPath(modify?: boolean): string;
@@ -0,0 +1,135 @@
1
+ // Persistent PATH setup is an explicit install operation, never an updater task.
2
+ import { closeSync, constants, existsSync, fstatSync, ftruncateSync, lstatSync, mkdirSync, openSync, readFileSync, writeSync } from "node:fs";
3
+ import { homedir } from "node:os";
4
+ import path from "node:path";
5
+ import { binDir } from "./paths.js";
6
+ const MARKER = "# added by the dreamlake installer";
7
+ const POSIX = `${MARKER}\ncase ":$PATH:" in\n *":$HOME/.local/bin:"*) ;;\n *) export PATH="$HOME/.local/bin\${PATH:+:$PATH}" ;;\nesac\n`;
8
+ const LEGACY = `${MARKER}\nexport PATH="$HOME/.local/bin:$PATH"\n`;
9
+ const FISH = `${MARKER}\nif not contains -- "$HOME/.local/bin" $PATH\n set -gx PATH "$HOME/.local/bin" $PATH\nend\n`;
10
+ export function binOnPath() {
11
+ return (process.env.PATH ?? "").split(path.delimiter).filter(Boolean)
12
+ .some((entry) => path.resolve(entry) === path.resolve(binDir()));
13
+ }
14
+ /** Never execute user startup files to discover configuration. SHELL describes
15
+ * the user's shell, even when the bootstrap itself runs through piped bash. */
16
+ function startupFiles(shell) {
17
+ const home = homedir();
18
+ switch (shell) {
19
+ case "bash": {
20
+ // Creating .bash_profile unconditionally would hide .bash_login/.profile.
21
+ const login = [".bash_profile", ".bash_login", ".profile"]
22
+ .map((name) => path.join(home, name)).find((file) => {
23
+ try {
24
+ lstatSync(file);
25
+ return true;
26
+ }
27
+ catch (err) {
28
+ if (err.code === "ENOENT")
29
+ return false;
30
+ throw err;
31
+ }
32
+ }) ?? path.join(home, ".profile");
33
+ return [login, path.join(home, ".bashrc")];
34
+ }
35
+ case "zsh": {
36
+ const dir = process.env.ZDOTDIR || home;
37
+ if (!path.isAbsolute(dir))
38
+ throw new Error("ZDOTDIR must be absolute for automatic setup");
39
+ return [path.join(dir, ".zprofile"), path.join(dir, ".zshrc")];
40
+ }
41
+ case "fish": {
42
+ const xdg = process.env.XDG_CONFIG_HOME;
43
+ const config = xdg && path.isAbsolute(xdg) ? xdg : path.join(home, ".config");
44
+ return [path.join(config, "fish", "conf.d", "dreamlake-path.fish")];
45
+ }
46
+ case "sh":
47
+ case "dash": return [path.join(home, ".profile")];
48
+ default: return [];
49
+ }
50
+ }
51
+ /** Append without replacing user bytes or following a dotfile symlink. A
52
+ * customized marker is deliberately not a license to rewrite the user's code.
53
+ * Refuse special files and files belonging to another account, even as root. */
54
+ function configureFile(file, block) {
55
+ if (existsSync(file) && !lstatSync(file).isFile()) {
56
+ throw new Error("not a regular file (symlink/custom setup left unchanged)");
57
+ }
58
+ // Require an owned directory before creating missing configuration folders.
59
+ // Explicit XDG_CONFIG_HOME/ZDOTDIR may live outside HOME.
60
+ let parent = path.dirname(file);
61
+ while (!existsSync(parent))
62
+ parent = path.dirname(parent);
63
+ const info = lstatSync(parent);
64
+ if (!info.isDirectory() || (process.getuid && info.uid !== process.getuid())) {
65
+ throw new Error("configuration directory is not an owned directory");
66
+ }
67
+ mkdirSync(path.dirname(file), { recursive: true });
68
+ const fd = openSync(file, constants.O_RDWR | constants.O_CREAT | constants.O_NOFOLLOW | constants.O_NONBLOCK, 0o644);
69
+ try {
70
+ const stat = fstatSync(fd);
71
+ if (!stat.isFile() || (process.getuid && stat.uid !== process.getuid())) {
72
+ throw new Error("configuration is not an owned regular file");
73
+ }
74
+ const current = readFileSync(fd, "utf8");
75
+ if (current.includes(LEGACY)) {
76
+ const next = Buffer.from(current.replace(LEGACY, block));
77
+ writeSync(fd, next, 0, next.length, 0);
78
+ ftruncateSync(fd, next.length);
79
+ return true;
80
+ }
81
+ if (current.includes(MARKER)) {
82
+ // Recognize both the current block and the prior guarded POSIX block.
83
+ const previous = POSIX.replace('${PATH:+:$PATH}', ':$PATH');
84
+ if (current.includes(block) || (block === POSIX && current.includes(previous)))
85
+ return false;
86
+ throw new Error("customized DreamLake PATH block left unchanged; review it manually");
87
+ }
88
+ const suffix = Buffer.from(`${current && !current.endsWith("\n") ? "\n" : ""}\n${block}`);
89
+ writeSync(fd, suffix, 0, suffix.length, stat.size);
90
+ return true;
91
+ }
92
+ finally {
93
+ closeSync(fd);
94
+ }
95
+ }
96
+ /** No prompts: --no-modify-path / DREAMLAKE_INSTALL_NO_MODIFY_PATH=1 opt out
97
+ * equally in terminals, curl pipelines, and unattended provisioning. */
98
+ export function configureShellPath(modify = true) {
99
+ const shell = path.basename(process.env.SHELL ?? "");
100
+ const supported = ["bash", "zsh", "fish", "sh", "dash"].includes(shell);
101
+ const lines = [];
102
+ if (!modify) {
103
+ lines.push("Shell PATH setup skipped (--no-modify-path or DREAMLAKE_INSTALL_NO_MODIFY_PATH=1).");
104
+ }
105
+ else if (!supported) {
106
+ lines.push(`No automatic PATH setup for SHELL=${process.env.SHELL || "(unset)"}. Add ~/.local/bin using your shell's PATH configuration.`);
107
+ }
108
+ else {
109
+ try {
110
+ for (const file of startupFiles(shell)) {
111
+ try {
112
+ const changed = configureFile(file, shell === "fish" ? FISH : POSIX);
113
+ lines.push(`${changed ? "Updated" : "Already configured"} PATH: ${file}`);
114
+ }
115
+ catch (err) {
116
+ lines.push(`Could not configure PATH in ${file}: ${err.message}. Add ~/.local/bin there manually.`);
117
+ }
118
+ }
119
+ }
120
+ catch (err) {
121
+ lines.push(`Could not configure shell PATH: ${err.message}.`);
122
+ }
123
+ }
124
+ if (supported) {
125
+ const command = shell === "fish"
126
+ ? 'contains -- "$HOME/.local/bin" $PATH; or set -gx PATH "$HOME/.local/bin" $PATH'
127
+ : 'case ":$PATH:" in *":$HOME/.local/bin:"*) ;; *) export PATH="$HOME/.local/bin${PATH:+:$PATH}" ;; esac';
128
+ lines.push(`The installer cannot change the calling shell. For this ${shell} session, run:\n ${command}`);
129
+ lines.push(shell === "sh" || shell === "dash"
130
+ ? "The .profile setup applies to login shells only."
131
+ : "Configured startup files take effect in new shells that read them; later user PATH assignments can override them.");
132
+ }
133
+ lines.push('For noninteractive SSH commands, services, or shells that skip startup files, set PATH explicitly or use "$HOME/.local/bin/dreamlake".');
134
+ return lines.join("\n");
135
+ }