superbee 0.1.4 → 0.1.5-pre.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "superbee",
-  "version": "0.1.4",
+  "version": "0.1.5-pre.2",
   "type": "module",
   "description": "Agent-facing Superbee CLI for reading and writing local OKF knowledge bundles: context notes, docs, cross-links, and live bundle Views.",
   "keywords": [
@@ -50,9 +50,9 @@
   "scripts": {
     "build": "node build.mjs local-dev",
     "build:npm-package": "node build.mjs npm-package",
-    "typecheck": "tsc --noEmit",
+    "typecheck": "tsc --noEmit && tsc -p tsconfig.test.json",
     "pretest": "node build.mjs local-dev",
-    "test:host-class": "node scripts/run-test-command.mjs node --test --import ./test/ts-loader.mjs ./test/private-state-bundle-boundary.test.ts ./test/filesystem-cross-process-cas.test.ts ./test/link.test.ts ./test/promote-pull.test.ts ./test/recipe-source.test.ts",
+    "test:host-class": "node scripts/run-test-command.mjs node --test --import ./test/ts-loader.mjs ./test/private-state-bundle-boundary.test.ts ./test/filesystem-cross-process-cas.test.ts ./test/link.test.ts ./test/promote-pull.test.ts ./test/recipe-source.test.ts ./test/command-text.test.ts",
     "test": "node scripts/run-test-command.mjs node --test --import ./test/ts-loader.mjs ./test/*.test.ts",
     "mutation": "node scripts/run-test-command.mjs npm-exec stryker run",
     "gen:skill": "node scripts/gen-skill.mjs",
@@ -75,5 +75,7 @@
     "jsonc-parser": "3.3.1",
     "pako": "2.1.0",
     "typescript": "^5.4.0"
-  }
+  },
+  "readme": "# superbee\n\n## What is Superbee?\n\nSuperbee gives AI coding agents shared, versioned, conflict-safe memory — as a folder of\nplain markdown in your repo.\n\nAgents forget everything between sessions, overwrite each other's work, and keep what they\nknow invisible to the humans they work for. Superbee fixes all three:\n\n- **Memory that persists.** Agents write context notes, decisions, plans, and research into a\n  knowledge bundle that survives the session. The next session — or a different agent — picks\n  up exactly where the last one left off. An optional `SessionStart` hook (Claude Code, Codex,\n  OpenCode) orients every new session automatically.\n- **Safe for many writers.** Every document write is compare-and-swap versioned and attributed\n  to an actor. Two agents racing on the same document get a clean, typed conflict instead of a\n  silent lost update — and `doc history` shows who changed what, when.\n- **Visible to humans.** Everything is plain markdown you can open in any editor, render on\n  GitHub, and diff in git. `superbee ui` serves the bundle locally as rendered, cross-linked\n  pages with derived backlinks, a live activity feed, and launchable bundle Views. `superbee\n  sync` shares the bundle with teammates on a dedicated `board` branch — pulling their changes\n  and pushing yours without touching your code.\n- **Views on demand.** Ask your agent to create whatever representation you need and Superbee will\n  create it: a self-contained HTML View, registered in the bundle as a typed document, that\n  `superbee ui` launches in a sandboxed iframe. A reading surface for one dense document, a board, a\n  timeline, a filtered queue, a chart, a dashboard — the shape follows the question rather than a\n  fixed set of built-in screens, and a view worth keeping stays. A data View reads live bundle\n  content through a narrow read-only bridge and refreshes as documents change. Views are bundle\n  content, so they travel with `sync` and open the same way for a teammate's agent.\n- **Agent-native by design.** The CLI follows the AXI principles for agent-facing tools:\n  structured, token-lean output; result counts and truncation with explicit escape hatches;\n  idempotent mutations; structured errors with a small, stable exit-code taxonomy. Agents get\n  predictable responses they can act on without parsing prose or flooding their context window.\n- **Yours, and portable.** Bundles conform to the Open Knowledge Format — new bundles are\n  written as OKF v0.2, and existing v0.1 bundles stay supported in place — so they survive the\n  tool: hand the folder to someone else, or read it with anything that speaks markdown.\n  Everything works offline; the filesystem is the source of truth. Typed document schemas\n  (\"kinds\") live in the bundle itself, so the bundle describes its own structure.\n\nThe npm package ships one self-contained executable with zero runtime dependencies, plus an\nAgent Skill that teaches agents how to use it.\n\n## How do I download Superbee on Windows?\n\n**Requirements: Node.js 20 or newer on macOS, Linux, or native Windows.** You do not need WSL,\nUbuntu, or Docker. On Windows, Superbee keeps per-user operational state under\n`%LOCALAPPDATA%\\Superbee`; npm installs the command as `superbee.cmd`.\n\nSuperbee currently has two npm release channels:\n\n- `latest` is the stable channel selected by bare `superbee`. Its current release predates native\n  Windows support.\n- `next` is the prerelease channel. It contains the current native-Windows build.\n\nInstall the current prerelease on Windows:\n\n```powershell\nnpm install -g superbee@next\nsuperbee.cmd setup\n```\n\nOn macOS or Linux, the stable channel remains available with `npm install -g superbee`. To test the\nsame prerelease as Windows, install `superbee@next` instead.\n\nAfter installation, ask your AI agent to run `superbee setup` (`superbee.cmd setup` when invoking\nthe Windows shim explicitly). Setup walks the agent through Agent Skill, SessionStart hook, and MCP\nregistration. It is read-only: it inspects your configuration and returns one safe next command at\na time, so the agent performs any actual changes with your approval.\n\nThe managed Agent Skill works in Claude Code, Codex, and OpenCode. OpenCode discovers Superbee from\nits documented Claude-compatible Skill path. It shares Claude Code's Skill bytes by default; if\nClaude Code is explicitly relocated, the installer manages the two documented host paths separately.\n\nUpgrading from the legacy `@holaxis/aslite` package or the retired marketplace plugin? Install\n`superbee` alongside it, have your agent run `superbee setup` to migrate the exact legacy\nintegrations, then remove the old package with `npm uninstall -g @holaxis/aslite`. Existing\n`.agentstate-lite/` bundles and `.agentstate.json` bindings keep working with no migration.\n\n## How to use Superbee\n\nSuperbee is agent-first: you don't type its commands yourself — you ask your agent for what\nyou need, and the Agent Skill included with this package helps the agent translate your\ninstructions into CLI commands. For example:\n\n- \"Set up a Superbee workspace for this project and track our tasks in it.\"\n- \"Write up what we decided about the auth design as a doc, and link it to the task.\"\n- \"What did the last session leave off on? Check the context notes.\"\n- \"Sync the board so my teammate's agent sees this.\"\n- \"Give me a view of the open tasks grouped by owner.\"\n\nBehind those requests, the agent drives a small, predictable CLI: `init` creates a bundle in a\nconventional `.superbee/` folder (discovered automatically, the way git finds `.git`); `new`,\n`doc write`, `doc update`, and `link add` create and connect typed documents; `list` and\n`doc read` query them; `sync` shares the board with teammates.\n\nWhen you want to see the knowledge yourself, ask the agent to open it — or run the two\nhuman-facing commands directly:\n\n```sh\nsuperbee ui --open        # the bundle, rendered: pages, links, backlinks, live Views\nsuperbee doc open <id>    # one exact document in the same local browser reader\n```\n\nRun `superbee --help` (or any subcommand with `--help`) for the full command reference.\nDesign and format docs live in the [repository](https://github.com/Holaxis-ai/superbee).\n\n## License\n\nApache-2.0 © 2026 Holaxis\n",
+  "readmeFilename": "README.md"
 }