altalandi 0.1.1 → 0.2.0

package/README.md

@@ -31,6 +31,27 @@ For an application dependency, install locally and import the package root:
 npm i altalandi
 ```
 
+## Updating
+
+```bash
+altalandi update          # check, then ask before updating
+altalandi update --check  # only report; change nothing
+altalandi --version
+```
+
+`altalandi update` checks npm for a newer version and asks before installing
+it. It works out how you installed the CLI (global, project dependency or `npx`)
+and runs the matching command. If you use Claude Code, it then offers to install
+or refresh the `/altalandi` skill that ships with each version. A skill you have
+edited is backed up before it is replaced.
+
+Nothing changes without your answer. Without a terminal to ask in (agents, CI,
+pipes) it only reports what is available; pass `--yes` when a script already has
+your consent.
+
+Exit codes: `0` up to date or updated · `10` an update is available but was not
+applied · `1` the check or the update failed.
+
 ## JavaScript / TypeScript client
 
 `refineVerified` requests the meaning gate and throws unless the API returns

package/altalandi.mjs

@@ -12,6 +12,48 @@
 import { refine } from "./client.mjs";
 
 const args = process.argv.slice(2);
+
+// Subcommands and meta flags are handled before anything that needs an API key
+// or input text. `altalandi update` checks for a newer CLI and skill and asks
+// before changing anything.
+let handled = false;
+if (args[0] === "update") {
+  handled = true;
+  const { runUpdate } = await import("./update.mjs");
+  const rest = args.slice(1);
+  if (rest.includes("-h") || rest.includes("--help")) { updateHelp(); process.exit(0); }
+  // exitCode, never process.exit(): the registry request can leave a socket
+  // mid-close, and exiting then aborts Node on Windows with a libuv assertion
+  // (UV_HANDLE_CLOSING). The refine path below exits the same way for the
+  // same reason.
+  process.exitCode = await runUpdate({
+    check: rest.includes("--check"),
+    yes: rest.includes("--yes") || rest.includes("-y"),
+    skillOnly: rest.includes("--skill-only"),
+  });
+}
+if (!handled && (args.includes("-v") || args.includes("--version"))) {
+  const { currentVersion } = await import("./update.mjs");
+  console.log(await currentVersion());
+  process.exit(0);
+}
+
+function updateHelp() {
+  console.log(`altalandi update — check for a newer version and update if you agree
+
+Usage:
+  altalandi update            check, then ask before updating the CLI and the /altalandi skill
+  altalandi update --check    only report; never change anything
+  altalandi update --yes      update without asking (for scripts that already have consent)
+
+Nothing changes without consent. Without a terminal to ask in (agents, CI,
+pipes) and without --yes, it only reports what is available.
+
+Exit codes: 0 up to date or updated · 10 an update is available but was not
+applied · 1 the check or the update failed.`);
+}
+
+if (!handled) {
 const opts = { domain: "general", register: "neutral", json: false, fast: false };
 const positional = [];
 for (let i = 0; i < args.length; i++) {
@@ -34,6 +76,10 @@ Usage:
   echo "text" | altalandi
   altalandi --domain marketing --register warm "text"
 
+Commands:
+  altalandi update     check for a newer version and update if you agree
+  altalandi --version  print the installed version
+
 Options:
   --domain     general | marketing | data-analysis | childrens-fiction  (default general)
   --register   formal | neutral | warm  (default neutral)
@@ -120,3 +166,4 @@ try {
   console.error("Request failed:", e.message);
   process.exit(1);
 }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "altalandi",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Hosted Altalandi API client and CLI for native-sounding Icelandic with meaning verification.",
   "type": "module",
   "main": "./client.mjs",
@@ -17,13 +17,15 @@
   },
   "files": [
     "altalandi.mjs",
+    "update.mjs",
+    "skill/SKILL.md",
     "client.mjs",
     "client.d.ts",
     "README.md",
     "LICENSE"
   ],
   "scripts": {
-    "test": "node --test test/cli.test.mjs test/client.test.mjs"
+    "test": "node --test test/cli.test.mjs test/client.test.mjs test/update.test.mjs"
   },
   "keywords": [
     "icelandic",

package/skill/SKILL.md

@@ -0,0 +1,105 @@
+---
+name: altalandi
+description: >-
+  MANUAL COMMAND — only run when the user explicitly invokes /altalandi. Do NOT
+  trigger automatically, and do not use it proactively on Icelandic writing tasks.
+  When invoked: refine English or stiff/AI-translated Icelandic into native
+  Icelandic via the Altalandi API, with a meaning-preservation check.
+---
+
+# Altalandi — native Icelandic, with a meaning guarantee
+
+Altalandi is a guarded pipeline, not a single model call: a frontier LLM rewrites
+to native register, a rule proofreader cleans up, then a validation gate checks
+meaning (back-translation **plus** deterministic invariants — numbers, dates,
+negation, legal force, names) and a **candidate veto** refuses any rewrite the
+pipeline itself has flagged as broken (invented words, a quoted defect, mojibake).
+Every change comes back as a diff with the reason.
+
+## How to call it
+
+When the user runs `/altalandi`, refine the target text via the API.
+
+1. **CLI, always with `--json`** — `npx altalandi --json "<text>"`. Flags:
+   `--domain`, `--register`. Needs `ALTALANDI_API_KEY` in the env.
+   **Use `--json` from an agent.** When a rewrite is refused, the plain-text mode
+   prints the reason as a `⚠` warning on stderr, but it also prints "meaning
+   preserved" and exits 0 — easy for an agent to misread as success. The JSON
+   carries `rewriteAttempted` and `rejectionReason`, which are unambiguous.
+   Run `npx altalandi update` now and then to get the latest CLI and this skill.
+2. **HTTP** — `POST https://altalandi.is/api/v1/refine` with
+   `Authorization: Bearer $ALTALANDI_API_KEY` and body `{ "text": "...", ... }`.
+
+(Do NOT rely on an MCP tool here — an MCP `refine_icelandic` tool is always available
+to the model, which defeats manual-only invocation. This command calls the CLI/HTTP
+directly so it only runs when you ask.)
+
+Auth: set **`ALTALANDI_API_KEY`** once in the shell env (or your project's `.env`).
+Existing `rtv_…` keys keep working — there is no rotation. Mint or view keys at
+https://altalandi.is/portal. Machine-readable docs: https://altalandi.is/llms-full.txt
+and https://altalandi.is/api/openapi.json.
+
+## Parameters
+
+- `text` (required) — the text to refine (English or Icelandic; auto-detected).
+- `domain` — `general` | `marketing` | `data-analysis` | `childrens-fiction`.
+- `register` — `formal` | `neutral` | `warm`.
+- `sourceLang` — `auto` (default) | `en` | `is`.
+
+## The non-negotiable contract — read the outcome, not one field
+
+An Icelandic→Icelandic call ends in one of three ways. Tell them apart before you
+use the output:
+
+| outcome | how to recognise it |
+|---|---|
+| **Rewritten and verified** | `output` differs from your text, `meaningPreserved: true`, `rejectionReason` empty |
+| **Rewrite refused — original returned** | `rewriteAttempted: true` and `rejectionReason` set. Causes: `MEANING DRIFT`, `HARD INVARIANT LOST`, `UNVERIFIED`, or `CANDIDATE VETO` (then `candidateVetoFired: true`, `candidateVetoSignal` says why) |
+| **Already fine — nothing to change** | `rewriteAttempted: false` |
+
+- **`meaningPreserved` alone is not enough.** A vetoed rewrite returns your
+  original with `meaningPreserved` still `true`: the meaning check passed, but the
+  rewrite was broken in another way. Check `rewriteAttempted` and `rejectionReason`.
+- `meaningPreserved: null` means **unverified**, not safe. For Icelandic input the
+  original comes back; for English input the translation comes back marked
+  unverified — do not present it as verified.
+- **When the original comes back, say so.** Don't report "Altalandi improved
+  this" when it declined to.
+- **Show the diffs.** When you apply Altalandi's output, surface what changed and
+  why, never silently replace the user's text.
+
+## The nativeness score is a hint, not a verdict
+
+`quality.nativenessScore` and `translationeseTells` point at likely problems, but
+the score has been measured to be confidently wrong in both directions: it gave a
+rewrite containing an invented word 82/100, and a perfectly fine rewrite 18/100.
+Treat a low score as "look at the tells", never as proof of bad Icelandic — and
+never as permission to override a refusal. A tell that **quotes** a specific phrase
+is far more trustworthy than the number.
+
+## When to use it
+
+- Producing or polishing user-facing Icelandic (web copy, UI strings, emails,
+  product text, children's prose).
+- You translated something to Icelandic and want it to not "sound translated".
+- Many strings at once: `POST /refine/batch`.
+
+## When NOT to use it
+
+- Non-Icelandic output. Code, identifiers, or data that must stay literal. Quotes
+  you must preserve verbatim (it may rephrase — check the diff).
+
+## `--fast` removes the safety net
+
+`--fast` (`scoreNativeness:false`, `scoring:"none"`) skips the meaning gate **and**
+leaves the candidate veto blind: with no BÍN morphology check and no nativeness
+tells, it cannot catch an invented or wrong word. Only mojibake is still caught.
+Use it only for throwaway text you will read yourself — never for anything shipped.
+
+## Notes
+
+- Usage is metered by a daily **word budget** per key (default 10,000 words/day;
+  429 when spent, resets 00:00 UTC).
+- A full call makes several model passes and is slower; that is the price of the
+  checks above.
+- Data is processed and discarded — not stored or trained on.

package/update.mjs

@@ -0,0 +1,271 @@
+// `altalandi update` — check for a newer CLI, ask before installing it, then
+// offer to install or refresh the /altalandi skill for Claude Code.
+//
+// Nothing is ever changed without consent. Interactive terminals get a y/N
+// prompt; non-interactive callers (agents, CI, pipes) are only told what is
+// available, unless they pass --yes, which is itself the explicit consent.
+//
+// Zero dependencies, like the rest of the CLI.
+
+import { spawn } from "node:child_process";
+import { copyFile, mkdir, readFile, writeFile } from "node:fs/promises";
+import { existsSync, realpathSync } from "node:fs";
+import { homedir } from "node:os";
+import path from "node:path";
+import { createInterface } from "node:readline/promises";
+import { fileURLToPath } from "node:url";
+
+export const PACKAGE = "altalandi";
+export const REGISTRY_URL = `https://registry.npmjs.org/${PACKAGE}/latest`;
+
+// Exit codes. 10 is deliberately distinct from the refine command's 1/2/3 so a
+// script can tell "an update exists" apart from "something failed".
+export const EXIT_OK = 0;
+export const EXIT_CHECK_FAILED = 1;
+export const EXIT_UPDATE_AVAILABLE = 10;
+
+const HERE = path.dirname(fileURLToPath(import.meta.url));
+export const BUNDLED_SKILL = path.join(HERE, "skill", "SKILL.md");
+
+export async function currentVersion() {
+  const pkg = JSON.parse(await readFile(path.join(HERE, "package.json"), "utf8"));
+  return pkg.version;
+}
+
+/** Semver-ish compare: -1 if a<b, 0 if equal, 1 if a>b. A prerelease sorts
+ *  before its release (0.2.0-beta < 0.2.0). */
+export function compareVersions(a, b) {
+  const parse = (v) => {
+    const [core, pre = ""] = String(v).trim().replace(/^v/, "").split("-", 2);
+    return { nums: core.split(".").map((n) => Number.parseInt(n, 10) || 0), pre };
+  };
+  const x = parse(a);
+  const y = parse(b);
+  for (let i = 0; i < 3; i++) {
+    const d = (x.nums[i] || 0) - (y.nums[i] || 0);
+    if (d !== 0) return d < 0 ? -1 : 1;
+  }
+  if (x.pre === y.pre) return 0;
+  if (!x.pre) return 1;
+  if (!y.pre) return -1;
+  return x.pre < y.pre ? -1 : 1;
+}
+
+export async function fetchLatestVersion({ fetchImpl = globalThis.fetch, timeoutMs = 8000 } = {}) {
+  const controller = new AbortController();
+  const timer = setTimeout(() => controller.abort(), timeoutMs);
+  try {
+    const res = await fetchImpl(REGISTRY_URL, {
+      signal: controller.signal,
+      headers: { accept: "application/json" },
+    });
+    if (!res.ok) throw new Error(`npm registry answered ${res.status}`);
+    const body = JSON.parse(await res.text());
+    if (!body || typeof body.version !== "string") throw new Error("npm registry returned no version");
+    return body.version;
+  } finally {
+    clearTimeout(timer);
+  }
+}
+
+const norm = (p) => {
+  let out = path.resolve(p);
+  try { out = realpathSync(out); } catch { /* keep the resolved path */ }
+  return process.platform === "win32" ? out.toLowerCase() : out;
+};
+
+/** How is this copy of the CLI being run? That decides what "update" means.
+ *
+ *  npx    — lives in npm's _npx cache; there is nothing to install, but a bare
+ *           `npx altalandi` can keep reusing an old cached copy
+ *  global — `npm install -g altalandi`
+ *  local  — a project dependency
+ *  source — a checkout of the repository; npm cannot update that
+ */
+export function detectInstall({ scriptPath, globalRoot }) {
+  const p = norm(scriptPath);
+  const sep = path.sep === "\\" ? /[\\/]/ : /\//;
+  const parts = p.split(sep);
+  if (parts.includes("_npx")) return "npx";
+  const nm = parts.lastIndexOf("node_modules");
+  if (nm === -1) return "source";
+  if (globalRoot && p.startsWith(norm(globalRoot) + (process.platform === "win32" ? "\\" : "/"))) {
+    return "global";
+  }
+  return "local";
+}
+
+/** The exact command that updates this install. Constants only — never built
+ *  from user input. */
+export function updatePlan(kind, { projectDir } = {}) {
+  switch (kind) {
+    case "global":
+      return { cmd: "npm", args: ["install", "-g", `${PACKAGE}@latest`], show: `npm install -g ${PACKAGE}@latest` };
+    case "local":
+      return { cmd: "npm", args: ["install", `${PACKAGE}@latest`], cwd: projectDir, show: `npm install ${PACKAGE}@latest` };
+    case "npx":
+      return { cmd: "npx", args: ["--yes", `${PACKAGE}@latest`, "--version"], show: `npx ${PACKAGE}@latest` };
+    default:
+      return null;
+  }
+}
+
+/** Where Claude Code looks for personal skills. */
+export function skillTarget({ env = process.env, home = homedir() } = {}) {
+  const root = env.CLAUDE_CONFIG_DIR || path.join(home, ".claude");
+  return { root, file: path.join(root, "skills", PACKAGE, "SKILL.md") };
+}
+
+/** missing | current | outdated. `absent` means Claude Code itself is not set
+ *  up, in which case the skill is not offered at all — never create ~/.claude
+ *  for someone who does not use it. */
+export async function skillStatus({ bundled = BUNDLED_SKILL, target = skillTarget() } = {}) {
+  if (!existsSync(bundled)) return "unbundled";
+  if (!existsSync(target.root)) return "absent";
+  if (!existsSync(target.file)) return "missing";
+  const [a, b] = await Promise.all([readFile(bundled, "utf8"), readFile(target.file, "utf8")]);
+  const clean = (s) => s.replace(/\r\n/g, "\n").trim();
+  return clean(a) === clean(b) ? "current" : "outdated";
+}
+
+/** Install or refresh the skill. An existing copy is always backed up first:
+ *  people edit their skills, and an update must never silently eat that. */
+export async function writeSkill({ bundled = BUNDLED_SKILL, target = skillTarget(), now = new Date() } = {}) {
+  await mkdir(path.dirname(target.file), { recursive: true });
+  let backup = null;
+  if (existsSync(target.file)) {
+    const stamp = now.toISOString().replace(/[:.]/g, "-");
+    backup = `${target.file}.bak-${stamp}`;
+    await copyFile(target.file, backup);
+  }
+  await writeFile(target.file, await readFile(bundled, "utf8"), "utf8");
+  return { file: target.file, backup };
+}
+
+function run(plan) {
+  return new Promise((resolve) => {
+    // npm and npx are .cmd shims on Windows, which need a shell. The arguments
+    // are constants from updatePlan(), so there is nothing to inject.
+    const child = spawn(plan.cmd, plan.args, {
+      cwd: plan.cwd,
+      stdio: "inherit",
+      shell: process.platform === "win32",
+    });
+    child.on("error", () => resolve(1));
+    child.on("close", (code) => resolve(code ?? 1));
+  });
+}
+
+function npmGlobalRoot() {
+  return new Promise((resolve) => {
+    const child = spawn("npm", ["root", "-g"], { shell: process.platform === "win32" });
+    let out = "";
+    child.stdout?.setEncoding("utf8").on("data", (c) => { out += c; });
+    child.on("error", () => resolve(null));
+    child.on("close", () => resolve(out.trim() || null));
+  });
+}
+
+async function ask(question, { input = process.stdin, output = process.stderr } = {}) {
+  const rl = createInterface({ input, output });
+  try {
+    const answer = (await rl.question(`${question} [y/N] `)).trim().toLowerCase();
+    return answer === "y" || answer === "yes" || answer === "j" || answer === "já";
+  } finally {
+    rl.close();
+  }
+}
+
+/**
+ * The whole command. Every side effect is injectable so it can be tested
+ * without touching npm, the network or the real home directory.
+ */
+export async function runUpdate(flags, io = {}) {
+  const log = io.log || ((m) => process.stderr.write(`${m}\n`));
+  const interactive = io.interactive ?? Boolean(process.stdin.isTTY && process.stderr.isTTY);
+  const confirm = io.confirm || ask;
+  const execute = io.run || run;
+  const target = io.skillTarget || skillTarget();
+  const bundled = io.bundledSkill || BUNDLED_SKILL;
+
+  // --check never changes anything. Without a terminal and without --yes there
+  // is nobody to ask, so the same rule applies: report, don't act.
+  const mayAct = !flags.check && (flags.yes || interactive);
+  const consent = async (q) => (flags.yes ? true : confirm(q));
+
+  const installed = io.currentVersion || await currentVersion();
+
+  if (!flags.skillOnly) {
+    let latest;
+    try {
+      latest = io.latestVersion || await fetchLatestVersion({ fetchImpl: io.fetch });
+    } catch (e) {
+      log(`Could not check for updates: ${e.message}`);
+      return EXIT_CHECK_FAILED;
+    }
+
+    if (compareVersions(installed, latest) < 0) {
+      const scriptPath = io.scriptPath || fileURLToPath(new URL("./altalandi.mjs", import.meta.url));
+      // `npm root -g` spawns npm, so only ask it when the answer matters: a copy
+      // inside some node_modules that is not npx's cache.
+      const inNodeModules = /[\\/]node_modules[\\/]/.test(scriptPath) && !/[\\/]_npx[\\/]/.test(scriptPath);
+      const globalRoot = io.globalRoot !== undefined ? io.globalRoot
+        : (inNodeModules ? await (io.npmGlobalRoot || npmGlobalRoot)() : null);
+      const kind = io.installKind || detectInstall({ scriptPath, globalRoot });
+      const plan = updatePlan(kind, { projectDir: io.projectDir || process.cwd() });
+      log(`A new version of ${PACKAGE} is available: ${installed} → ${latest}`);
+
+      if (!plan) {
+        log("This copy runs from a source checkout, so npm cannot update it. Pull the repository instead.");
+        return EXIT_UPDATE_AVAILABLE;
+      }
+      if (!mayAct) {
+        log(`Update with:  ${plan.show}`);
+        return EXIT_UPDATE_AVAILABLE;
+      }
+      if (!(await consent(`Update ${PACKAGE} to ${latest} now?`))) {
+        log(`Skipped. Update later with:  ${plan.show}`);
+        return EXIT_UPDATE_AVAILABLE;
+      }
+      log(`Running: ${plan.show}`);
+      const code = await execute(plan);
+      if (code !== 0) {
+        log(`Update failed (exit ${code}). Try running it yourself:  ${plan.show}`);
+        return EXIT_CHECK_FAILED;
+      }
+      log(`Updated to ${latest}.`);
+      // The skill that ships with the NEW version is the one worth installing,
+      // and this process is still the old one. Hand over to the new CLI.
+      const handoff = kind === "npx"
+        ? { cmd: "npx", args: ["--yes", `${PACKAGE}@latest`, "update", "--skill-only", ...(flags.yes ? ["--yes"] : [])] }
+        : { cmd: PACKAGE, args: ["update", "--skill-only", ...(flags.yes ? ["--yes"] : [])] };
+      await execute(handoff);
+      return EXIT_OK;
+    }
+    log(`${PACKAGE} ${installed} is up to date.`);
+  }
+
+  const status = await skillStatus({ bundled, target });
+  if (status === "unbundled" || status === "absent") return EXIT_OK;
+  if (status === "current") {
+    log("The /altalandi skill for Claude Code is up to date.");
+    return EXIT_OK;
+  }
+  const what = status === "missing"
+    ? `Install the /altalandi skill for Claude Code (${target.file})?`
+    : "Your /altalandi skill for Claude Code differs from this version. Replace it (your copy is backed up first)?";
+  if (!mayAct) {
+    log(status === "missing"
+      ? "The /altalandi skill for Claude Code is not installed. Run `altalandi update` in a terminal to install it."
+      : "Your /altalandi skill for Claude Code is out of date. Run `altalandi update` in a terminal to refresh it.");
+    return flags.skillOnly ? EXIT_OK : EXIT_UPDATE_AVAILABLE;
+  }
+  if (!(await consent(what))) {
+    log("Skill left unchanged.");
+    return EXIT_OK;
+  }
+  const written = await writeSkill({ bundled, target, now: io.now });
+  log(`Skill ${status === "missing" ? "installed" : "updated"}: ${written.file}`);
+  if (written.backup) log(`Previous copy saved as: ${written.backup}`);
+  return EXIT_OK;
+}