wellactually 0.0.0-stage → 0.11.0-rc.1

package/.claude-plugin/plugin.json

@@ -0,0 +1,20 @@
+{
+  "name": "wellactually",
+  "version": "0.11.0-rc.1",
+  "description": "Runs the principles on your Well Actually advisory board while your agent works, and lets it author and rate them.",
+  "author": {
+    "name": "Pascal Welsch"
+  },
+  "mcpServers": {
+    "wellactually": {
+      "command": "node",
+      "env": {
+        "WELLACTUALLY_REVIEW_HOST": "claude"
+      },
+      "args": [
+        "${CLAUDE_PLUGIN_ROOT}/dist/wellactually.mjs",
+        "mcp"
+      ]
+    }
+  }
+}

package/.codex-plugin/mcp.json

@@ -0,0 +1,13 @@
+{
+  "mcpServers": {
+    "wellactually": {
+      "command": "node",
+      "args": [
+        "./dist/wellactually.mjs",
+        "mcp"
+      ],
+      "cwd": ".",
+      "env": { "WELLACTUALLY_REVIEW_HOST": "codex" }
+    }
+  }
+}

package/.codex-plugin/plugin.json

@@ -0,0 +1,16 @@
+{
+  "name": "wellactually",
+  "version": "0.11.0-rc.1",
+  "description": "Runs the principles on your Well Actually advisory board while your agent works, and lets it author and rate them.",
+  "author": {
+    "name": "Pascal Welsch"
+  },
+  "skills": "./skills/",
+  "mcpServers": "./.codex-plugin/mcp.json",
+  "interface": {
+    "displayName": "Well Actually",
+    "shortDescription": "Engineering principles from the experts you choose.",
+    "developerName": "Pascal Welsch",
+    "category": "Productivity"
+  }
+}

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Pascal Welsch
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,238 @@
-# Temporary Holding Version
+<p align="center">
+  <img src="assets/illustration-dark.png#gh-dark-mode-only" width="420" alt="An experienced developer raises one finger over the shoulder of a coding robot">
+  <img src="assets/illustration-light.png#gh-light-mode-only" width="420" alt="An experienced developer raises one finger over the shoulder of a coding robot">
+</p>
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+<h1 align="center">Well Actually</h1>
+
+<p align="center">
+  Experts correct LLMs:<br>
+  <em>"Well actually, there's a better way to do this in [insert technology]."</em>
+</p>
+
+Your coding agent is a capable generalist.
+It has not spent years in your framework, your niche or closed source enterprise software.
+Well Actually brings what the experts there have learned into your agent.
+
+Principles are not hard rules like a linter's.
+They are advice, like an expert glancing over a diff who has seen a pattern go wrong twenty times: it is most likely wrong again, and there is a better way.
+Your agent hears it and decides.
+
+A principle is advice plus a detector.
+The detector looks at what your agent just did, and when it finds something, the agent reads the advice.
+Unlike a rules file, nothing sits in your agent's context up front: advice only enters it when it applies.
+Anyone can publish principles on [the Well Actually registry](https://wellactually.dev), and you choose whose principles sit on your advisory board.
+
+## Install
+
+The plugin needs [Node](https://nodejs.org) 20 or newer and nothing else.
+Check with `node --version` before you install it, because without Node no principle reaches your agent.
+
+Claude Code:
+
+```text
+/plugin marketplace add passsy/wellactually
+/plugin install wellactually@wellactually
+/wellactually:login
+```
+
+The last line connects this machine to your advisory board and downloads it.
+
+Claude Code leaves auto-update off for marketplaces outside Anthropic's own.
+To get new releases of the plugin, type `/plugin`, open the Marketplaces tab, select `wellactually` and choose Enable auto-update.
+
+Codex:
+
+```bash
+codex plugin marketplace add passsy/wellactually
+```
+
+```bash
+codex plugin add wellactually@wellactually
+```
+
+Then open Codex, type `/hooks` and press `t` to trust the plugin's hooks, then type `$wellactually:login`.
+Codex does not run a new plugin's hooks until you trust them, so no principle reaches the agent before that.
+
+OpenCode:
+
+```bash
+opencode plugin add 'github:passsy/wellactually#path:opencode'
+```
+
+Then open OpenCode and type `@wellactually-login`.
+`opencode plugin add` needs OpenCode 2.
+OpenCode 1 from version 1.18.29 runs the plugin too, from a clone of this repository, as [the install guide](https://wellactually.dev/docs/getting-started/install#opencode) shows, and there the skill is `/wellactually-login`.
+
+pi:
+
+```bash
+pi install git:github.com/passsy/wellactually
+```
+
+Then open pi and type `/skill:wellactually-login`.
+
+### CI and cloud agents
+
+A CI runner or a cloud agent starts on a fresh machine every run, where nobody can confirm a login code.
+Create a token on [your advisory board](https://wellactually.dev/advisory-board) under connected machines, and store it as the secret `WELLACTUALLY_TOKEN` where the agent runs.
+The plugin and the `wellactually` command then sign in with it and never write it to disk.
+Run `wellactually sync`, or the plugin's sync skill, at the start of the run, so the advisory board is there before the agent works.
+Ratings the agent gives reach the experts as they do from your own machine.
+Revoke the token on the website to stop it.
+
+When a newer release of the plugin is out, it tells you at the start of a session, at most once a day, with the command that updates it in your agent.
+Set `WELLACTUALLY_UPDATE_CHECK=0` to turn that off.
+
+## What it does on your machine
+
+- When your agent writes or reads a file, gets a prompt or is about to run a shell command, a hook shows that one input to the detectors on your advisory board.
+- A detector that finds something puts its expert's advice in front of the agent, once per session in full and as a pointer after that.
+- The hook never uses the network.
+  It reads the principles `sync` downloaded earlier.
+- `sync` runs when a session starts.
+  It downloads what is new on your advisory board and reports counts, see "What leaves your machine".
+- Once a day, in the background, it reads the version of the newest release of the plugin from this repository on GitHub.
+
+## Detectors are other people's code
+
+So they are contained.
+
+- A detector runs in a QuickJS WebAssembly isolate.
+  It gets its input as JSON and returns findings as JSON.
+  There is no network and no process inside.
+- It can read text files on your machine and cannot change any.
+  Without a network there is nowhere to send them, and the next point keeps them out of your agent's context.
+- It has 100 ms and 32 MB.
+  One that exceeds either is stopped and reported, and your agent carries on.
+- Whatever a detector reports must occur word for word in its input, or the finding is dropped.
+  A detector cannot compose text for your agent at runtime.
+- Each download is checked against its content hash before it is stored.
+- Updates to principles are automatic.
+  What an expert on your advisory board releases runs from your next sync, so follow the experts you trust.
+  You can switch off any single principle, or unfollow the expert.
+
+The code that does this is public: [`packages/core/src/detector/sandbox.ts`](packages/core/src/detector/sandbox.ts) is the isolate, and [`packages/cli/src/board/board.ts`](packages/cli/src/board/board.ts) runs an advisory board.
+
+## What leaves your machine
+
+- How often each principle fired: a day, a hash and a count.
+- A rating, when your agent gives one: the principle's hash and `up`, `down` or `not_applicable`.
+- Review selections, suggestions and completed fixes: the principle and pinned
+  revision, event time, an opaque deduplication ID, and priority for suggestions
+  and fixes. Reviews do not send helpfulness ratings.
+
+No path, file content, prompt, command or finding is sent.
+The daily look for a newer release of the plugin is a plain download from GitHub and sends nothing.
+Ask your agent to switch reporting off, and it turns these reports off.
+
+## Review a change
+
+The `review` skill checks changes, files, folders and projects against your advisory board, including principles without detectors. Git is optional.
+Read-only reviewers work through queues of applicable principles. An aggregator
+merges duplicate findings into one finding with multiple occurrences. Proof
+workers then investigate the findings in isolated worktrees. The report states
+coverage, executable proof and limitations; a finding need not have a test to
+be useful.
+
+Run `/wellactually:review` in Claude Code or `$wellactually:review` in Codex with a synced advisory board.
+Reviews use subagents where supported.
+The findings inbox keeps your accept, reject, note and fixed decisions locally.
+Posting accepted findings to the PR is a separate explicit action.
+
+The forthcoming npm distribution is built and tested from the same sources for
+all four hosts. The current Git installation commands above remain active until
+the registry rollout is complete; see [the release sequence](docs/releasing-review.md).
+
+## Write a principle
+
+A principle is a directory, and its name is the principle's id:
+
+```text
+avoid-late/
+  principle.md      the advice: a heading, one sentence of summary, then the rest
+  detector.ts       a handler per event it reacts to: onWrite, onRead, onDelete, onPrompt, onCommand, onOutput
+  detector.test.ts  the tests: what the detector reports for an event
+```
+
+A detector reads `onWrite({ globs: ["**/*.dart"], *detect(event) { ... yield { line: written.line }; } })`.
+A test reads `expect(detect(write("lib/user.dart", code))).toEqual([{ line: 2 }])`.
+The tests must pass, make the detector fire at least once, and show it staying quiet at least once.
+[Pascal's principles](https://wellactually.dev/e/passsy) on the registry are examples to read.
+
+Write one in the browser on [wellactually.dev](https://wellactually.dev/studio/new), with nothing installed, or ask your agent.
+The plugin gives it tools to create a principle, run its tests, try it on a file, probe a repository and publish it.
+Building a principle needs esbuild, which the plugin does not carry, so install the SDK in the repository that holds your principles, which brings it:
+
+```bash
+npm install --save-dev github:passsy/wellactually#sdk vitest
+```
+
+`npm test` then runs the principles' tests with vitest.
+
+A detector may import `@wellactually/sdk/v4`, which is in `packages/sdk`, its own files, and packages from npm that its `package.json` names.
+The `v4` is the detector API version it is written against.
+Version 4 added the lines a write removed, `event.removed`, and `onDelete` for a deleted file.
+A principle written against `v3` keeps running as it was.
+
+## What is in here
+
+| Path              | What it is                                                                            |
+| ----------------- | ------------------------------------------------------------------------------------- |
+| `hooks`, `skills` | The plugin: when the hook runs, and the skills such as `login`, `sync` and `audit`.   |
+| `dist`            | The command as one file, built from `packages/cli`. The plugin runs it.               |
+| `opencode`        | The plugin for OpenCode, with its own copy of the command and the skills.             |
+| `packages/core`   | Builds, checks and runs principles: the isolate, the bundler and the tests.           |
+| `packages/sdk`    | The types and helpers a detector may import.                                          |
+| `packages/cli`    | The command the plugin runs: the hook, the advisory board and the MCP server.         |
+| `evaluator`       | Checks with real agents that the framing around advice moves them the right way.      |
+| `scripts`         | Builds `dist` and `opencode`, sets the version of a release, writes the `sdk` branch. |
+
+The registry is not in this repository.
+
+## Build it yourself
+
+```bash
+npm install
+```
+
+```bash
+npm test
+```
+
+```bash
+npm run build
+```
+
+`npm run build` writes `dist/wellactually.mjs`, the file the plugin runs, and next to it `opencode.mjs` and `pi.mjs`, the plugins of OpenCode and pi.
+It also copies the command and the skills into `opencode`, which OpenCode installs on its own.
+Both folders are committed, because an agent installs a plugin from git without building it.
+
+## Release
+
+```bash
+node scripts/version.mjs 0.9.29
+```
+
+```bash
+npm run build
+```
+
+Commit the result as `Release 0.9.29` and push it.
+Agents update the plugin from `main`.
+
+The SDK is released to the `sdk` branch, from a checkout of it next to this one:
+
+```bash
+git worktree add ../wellactually-sdk sdk
+```
+
+```bash
+node scripts/release-sdk.mjs ../wellactually-sdk
+```
+
+Then commit it there as `Release 0.9.29` and push the `sdk` branch.
+
+## License
+
+[Apache License 2.0](LICENSE)

package/assets/README.md

@@ -0,0 +1,5 @@
+# assets
+
+The illustration at the top of the README.
+
+GitHub shows `illustration-dark.png` in its dark theme and `illustration-light.png` in its light theme.