avorelo 0.4.0-rc.5 → 1.0.0

package/LICENSE

@@ -1,21 +1,202 @@
-MIT License
-
-Copyright (c) 2026 ClaudeCode Optimizer contributors
-
-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.
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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/NOTICE

@@ -0,0 +1,15 @@
+Avorelo
+Copyright 2026 Benjamin Persky
+
+This product includes software developed by Benjamin Persky.
+
+Licensed under the Apache License, Version 2.0 (the "License"); you may not use
+this software 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,67 +1,173 @@
-# Avorelo
-
-Avorelo is a local-first trust-and-reduction layer for AI coding work, centered on runtime intervention and guided recovery.
-It reduces waste, setup burden, and trust failures at the moment of work, then helps the user continue cleanly and wrap up with confidence.
-
-## Positioning
-- Works locally first. Team integrations can come later.
-- Get value in workflow before you connect anything.
-- Free for individual developers. Valuable from the first session.
-- Avorelo is not a dashboard-first product, governance suite, agent platform, or generic analytics layer.
-- The product center is runtime intervention plus guided recovery.
-- Evidence, reports, usage visibility, and commands matter because they support trust, proof of value, and re-entry.
-
-## Primary Docs
-- Install and activation: `docs/INSTALL.md`
-- Activation flow details: `docs/ACTIVATION.md`
-- Support diagnostics: `docs/SUPPORT-DIAGNOSTICS.md`
-- Public website activation copy: `docs/WEBSITE-ACTIVATION-COPY.md`
-- Distribution truth: `node bin/avorelo public-distribution --json`
-- Production web source-of-record decision: `docs/AVORELO-PRODUCTION-WEB-DECISION.md`
-- Public website source-of-record and deploy contract: `docs/AVORELO-PUBLIC-WEBSITE.md`
-- Live rollout status: see `docs/AVORELO-DOMAIN-DEPLOYMENT.md`
-- Wasp hosting recommendation: `docs/AVORELO-WASP-HOSTING.md`
-
-## Distribution Status
-
-> **Distribution status: ready to publish.** `npx avorelo@latest activate` is the target public install command, pending npm publication verification.
->
-> Target public commands: `npx avorelo@latest activate` and `npx avorelo@latest activate --connect <token>`. These commands will work once npm publication is verified.
->
-> Repo-local developer path: `npm run avorelo:activate` (from this repository) or `node bin/avorelo activate`.
->
-> Run `node bin/avorelo public-distribution --json` to see current distribution truth status.
-
-## Public Brand
-- Product name: `Avorelo`
-- CLI name: `avorelo`
-- Public activation command: `npx avorelo@latest activate`
-- Repo-local activation command: `npm run avorelo:activate`
-- Public site target: `https://avorelo.com`
-- Public website source-of-record: `apps/public-web/`
-- Support: `support@avorelo.com`
-- Compatibility reference only. No partnership or endorsement implied.
-
-## First-Use Path
-
-> Use `npx avorelo@latest activate` in the project where you want Avorelo to run. Use `npm run avorelo:activate` when you are developing Avorelo from this repository.
-
-1. Open a terminal inside the project where you use Claude Code, Codex, VS Code, Cursor, or Windsurf.
-2. Run `npx avorelo@latest activate`.
-3. If you already have an account token, optionally run `npx avorelo@latest activate --connect <token>`.
-4. Continue in local/free mode even if account connection is skipped or fails.
-5. Let Avorelo stay quiet unless it needs to intervene, guide recovery, or support wrap-up and re-entry.
-
-If something does not work, run:
-
-- `npx avorelo@latest support --text`
-- `npx avorelo@latest support --json`
-
-Then review the output before sharing.
-
-## License
-- MIT
-
-## Support
-
-For customer support and activation help, contact `support@avorelo.com`.
+# Avorelo
+
+**AI Work Control.** Avorelo runs *around* your AI coding tool. It does not generate code — it keeps the
+work focused, keeps secrets out of the model, and saves proof of what actually happened, locally.
+
+> **Status.** Avorelo is **Open Source** under the **Apache License 2.0**, local-first by design. The
+> earlier hosted service (accounts, cloud sync, billing) was **discontinued** — the CLI needs no account,
+> no billing, and no cloud backend. Personal, internal, organizational, and commercial use are all
+> permitted under Apache-2.0 (see [License](#license)). Release candidate `1.0.0-rc.1`.
+
+## What it is
+
+A bundled Node CLI that runs entirely on your machine. No signup, no account, no database, no server.
+All state is local JSON under `.avorelo/` in your project.
+
+## Install
+
+```
+npm install -g avorelo@next
+avorelo --help
+```
+
+Or run from a local checkout:
+
+```
+npm ci
+npm run build
+node src/avorelo/surfaces/cli/avorelo.ts --help
+```
+
+Requires Node.js >= 24. Zero runtime dependencies.
+
+## Quickstart
+
+```
+avorelo activate --target .          # detect your project and set up local state
+avorelo status --target .            # workspace state and the next command
+avorelo run "run tests" --target .   # start a focused work session
+avorelo control-center --target .    # read-only local view of all local state
+```
+
+`activate` writes only local metadata under `.avorelo/` — no source, env, or secrets.
+`status` always tells you the next command.
+
+## What a run does
+
+```
+avorelo run "fix the login redirect bug in src/auth" --target .
+```
+
+1. **Routes** the task through a deterministic **Secret Boundary** — a pasted credential is detected and
+   never printed, persisted, or sent to the model; an unsafe task is blocked.
+2. Starts a **session** around whatever AI coding tool you already use.
+3. Compiles a **bounded, source-aware context** (references, never raw dumps).
+4. Carries forward **next-run continuity** so the next session resumes safely.
+5. Records **token & cost evidence** — honestly labelled `measured` / `imported` / `estimated` /
+   `inferred` / `unavailable`. Unavailable is never reported as zero, and numbers are never fabricated.
+6. Builds a **proof report** — savings are **refused** unless there is comparative evidence.
+7. Updates a **value ledger** of compact, confidence-labelled cards.
+
+## Commands
+
+| Command | What it does |
+|---|---|
+| `avorelo activate` | Detect, repair, install run-entry guidance; write local activation state |
+| `avorelo status` | Activation + session status, and the next command |
+| `avorelo run "<task>"` | The focused work session above |
+| `avorelo resume` | Resume an interrupted session |
+| `avorelo control-center` | Read-only local view of all session/proof/value state |
+| `avorelo open` | Local receipts dashboard (html/json/text) |
+| `avorelo doctor` | Health check (adapters, hooks, session) |
+| `avorelo report build` · `avorelo value cards` | Proof report · value cards |
+| `avorelo context check` · `avorelo context status` | Agent context integrity / freshness |
+| `avorelo loop check "<task>"` · `loop start` · `loop status` | Bounded AI loop |
+| `avorelo browser qa run` | Explicit, user-directed Browser Visual QA (see below) |
+| `avorelo support bundle` | Write a sanitized local support bundle |
+| `avorelo update-check` | Explicit update check against the public npm registry |
+| `avorelo settings show` · `settings reset` | Local settings (no automatic-update preference exists) |
+| `avorelo uninstall` | Remove all Avorelo-managed content |
+| `avorelo --help` | Full command list |
+
+Run `avorelo --help` for the complete, authoritative surface.
+
+## Where your data lives
+
+Everything is local, under `.avorelo/` in your project:
+
+- `workspace.json`, `activation/` — workspace identity and activation state
+- `settings.json` — local settings
+- `receipts/` — work receipts and proof
+- `support/` — sanitized support bundles you create yourself
+
+Nothing is uploaded. Delete the directory (or run `avorelo uninstall`) to remove it.
+
+## Privacy and network model
+
+Ordinary local operation makes **zero outbound network requests** — activation, status, doctor, run,
+resume, hooks, the viewer, Control Center, receipts, context and proof all work fully offline. There is
+no telemetry, no usage reporting, no account, and no cloud receipt upload.
+
+Exactly two paths can produce a request, and neither sends project data to an Avorelo-operated origin:
+
+- **Explicit update check** — `avorelo update-check` performs one bounded `GET` to the fixed public npm
+  registry URL (`https://registry.npmjs.org/avorelo/latest`) to compare versions. No payload, no
+  redirects, no identifying data. It is never automatic.
+- **Explicit Browser Visual QA** — `avorelo browser qa run` launches a headless browser (requires
+  Playwright) against a **local** target by default, served over a `127.0.0.1` loopback server. It
+  contacts an external host only if *you* pass an explicit `--target` URL that clears the safety policy.
+  It uploads nothing and contacts no Avorelo endpoint.
+
+Printing a link (GitHub, npm, docs) is not a network request — nothing opens automatically.
+
+See [Privacy](docs/privacy-and-learning.md).
+
+## Support and contact
+
+`avorelo support bundle` writes a sanitized, allowlisted JSON + Markdown artifact under
+`.avorelo/support/`. Secrets, source, env values, prompts, logs and diffs are excluded by construction.
+Nothing is sent — review the files, then attach them yourself only if you choose to.
+
+- **General support:** [support@avorelo.com](mailto:support@avorelo.com?subject=Avorelo%20support) · see [SUPPORT.md](SUPPORT.md)
+- **Bugs and questions:** https://github.com/HappyLifeSaaS/Avorelo/issues
+- **Optional paid services:** [support@avorelo.com](mailto:support@avorelo.com?subject=Avorelo%20services%20inquiry) · see [COMMERCIAL-SERVICES.md](COMMERCIAL-SERVICES.md)
+- **Security:** [SECURITY.md](SECURITY.md) (GitHub private reporting, with email fallback)
+
+Apache-2.0 already grants your rights to use Avorelo; paid services are optional and separate.
+
+## Architecture
+
+Local-first by construction:
+
+- a bundled Node CLI (`dist/avorelo.mjs`), zero runtime dependencies
+- local filesystem state under `.avorelo/`; local receipts and evidence
+- local Control Center / dashboard / viewer; local loopback preview server
+- explicit Browser Visual QA; local support bundle
+- a static public website (Netlify)
+- **no** API server, auth, database, billing, cloud sync, or telemetry upload
+
+Package boundary: runtime dependencies **zero**; devDependencies **esbuild** and **tsx**; the npm tarball
+ships exactly `LICENSE`, `NOTICE`, `README.md`, `bin/avorelo.mjs`, `dist/avorelo.mjs`, `package.json`.
+
+See [docs/architecture](docs/architecture/).
+
+## Contributing
+
+Contributions are **welcome** — see [CONTRIBUTING.md](CONTRIBUTING.md). Ordinary contributions require a
+[DCO](DCO) sign-off (`git commit -s`) but **no CLA**. Local development needs only Node and npm — no
+database, no credentials, no environment configuration:
+
+```
+npm ci              # esbuild + tsx only
+npm run build       # bundle the CLI
+npm run test:local  # full local test suite
+npm run dogfood:all # deterministic local dogfood suite
+npm run build:site && npm run site:check
+```
+
+See [docs/development](docs/development/).
+
+## Requirements
+
+Node.js >= 24.
+
+## License
+
+**Apache License 2.0.** Copyright 2026 Benjamin Persky. See [`LICENSE`](LICENSE) and [`NOTICE`](NOTICE);
+`package.json` declares `"license": "Apache-2.0"`.
+
+Avorelo is **Open Source**. Apache-2.0 permits personal, internal, organizational, and commercial use,
+including modification and redistribution, subject to the license terms (preserve copyright/license/
+NOTICE, state significant changes, etc.). No fee and no separate license are required to use it. Optional
+paid services are separate — see [COMMERCIAL-SERVICES.md](COMMERCIAL-SERVICES.md). Avorelo is not
+affiliated with or endorsed by the Apache Software Foundation.

package/bin/avorelo.mjs

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+// Avorelo CLI entry point for npm package distribution.
+// Loads the pre-built JS bundle so it works inside node_modules.
+import { fileURLToPath, pathToFileURL } from "node:url";
+import { resolve, dirname } from "node:path";
+const dist = resolve(dirname(fileURLToPath(import.meta.url)), "..", "dist", "avorelo.mjs");
+await import(pathToFileURL(dist).href);