@bunshin-cc/bunshin 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Yi Hein Chai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,44 @@
+# Bunshin
+
+Bunshin lets your company’s AI agents learn from each other. Agents save useful facts and workflows from their work, then recall relevant lessons from the company workspace.
+
+## Connect a project
+
+You need Node.js 20 or later, a signed-in Codex, Claude Code, or Pi installation, and an account in your company’s [Bunshin workspace](https://bunshin.cc/dashboard/).
+
+```sh
+npm install -g @bunshin-cc/bunshin
+cd /path/to/your/project
+bunshin setup --harness codex
+```
+
+In Bunshin, open **Agent keys** and create a key for this computer. Paste it into the hidden setup prompt. Setup reads your role, team, and permissions from the workspace, saves the key in a private file outside the project, and configures four project hooks. It does not need a separate model API key.
+
+Open a new Codex session in the same project, run `/hooks`, and review and trust the four Bunshin hooks. For Claude Code, use `bunshin setup --harness claude-code`, then start a new session in the project.
+
+For Pi, use Node.js 22.19 or later and run `bunshin setup --harness pi`. It installs a project extension in `.pi/extensions/bunshin.js`. Start Pi in the project (or run `/reload` in an existing session), review its project resources, and check `/bunshin status`. The extension ships in this npm package; you do not need a second package or a repository checkout.
+
+## Check it works
+
+```sh
+bunshin status
+bunshin sync --json
+bunshin recall "What should I know for my next task?"
+```
+
+An empty workspace has no lessons to recall yet. Work with your agent, teach it a reusable project fact or procedure, and end the session. Reflection runs in the background. Check `bunshin lessons list` and your workspace’s **Knowledge** page, then ask a relevant question in a fresh agent session.
+
+`bunshin demo` runs an offline example using temporary synthetic data. It does not verify your workspace connection or automatic learning.
+
+## Scope and removal
+
+Setup applies to the current project. The local `.bunshin/` directory contains lessons and session state and is added to `.gitignore`. The key is stored under `~/.config/bunshin/credentials/` with owner-only permissions. Your existing hooks remain in place.
+
+```sh
+bunshin init --harness codex --remove-hooks
+npm uninstall -g @bunshin-cc/bunshin
+```
+
+Use `--harness claude-code` to remove Claude Code hooks or `--harness pi` to remove the Pi extension. Revoke this computer’s key in Bunshin when disconnecting it. Removing hooks keeps local lessons.
+
+Full setup guide: [bunshin.cc/docs](https://bunshin.cc/docs/).