@ziamana/bruine 0.1.0 → 0.1.2

package/README.md

@@ -12,7 +12,7 @@
 [![License: MIT](https://img.shields.io/badge/license-MIT-b4a7ff)](LICENSE)
 [![Node 22+](https://img.shields.io/badge/node-22%2B-7dcfff)](https://nodejs.org)
 ![Windows · macOS · Linux](https://img.shields.io/badge/Windows%20%C2%B7%20macOS%20%C2%B7%20Linux-supported-8fe3a3)
-[![Changelog](https://img.shields.io/badge/version-0.1.0-ff9ed2)](CHANGELOG.md)
+[![Changelog](https://img.shields.io/badge/version-0.1.2-ff9ed2)](CHANGELOG.md)
 
 <a href="docs/media/bruine-film.mp4"><img src="docs/media/hero.webp" alt="The bruine film: the word bruine becomes the logo in the rain, then the effort climbs from low to max and the rain turns into a storm" width="100%"></a>
 
@@ -35,6 +35,29 @@ bruine
 The first launch opens a setup wizard: it finds a local model server if you run one, asks for API
 keys if you want a cloud route, lets you pick skills, and writes `~/.bruine/`.
 
+## Install
+
+You need **Node 22 or newer** and npm (it comes with Node). Check with `node --version`.
+
+| | Get Node 22+ | Install bruine | Open it in |
+|---|---|---|---|
+| **Linux** | your package manager (`sudo pacman -S nodejs npm`, `sudo apt install nodejs npm` if it is 22+) or [nvm](https://github.com/nvm-sh/nvm) | `npm install -g @ziamana/bruine` | any terminal |
+| **macOS** | `brew install node`, or the installer from [nodejs.org](https://nodejs.org) | `npm install -g @ziamana/bruine` | Terminal or iTerm2 |
+| **Windows** | `winget install OpenJS.NodeJS.LTS`, or the installer from [nodejs.org](https://nodejs.org) | `npm install -g @ziamana/bruine` | Windows Terminal (PowerShell) |
+
+Then type `bruine` in your project's folder. The command is `bruine`; `@ziamana/bruine` is only the
+name npm knows it by.
+
+- **Permission denied (`EACCES`) on Linux or macOS**: do not use `sudo`. Point npm at a folder you own:
+  `npm config set prefix ~/.local`, and make sure `~/.local/bin` is on your `PATH`.
+- **Update**: `bruine update` (or `/update` in a session). **Remove**: `npm uninstall -g @ziamana/bruine`,
+  and delete `~/.bruine` if you want your settings gone too.
+- **Where it was tested**: Linux every day. On macOS the unit tests pass on the CI runner and the
+  terminal tests are being fixed; on Windows both are being fixed, and it has not yet been run by hand
+  on a real Windows machine. If something breaks there,
+  [open an issue](https://github.com/ziamana/bruine/issues) with your terminal and `bruine --version`.
+  [docs/PLATFORMS.md](docs/PLATFORMS.md) lists what was checked.
+
 ## See it
 
 <img src="docs/demo/bruine.svg" alt="bruine in a terminal: a prompt, the model's reasoning streaming then folding away, a file read, an edit shown as a diff, two permission prompts, the tests passing, and a second prompt that was queued while it worked going out after" width="100%">

package/dist/bin.js

@@ -1180,6 +1180,48 @@ var init_skills = __esm({
   }
 });
 
+// src/setup/default-skills.ts
+import { existsSync as existsSync6 } from "fs";
+import { readFile as readFile4 } from "fs/promises";
+import { homedir as homedir3 } from "os";
+import { join as join4 } from "path";
+function defaultSkills(bundled) {
+  return bundled.map((s) => s.name).filter((name) => !NOT_BY_DEFAULT.includes(name));
+}
+async function ensureDefaultSkills(opts) {
+  const homeSkillsDir = join4(opts.dshHome, "skills");
+  let doc = {};
+  try {
+    doc = JSON.parse(await readFile4(configReadPath(opts.dshHome), "utf8"));
+  } catch {
+    doc = {};
+  }
+  const nothing = { installed: [], kept: [] };
+  if (Array.isArray(doc.skills)) return nothing;
+  if (existsSync6(manifestReadPath(homeSkillsDir))) return nothing;
+  const bundled = await readBundledSkills(opts.bundledRoot);
+  if (bundled.length === 0) return nothing;
+  const shipped = new Set(bundled.map((s) => s.name));
+  const home = opts.home ?? homedir3();
+  const mine = (await scanFoundSkills(home)).filter((s) => s.source === "agents" && !shipped.has(s.name));
+  const chosen = [...defaultSkills(bundled), ...mine.map((s) => s.name)];
+  const result = await syncSkills({ homeSkillsDir, bundledRoot: opts.bundledRoot, chosen, home });
+  doc.skills = chosen;
+  await writeAtomic2(configWritePath(opts.dshHome), `${JSON.stringify(doc, null, 2)}
+`);
+  return { installed: result.installed, kept: mine.map((s) => s.name).filter((n) => result.installed.includes(n)) };
+}
+var NOT_BY_DEFAULT;
+var init_default_skills = __esm({
+  "src/setup/default-skills.ts"() {
+    "use strict";
+    init_compat();
+    init_simple();
+    init_skills();
+    NOT_BY_DEFAULT = ["remotion", "remotion-best-practices"];
+  }
+});
+
 // src/render/chars.ts
 function iconsFor(env = process.env, platform = process.platform) {
   if (appEnv("ASCII", env) === "1") return ASCII_ICONS;
@@ -1518,7 +1560,7 @@ var init_theme = __esm({
 // src/update.ts
 import { spawn } from "child_process";
 import { realpathSync } from "fs";
-import { mkdir as mkdir4, readFile as readFile4, rename as rename4, writeFile as writeFile4 } from "fs/promises";
+import { mkdir as mkdir4, readFile as readFile5, rename as rename4, writeFile as writeFile4 } from "fs/promises";
 import path5 from "path";
 function updateCachePath(dshHome, pathMod = path5) {
   return pathMod.join(dshHome, UPDATE_CACHE_FILE);
@@ -1533,7 +1575,7 @@ function updateCheckEnabled(opts) {
 async function readUpdateCache(dshHome, pathMod = path5) {
   try {
     const doc = JSON.parse(
-      await readFile4(updateCachePath(dshHome, pathMod), "utf8")
+      await readFile5(updateCachePath(dshHome, pathMod), "utf8")
     );
     if (typeof doc.checkedAt !== "number" || typeof doc.latest !== "string") return void 0;
     return { checkedAt: doc.checkedAt, latest: doc.latest };
@@ -1552,7 +1594,7 @@ async function writeUpdateCache(dshHome, cache, pathMod) {
 async function readBruineJsonDoc(dshHome) {
   try {
     return JSON.parse(
-      await readFile4(configReadPath(dshHome), "utf8")
+      await readFile5(configReadPath(dshHome), "utf8")
     );
   } catch {
     return {};
@@ -1761,8 +1803,8 @@ var init_keys = __esm({
 });
 
 // src/setup/flow.ts
-import { chmod as chmod2, mkdir as mkdir5, readFile as readFile5, rename as rename5, writeFile as writeFile5 } from "fs/promises";
-import { dirname as dirname3, join as join5 } from "path";
+import { chmod as chmod2, mkdir as mkdir5, readFile as readFile6, rename as rename5, writeFile as writeFile5 } from "fs/promises";
+import { dirname as dirname3, join as join6 } from "path";
 function roleFromModelRef(ref) {
   if (ref.provider === "deepseek-official") return { cloud: "deepseek-official", model: ref.model };
   if (typeof ref.baseUrl === "string" && ref.baseUrl !== "") {
@@ -1811,10 +1853,10 @@ function usesLocalServer(answers) {
 }
 async function commitPlan(dshHome, plan) {
   if (plan.env.some(([name]) => name === void 0)) throw new Error("bad env entry");
-  await writeAtom(join5(dshHome, "settings.yaml"), plan.settingsYaml, 384);
+  await writeAtom(join6(dshHome, "settings.yaml"), plan.settingsYaml, 384);
   let bruineJson = plan.bruineJson;
   try {
-    const previous = JSON.parse(await readFile5(configReadPath(dshHome), "utf8"));
+    const previous = JSON.parse(await readFile6(configReadPath(dshHome), "utf8"));
     if (previous.reasoningEffort !== void 0) {
       const doc = JSON.parse(bruineJson);
       doc.reasoningEffort = previous.reasoningEffort;
@@ -1825,7 +1867,7 @@ async function commitPlan(dshHome, plan) {
   }
   await writeAtom(configWritePath(dshHome), bruineJson, 384);
   for (const [name, value] of plan.env) {
-    await writeEnvVar(join5(dshHome, ".env"), name, value);
+    await writeEnvVar(join6(dshHome, ".env"), name, value);
   }
   await syncSkills(plan.skills);
 }
@@ -2141,7 +2183,7 @@ var init_flow = __esm({
 `,
           env,
           skills: {
-            homeSkillsDir: join5(opts.dshHome, "skills"),
+            homeSkillsDir: join6(opts.dshHome, "skills"),
             bundledRoot: opts.bundledSkillsRoot,
             chosen: a.skills
           }
@@ -3103,10 +3145,10 @@ import {
   isKeyRelease as isKeyRelease4,
   matchesKey as matchesKey4
 } from "@earendil-works/pi-tui";
-import { existsSync as existsSync6, readFileSync as readFileSync4 } from "fs";
+import { existsSync as existsSync7, readFileSync as readFileSync4 } from "fs";
 import { mkdir as mkdir6, rename as rename6, writeFile as writeFile6 } from "fs/promises";
-import { homedir as homedir3 } from "os";
-import { dirname as dirname4, join as join6, resolve } from "path";
+import { homedir as homedir4 } from "os";
+import { dirname as dirname4, join as join7, resolve } from "path";
 import { fileURLToPath } from "url";
 import { parse as parseYaml3 } from "yaml";
 async function setSuggestionsChoice(dshHome, value) {
@@ -3123,7 +3165,7 @@ function bundledSkillsRoot() {
   const dir = dirname4(fileURLToPath(import.meta.url));
   for (const up of [1, 2, 3]) {
     const candidate = resolve(dir, "..".repeat(up), "skills");
-    if (existsSync6(join6(candidate, "git-workflow", "SKILL.md"))) return candidate;
+    if (existsSync7(join7(candidate, "git-workflow", "SKILL.md"))) return candidate;
   }
   return resolve(dir, "..", "skills");
 }
@@ -3144,7 +3186,7 @@ function isExistingInstall(prefill) {
 function readEnvFile(dshHome) {
   const out = {};
   try {
-    for (const line of readFileSync4(join6(dshHome, ".env"), "utf8").split(/\r?\n/)) {
+    for (const line of readFileSync4(join7(dshHome, ".env"), "utf8").split(/\r?\n/)) {
       const m = /^([A-Z][A-Z0-9_]*)=(.*)$/.exec(line);
       if (m !== null && m[1] !== void 0 && m[2] !== void 0) out[m[1]] = m[2];
     }
@@ -3161,7 +3203,7 @@ function loadPrefill(dshHome) {
   }
   let settingsDoc;
   try {
-    settingsDoc = parseSettingsYaml(readFileSync4(join6(dshHome, "settings.yaml"), "utf8"));
+    settingsDoc = parseSettingsYaml(readFileSync4(join7(dshHome, "settings.yaml"), "utf8"));
   } catch {
     settingsDoc = void 0;
   }
@@ -3379,7 +3421,7 @@ function savedSkillsList(dshHome) {
 }
 function installedSkillsList(dshHome) {
   try {
-    const raw = JSON.parse(readFileSync4(manifestReadPath(join6(dshHome, "skills")), "utf8"));
+    const raw = JSON.parse(readFileSync4(manifestReadPath(join7(dshHome, "skills")), "utf8"));
     const names = Object.keys(raw).filter((n) => n !== "" && typeof raw[n] !== "undefined");
     return names.length > 0 ? names.sort((a, b) => a.localeCompare(b)) : [];
   } catch {
@@ -3392,8 +3434,10 @@ function initialSkillChecks(items, saved, found) {
     if (item.disabled === true) return;
     if (saved !== void 0) {
       if (saved.includes(item.value)) checked.add(i);
-    } else if (item.value !== "remotion" && item.value !== "remotion-best-practices" && (RECOMMENDED_SKILLS.includes(item.value) || found.some((f) => f.name === item.value && f.source === "agents"))) {
-      checked.add(i);
+    } else if (!NOT_BY_DEFAULT.includes(item.value)) {
+      const foundRow = found.find((f) => f.name === item.value);
+      const shipped = !item.value.startsWith("#") && foundRow === void 0;
+      if (shipped || RECOMMENDED_SKILLS.includes(item.value) || foundRow?.source === "agents") checked.add(i);
     }
   });
   return checked;
@@ -3588,6 +3632,9 @@ async function runFullSetup(dshHome, opts = {}) {
   async function drive() {
     const bundledRoot = opts.bundledSkillsRoot ?? bundledSkillsRoot();
     const bundled = await readBundledSkills(bundledRoot);
+    if (flow.answers.skills.length === 0 && savedSkillsList(dshHome) === void 0 && installedSkillsList(dshHome) === void 0) {
+      flow.answers.skills = defaultSkills(bundled);
+    }
     const showWelcome = async () => {
       keyHelp = "Enter continue  \xB7  Ctrl+C quit";
       status = "Bruine setup";
@@ -4208,7 +4255,7 @@ async function runFullSetup(dshHome, opts = {}) {
   }
   async function stepSkills(bundled) {
     displayStep = "skills";
-    const allFound = await scanFoundSkills(homedir3());
+    const allFound = await scanFoundSkills(homedir4());
     const shippedNames = new Set(bundled.map((s) => s.name));
     const found = allFound.filter((s) => !shippedNames.has(s.name));
     const project2 = await scanProjectSkills(process.cwd());
@@ -4232,7 +4279,7 @@ async function runFullSetup(dshHome, opts = {}) {
     const saved = skillsSubmitted ? flow.answers.skills : savedSkillsList(dshHome);
     const checked = initialSkillChecks(items, saved, found);
     const sel = await checkStep(
-      saved !== void 0 && saved.length > 0 ? `Skills: Space toggles, Enter continues, s skips (keeps ${String(saved.length)} enabled)` : "Skills: Space toggles, Enter continues, s skips (enables none)",
+      saved !== void 0 && saved.length > 0 ? `Skills: Space toggles, Enter continues, s skips (keeps ${String(saved.length)} enabled)` : "Skills: Space toggles, Enter continues, s skips (keeps the recommended ones)",
       items,
       checked
     );
@@ -4457,6 +4504,7 @@ var init_full = __esm({
     init_cloud();
     init_spacebunny();
     init_discover();
+    init_default_skills();
     init_skills();
     init_simple();
     init_update();
@@ -4625,7 +4673,7 @@ var init_config = __esm({
 });
 
 // src/mcp/state.ts
-import { mkdirSync, readFileSync as readFileSync6, renameSync, writeFileSync } from "fs";
+import { mkdirSync as mkdirSync2, readFileSync as readFileSync6, renameSync, writeFileSync } from "fs";
 import path7 from "path";
 function projectKey(dir, platform = process.platform) {
   const abs = path7.resolve(dir);
@@ -4643,7 +4691,7 @@ function readMcpState(home) {
   }
 }
 function writeMcpState(home, state2) {
-  mkdirSync(home, { recursive: true });
+  mkdirSync2(home, { recursive: true });
   const target = path7.join(home, MCP_STATE_FILE);
   const temp = `${target}.${String(process.pid)}.tmp`;
   writeFileSync(temp, `${JSON.stringify(state2, null, 2)}
@@ -4730,10 +4778,10 @@ var init_approve = __esm({
 // src/bin.ts
 init_compat();
 import { spawn as spawn2, spawnSync as spawnSync3 } from "child_process";
-import { existsSync as existsSync7, readFileSync as readFileSync7, realpathSync as realpathSync2 } from "fs";
+import { existsSync as existsSync8, readFileSync as readFileSync7, realpathSync as realpathSync2 } from "fs";
 import { createInterface } from "readline";
 import os from "os";
-import { dirname as dirname5, join as join7, resolve as resolve2 } from "path";
+import { dirname as dirname5, join as join8, resolve as resolve2 } from "path";
 import { fileURLToPath as fileURLToPath2 } from "url";
 import { createRequire as createRequire3 } from "module";
 
@@ -4802,7 +4850,7 @@ function flagMode(argv) {
 // src/profile.ts
 import { createRequire as createRequire2 } from "module";
 import { mkdir, readFile, rename, rm, stat, writeFile } from "fs/promises";
-import { existsSync as existsSync3, readFileSync as readFileSync2 } from "fs";
+import { existsSync as existsSync3, mkdirSync, readFileSync as readFileSync2, rmSync, symlinkSync } from "fs";
 import path3 from "path";
 import { parse as parseYaml } from "yaml";
 var require3 = createRequire2(import.meta.url);
@@ -4934,10 +4982,35 @@ async function ensureProfile(dshHome, pathMod = path3) {
   await writePersonaPatch(p.patchYml, dshHome, pathMod);
   return { created: true, dir };
 }
+function linkProfileBundles(profileDir, own, dshBaseDir) {
+  const type = process.platform === "win32" ? "junction" : "dir";
+  const link = (target, at) => {
+    mkdirSync(path3.dirname(at), { recursive: true });
+    rmSync(at, { recursive: true, force: true });
+    symlinkSync(target, at, type);
+  };
+  try {
+    const modules = path3.join(profileDir, "node_modules");
+    link(own.root, path3.join(modules, own.name));
+    link(dshBaseDir, path3.join(modules, "@deepseek-ai", "dsh-base"));
+    return true;
+  } catch {
+    return false;
+  }
+}
+function resolveDshBaseDir() {
+  try {
+    const dshRequire = createRequire2(require3.resolve("@deepseek-ai/dsh/package.json"));
+    return path3.dirname(dshRequire.resolve("@deepseek-ai/dsh-base/package.json"));
+  } catch {
+    return void 0;
+  }
+}
 
 // src/bin.ts
 init_simple();
 init_skills();
+init_default_skills();
 init_discover();
 init_theme();
 
@@ -5051,17 +5124,23 @@ var DSH_MISSING = "bruine: could not launch dsh (missing or broken install). Rei
 function selfPackageRoot() {
   try {
     const root = resolve2(dirname5(fileURLToPath2(import.meta.url)), "..");
-    const manifest = JSON.parse(readFileSync7(join7(root, "package.json"), "utf8"));
+    const manifest = JSON.parse(readFileSync7(join8(root, "package.json"), "utf8"));
     return manifest.name === pkg2.name ? root : void 0;
   } catch {
     return void 0;
   }
 }
 function ensureBundleInstalled(profileDir, dshEntry, env, headless = false) {
-  const marker = join7(profileDir, "node_modules", pkg2.name, "package.json");
-  if (existsSync7(marker)) return;
-  const spec = selfPackageRoot() ?? `${pkg2.name}@${pkg2.version}`;
+  const marker = join8(profileDir, "node_modules", pkg2.name, "package.json");
+  if (existsSync8(marker)) return;
+  const root = selfPackageRoot();
   if (!headless) console.log("Setting up bruine (one time)\u2026");
+  const dshBase = resolveDshBaseDir();
+  if (root !== void 0 && dshBase !== void 0 && linkProfileBundles(profileDir, { name: pkg2.name, root }, dshBase)) {
+    if (!headless) console.log("Ready.");
+    return;
+  }
+  const spec = root ?? `${pkg2.name}@${pkg2.version}`;
   const { status, error, output } = runDsh(
     dshEntry,
     ["plugin", "--profile", "bruine", "add", spec],
@@ -5090,12 +5169,12 @@ function readBruineJson(dshHome) {
 }
 async function printSkills(dshHome) {
   const { readInstalledSkills: readInstalledSkills2 } = await Promise.resolve().then(() => (init_skills(), skills_exports));
-  const skills = await readInstalledSkills2(join7(dshHome, "skills"));
+  const skills = await readInstalledSkills2(join8(dshHome, "skills"));
   if (skills.length === 0) {
     console.log("No skills enabled. Run `bruine setup` to pick skills.");
     return;
   }
-  console.log(`Skills enabled in ${join7(dshHome, "skills")}:`);
+  console.log(`Skills enabled in ${join8(dshHome, "skills")}:`);
   for (const s of skills) {
     const kind = s.copied === true ? "linked-copy" : s.kind;
     console.log(`  ${s.name}  ${kind}${s.source !== "" ? `  ${s.source}` : ""}`);
@@ -5139,7 +5218,7 @@ async function runUpdate() {
   let version = "unknown";
   try {
     const manifest = JSON.parse(
-      readFileSync7(join7(dirname5(real), "..", "package.json"), "utf8")
+      readFileSync7(join8(dirname5(real), "..", "package.json"), "utf8")
     );
     version = manifest.version ?? "unknown";
   } catch {
@@ -5273,7 +5352,7 @@ async function main() {
     console.error("bruine: --continue cannot be combined with -p");
     process.exit(2);
   }
-  if (!existsSync7(join7(dshHome, "settings.yaml"))) {
+  if (!existsSync8(join8(dshHome, "settings.yaml"))) {
     if (headless) {
       console.error("bruine: run `bruine setup` before using -p");
       process.exit(2);
@@ -5307,7 +5386,22 @@ async function main() {
   });
   const { dir } = await ensureProfile(dshHome);
   ensureBundleInstalled(dir, dshEntry, env, headless);
-  const migrated = await migrateAgentsSkills({ homeSkillsDir: join7(dshHome, "skills") });
+  const defaults = await ensureDefaultSkills({
+    dshHome,
+    bundledRoot: resolve2(dirname5(fileURLToPath2(import.meta.url)), "..", "skills")
+  });
+  const shipped = defaults.installed.filter((name) => !defaults.kept.includes(name));
+  const sayDefault = (said) => {
+    const line = process.stdout.isTTY === true ? ansi.dim(said) : said;
+    if (headless) console.error(line);
+    else console.log(line);
+  };
+  if (shipped.length > 0) sayDefault(`bruine: ${String(shipped.length)} skills are on (turn any off with bruine setup)`);
+  if (defaults.kept.length > 0) {
+    const k = String(defaults.kept.length);
+    sayDefault(`bruine: kept your ${k} skill${defaults.kept.length === 1 ? "" : "s"} from .agents/skills (manage them with bruine setup)`);
+  }
+  const migrated = await migrateAgentsSkills({ homeSkillsDir: join8(dshHome, "skills") });
   if (migrated.linked.length > 0) {
     const n = String(migrated.linked.length);
     const kept = `bruine: kept your ${n} skill${migrated.linked.length === 1 ? "" : "s"} from .agents/skills (manage them with bruine setup)`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ziamana/bruine",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Interactive terminal coding agent that runs your own models, local or OpenAI-compatible",
   "type": "module",
   "license": "MIT",