beeverforge 0.1.0__tar.gz

beeverforge-0.1.0/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 The BeeverForge Authors
+
+   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.
+

beeverforge-0.1.0/NOTICE

@@ -0,0 +1,22 @@
+BeeverForge
+https://beeverforge.com
+
+Copyright 2026 The BeeverForge Authors
+
+Licensed under the Apache License, Version 2.0 (the "License"); see LICENSE.
+
+THE CODE IS FREE; THE NAME IS NOT.
+
+Apache-2.0 grants you every right to use, modify, fork and redistribute this software,
+including commercially. It grants no right to the "BeeverForge" name, logo or marks.
+
+That split is deliberate and it is the whole protection strategy. A
+restrictive licence would buy protection against a problem this project does not have —
+a hyperscaler reselling it — at the cost of the adoption it is trying to buy. What is
+worth defending is the mark, and the mark is only worth defending because the conformance
+suite gives it meaning.
+
+So: anyone may fork. Only builds that pass the published conformance suite
+(`beeverforge conformance`, `beeverforge conformance-adapter`) may be called BeeverForge.
+That is the Kubernetes mechanism — permissive licence, defended mark, conformance as the
+gate.

beeverforge-0.1.0/PKG-INFO

@@ -0,0 +1,187 @@
+Metadata-Version: 2.4
+Name: beeverforge
+Version: 0.1.0
+Summary: A framework to run software tickets autonomously with coding agents — policies authorize actions, humans evaluate results.
+Author: The BeeverForge Authors
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://beeverforge.com
+Project-URL: Documentation, https://github.com/BeeverForge/beeverforge-oss/blob/main/docs/README.md
+Project-URL: Repository, https://github.com/BeeverForge/beeverforge-oss
+Project-URL: Changelog, https://github.com/BeeverForge/beeverforge-oss/releases
+Project-URL: Issues, https://github.com/BeeverForge/beeverforge-oss/issues
+Project-URL: Security, https://github.com/BeeverForge/beeverforge-oss/blob/main/SECURITY.md
+Keywords: sdlc,agents,automation,devops,ai
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: pydantic>=2.7
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: typer>=0.12
+Requires-Dist: httpx>=0.27
+Requires-Dist: pyjwt[crypto]>=2.8
+Requires-Dist: python-dotenv>=1.0
+Requires-Dist: fastapi>=0.111
+Requires-Dist: uvicorn>=0.30
+Requires-Dist: websockets>=12
+Provides-Extra: runtime
+Requires-Dist: temporalio>=1.29; extra == "runtime"
+Provides-Extra: ingest
+Requires-Dist: pypdf==6.19.0; extra == "ingest"
+Provides-Extra: embed
+Requires-Dist: model2vec==0.9.0; extra == "embed"
+Provides-Extra: dev
+Requires-Dist: ruff>=0.5; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
+Requires-Dist: bandit>=1.7; extra == "dev"
+Requires-Dist: pytest>=8.2; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
+Requires-Dist: types-pyyaml; extra == "dev"
+Requires-Dist: temporalio>=1.29; extra == "dev"
+Requires-Dist: pytest-randomly>=3.15; extra == "dev"
+Requires-Dist: pytest-xdist>=3.6; extra == "dev"
+Requires-Dist: pypdf==6.19.0; extra == "dev"
+Requires-Dist: readme-renderer[md]>=43; extra == "dev"
+Dynamic: license-file
+
+# BeeverForge
+
+**An autonomous software factory.** It takes tickets from your board and returns reviewed pull
+requests — planned, implemented, validated by *your* test suite, independently reviewed, and
+merged under the policy you chose. Humans stop authorising every step and start evaluating
+results; production stays behind a human gate, always.
+
+It is **not a coding agent** — it orchestrates the ones you already use behind one adapter
+contract. It is **not a SaaS** — it runs on your machines, against your board, with your
+credentials, and no cloud account is required.
+
+[Website](https://beeverforge.com) ·
+[Source](https://github.com/BeeverForge/beeverforge-oss) ·
+[What works today](https://github.com/BeeverForge/beeverforge-oss/blob/main/docs/STATUS.md) ·
+[Releases](https://github.com/BeeverForge/beeverforge-oss/releases)
+
+## One machine, from PyPI
+
+Your own repository and the coding agent you already pay for: **one credential, no Docker, no
+account anywhere**. The factory branches from your repository, opens a pull request in it, reviews
+the change and fast-forwards your base.
+
+Prerequisites: git, Python 3.12+, and a coding agent's CLI on your PATH, already signed in
+(`claude`, `codex` or `opencode` — the coding agents, below, say where each one stands).
+
+```bash
+python3 -m venv .venv && source .venv/bin/activate
+pip install 'beeverforge[runtime]'            # the durable engine's worker runs on the extra
+
+beeverforge init                              # the defaults: your code and your tickets live HERE
+beeverforge project init myapp ~/code/myapp   # a path registers as itself — no owner, no board
+beeverforge doctor myapp                      # on this door, green IS the prerequisite list
+beeverforge box prove myapp                   # nothing is picked up until this is green
+beeverforge up                                # the panel, the worker and the durable engine
+```
+
+`init` answered with its defaults writes `~/.beeverforge/env` and asks for no credential at all:
+the harness signs in as you, with the login it already has. `project init` scaffolds
+`.beeverforge/project.yaml` in your repository — commit it on your base branch, because that file
+is what the factory reads to know how to build and check your project.
+
+`up` serves the panel at `http://localhost:8787` — the Board, the job, the pull request. It starts
+the durable engine only when the `temporal` binary is on your PATH as well, and names whatever is
+missing. Without the engine everything attended still works — the panel, and
+`beeverforge poll myapp`, which takes what is in TO-DO one card at a time — and what waits for it
+is the human merge gate, park/resume and every deadline.
+
+The whole door, including what happens to your working tree when a merge lands, is
+[docs/setup/one-machine.md](https://github.com/BeeverForge/beeverforge-oss/blob/main/docs/setup/one-machine.md).
+
+## A team deployment, with Docker
+
+The other door: the compose stack, a real forge and a real board, several people watching the same
+panel. **Docker, and only Docker** on the host — no Python, no `sudo`, one line:
+
+```bash
+curl -fsSL https://beeverforge.com/install.sh | sh
+```
+
+The installer resolves the newest release, checks the release's files against their published
+checksums, pulls the published images (`ghcr.io/beeverforge/beeverforge-worker`,
+`beeverforge-sandbox` and `beeverforge-cli`, pinned to that release) and starts the stack. It
+sends nothing anywhere; there is no telemetry in this project.
+
+**Two credentials are irreducible for a real ticket** — the coding agent's
+(`CLAUDE_CODE_OAUTH_TOKEN` from `claude setup-token`, or `ANTHROPIC_API_KEY`) and a forge
+credential (a PAT to try things out, a GitHub App for real use). `beeverforge preflight` says what
+is still missing, one line each with a remedy. Register a project inside the worker:
+
+```bash
+cd beeverforge && docker compose --env-file .env.compose exec worker \
+  beeverforge project init myapp https://github.com/<owner>/myapp.git
+```
+
+**Upgrading** is the same installer with `--force` (and the same `--dir`, if you gave one): it
+resolves the newest release, pulls it and restarts the stack. Every value in your `.env.compose`
+survives, credentials included, and only the pinned version moves. Your data lives in named
+volumes, which only `--uninstall` removes.
+
+```bash
+curl -fsSL https://beeverforge.com/install.sh | sh -s -- --force
+```
+
+The guided first hour on your own codebase is
+[docs/ONBOARDING.md](https://github.com/BeeverForge/beeverforge-oss/blob/main/docs/ONBOARDING.md).
+
+## The coding agents
+
+One adapter contract, chosen per project and per role in the registry (`harness:`), and so is the
+model each one runs.
+
+| agent | `harness:` | where it stands |
+|---|---|---|
+| Claude Code | `claude_code` | the default |
+| Codex | `codex` | has completed real tickets; its plumbing is not at parity yet (no credential pool, no durable resume across containers) |
+| OpenCode | `opencode` | proven end to end; one binary that reaches several model providers, so the provider is a `model:` |
+| Kimi Code | `kimi` | **does not run yet** — the adapter is wired and `kimi-code` refuses the way it is started (#362) |
+
+## Optional extras
+
+| extra | what it adds | without it |
+|---|---|---|
+| `beeverforge[runtime]` | the durable engine's client library, which the worker runs on | `run`, `poll` and the panel work; the merge gate, park/resume and the deadlines wait for it |
+| `beeverforge[ingest]` | the product role reads the PDFs in a product's context repository (their text layer; scanned ones need `tesseract` and `pdftoppm` on the machine) | every PDF is recorded as unreadable, by name, and everything else is read |
+| `beeverforge[embed]` | the product's memory index searches by meaning, with a model in a folder on your machine — nothing is downloaded | the index answers by exact words, metadata and date, and every search says so |
+
+## Why this one
+
+- **Policies authorise, humans evaluate.** The manifest declares the merge policy, the quality
+  floor and the promotion chain; a project with no declared test command is *held*, not "passed".
+- **The box is proven before money is spent.** `beeverforge box prove` runs your own `setup:` and
+  `validate:` inside the real sandbox before any ticket is picked up.
+- **Every stall speaks.** A blocked job parks with executable options for a human; a silent
+  forever-wait is treated as the platform's own defect.
+- **Provider axes, not provider lock-in.** Tracker, board, forge, CI observer, notifier, coding
+  agent and sandbox are independent adapters — GitHub Issues and Projects, Jira, Azure DevOps, or
+  the local rows that need no account — chosen per project.
+- **An independent review, structurally.** The reviewer can run on a different engine from the
+  executor, so "you did not write this code" is true by construction.
+- **Honest docs.** What does not work is written down before you decide anything.
+
+## Documentation
+
+- [The documentation map](https://github.com/BeeverForge/beeverforge-oss/blob/main/docs/README.md),
+  and [every command](https://github.com/BeeverForge/beeverforge-oss/blob/main/docs/reference/cli.md)
+- [What works today, and what does not](https://github.com/BeeverForge/beeverforge-oss/blob/main/docs/STATUS.md)
+- [Releases and their notes](https://github.com/BeeverForge/beeverforge-oss/releases)
+- [Security policy](https://github.com/BeeverForge/beeverforge-oss/blob/main/SECURITY.md) — report a vulnerability privately, never in a public issue
+- [Contributing](https://github.com/BeeverForge/beeverforge-oss/blob/main/CONTRIBUTING.md)
+- Licence: [Apache-2.0](https://github.com/BeeverForge/beeverforge-oss/blob/main/LICENSE);
+  the [NOTICE](https://github.com/BeeverForge/beeverforge-oss/blob/main/NOTICE) separates
+  the free code from the defended brand

beeverforge-0.1.0/README.md

@@ -0,0 +1,252 @@
+<p>
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="docs/assets/logo-dark.svg">
+    <img src="docs/assets/logo-light.svg" alt="BeeverForge" width="320">
+  </picture>
+</p>
+
+# BeeverForge
+
+**An autonomous software factory.** It takes tickets from your board and returns reviewed pull
+requests — planned, implemented, validated by *your* test suite, independently reviewed, and
+merged under the policy you chose. Humans stop authorising every step and start evaluating
+results; production stays behind a human gate, always.
+
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12%2B-blue.svg)](pyproject.toml)
+
+It is **not a coding agent** — it orchestrates the ones you already use (Claude Code, Codex,
+Kimi, OpenCode) behind one adapter contract. It is **not a SaaS** — it runs on your machines,
+against your board, with your credentials, and no cloud account is required.
+
+## Why this one
+
+- **Policies authorise, humans evaluate.** The manifest declares the merge policy, the quality
+  floor and the promotion chain; the factory refuses vacuous green — a project with no declared
+  test command is *held*, not "passed".
+- **The box is proven before money is spent.** `box prove` runs your own `setup:` and
+  `validate:` inside the real sandbox before any ticket is picked up. A misconfigured
+  environment is a named finding, not a burned agent pass.
+- **Every stall speaks.** A blocked job parks with executable options for a human; a silent
+  forever-wait is treated as the platform's own defect class.
+- **Provider axes, not provider lock-in.** Tracker, board, forge, CI observer, notifier, coding
+  agent and sandbox are independent adapters — GitHub Issues + Projects, Jira, Azure DevOps
+  (work items → Azure Repos PRs, end to end), chosen per project in a registry.
+- **An independent review, structurally.** The reviewer can run on a *different* engine from the
+  executor, so "you did not write this code" is true by construction.
+- **Honest docs.** What does not work is written down (`docs/STATUS.md`)
+  before you decide anything.
+
+## Quickstart — one machine
+
+The shortest path is your own repository and the coding agent you already pay for: **one
+credential, no Docker, no account anywhere**. The factory branches from your repository, opens a
+pull request in it, reviews the change and fast-forwards your base.
+
+Prerequisites: git, Python 3.12+, and a coding agent on your PATH already signed in (`claude`,
+`codex`, `kimi` or `opencode`).
+
+```bash
+git clone https://github.com/BeeverForge/beeverforge-oss.git && cd beeverforge-oss
+python3 -m venv .venv && source .venv/bin/activate      # 3.12+; see docs/ONBOARDING.md §0
+pip install -e '.[runtime]'                             # the durable engine's worker runs on the extra
+
+beeverforge init                         # press Enter twice: your code and your tickets live HERE
+beeverforge project init myapp ~/code/myapp   # a path registers as itself — no owner, no board
+beeverforge doctor myapp                 # on this door, green IS the prerequisite list
+
+beeverforge act card_create -p myapp -P title="Add a health endpoint" -P body="## Objective
+Serve 200 at /health
+
+## Acceptance criteria
+- GET /health returns 200"
+beeverforge act card_move -p myapp -i 1 -P column=TO-DO
+beeverforge poll myapp                   # one card, all the way to Done
+```
+
+`beeverforge serve` serves the same thing in a browser at http://localhost:8787 — the Board, the
+job, the pull request. The whole door is **[docs/setup/one-machine.md](docs/setup/one-machine.md)**,
+including what happens to your working tree when a merge lands.
+
+## Quickstart — with Docker, on a hosted forge
+
+The other door: the compose stack, a real forge and a real board, several people watching the same
+panel. **Two credentials are irreducible here** — the coding agent's
+(`CLAUDE_CODE_OAUTH_TOKEN` from `claude setup-token`, or `ANTHROPIC_API_KEY`) and a forge
+credential (a PAT to try things out, a GitHub App for real use). Docker is asked for at this hour,
+not before.
+
+**Docker. Only Docker.** No Python on the host, no `sudo`, one line:
+
+```bash
+curl -fsSL https://beeverforge.com/install.sh | sh
+```
+
+| | |
+|---|---|
+| **read it first** | `curl -fsSL https://beeverforge.com/install.sh -o install.sh && less install.sh && sh install.sh` |
+| **no script at all** | the four commands below |
+
+> The worker mounts the host's Docker socket — that is how `sandbox: container` starts a box, and
+> it is root-equivalent on the host. It is the same trade `docker compose up` has always made here.
+
+> The installer sends nothing anywhere. There is no telemetry in this project.
+
+Re-running the installer with `--force` is the upgrade path: it resolves the newest release, pulls
+it, and restarts the stack. Every value in your `.env.compose` survives it, credentials included,
+and only the pinned version moves. Your data lives in named volumes, which only `--uninstall`
+removes.
+
+**A specific version, or a release candidate.** `--version <tag>` installs that release instead of
+the newest (`… | sh -s -- --version v0.1.0`). A release candidate (`v0.1.0-rc.1`), published
+before a version so it can be tested, is installed **only** this way: the one line above, the
+wheel on PyPI and every other "newest" keep giving the last final release. How to install, test
+and leave a candidate: [Installing a candidate](docs/RELEASING.md#installing-a-candidate).
+
+<a id="the-un-piped-equivalent"></a>
+Prefer to do it by hand? These are the same four steps, and nothing else:
+
+```bash
+REPO=https://github.com/BeeverForge/beeverforge-oss
+VERSION=$(curl -fsSLI -o /dev/null -w '%{url_effective}' $REPO/releases/latest); VERSION=${VERSION##*/tag/}
+curl -fsSL $REPO/releases/download/$VERSION/docker-compose.yml -o docker-compose.yml
+curl -fsSL $REPO/releases/download/$VERSION/SHA256SUMS | sha256sum -c --ignore-missing
+docker run --rm -it -v "$PWD:/out" -u "$(id -u):$(id -g)" \
+  ghcr.io/beeverforge/beeverforge-cli:$VERSION init --out /out/.env.compose
+echo "BEEVERFORGE_VERSION=$VERSION" >> .env.compose
+docker pull ghcr.io/beeverforge/beeverforge-sandbox:$VERSION
+docker compose --env-file .env.compose up -d
+```
+
+Three of those lines look optional and are not. The **version is resolved once** and written into
+`.env.compose`, because `docker-compose.yml` defaults to `main` — right for a contributor working
+on the branch, wrong for anybody running a factory. The **box image is pulled by hand** because
+`docker compose up` does not fetch it: the worker launches it as a sibling container on your own
+daemon. And the **checksums are verified**, which is why the files come from the release rather
+than from the website — a static host can serve a file and cannot checksum one.
+
+Then open http://localhost:8787 in a browser — the panel (8080 is the engine's own UI).
+
+**Two credentials are irreducible for a real ticket** — the coding agent's
+(`CLAUDE_CODE_OAUTH_TOKEN` from `claude setup-token`, or `ANTHROPIC_API_KEY`) and a forge
+credential (a PAT to try things out, a GitHub App for real use). `beeverforge init` asks for
+neither and names both; only the agent's cannot be postponed past the first hour.
+
+`beeverforge preflight` says what is still missing on this machine, one line each with a remedy.
+
+Register a project **inside the worker** (the compose stack has its own registry; a
+laptop-registered project is invisible to it). One command registers it and creates the board
+with the platform's columns:
+
+```bash
+docker compose --env-file .env.compose exec worker \
+  beeverforge project init myapp https://github.com/<owner>/myapp.git   # your org or username
+docker compose --env-file .env.compose exec worker beeverforge doctor myapp
+```
+
+(`project add` is the variant for a board you already have, or for none at all. On Azure
+DevOps, register with your `dev.azure.com` clone URL — it carries the
+organisation/project/repository, and Azure Boards ships with the project, so there is no board
+to create: **[docs/setup/azure-devops.md](docs/setup/azure-devops.md)**.)
+
+`doctor` runs nine checks always and up to four more when they apply, naming every missing
+prerequisite with its remedy — including the
+agent credential and the forge credential. From there, the guided first hour is
+**[docs/ONBOARDING.md](docs/ONBOARDING.md)**: the environment session that reads your repository
+and proposes its own manifest, the box proof, a costed rehearsal on a synthetic ticket, and the
+first real card.
+
+## Your first ticket
+
+An ordinary issue, in English or Portuguese:
+
+```markdown
+## Objective
+Users can export their report as CSV.
+
+## Acceptance criteria
+- a `GET /reports/{id}/export` endpoint returns text/csv
+- the export respects the report's current filters
+```
+
+Drag it to **TO-DO**. The factory sizes it, proves the box, plans, implements, runs *your*
+gates, opens the PR, has it independently reviewed — and with `merge_policy: human` (the
+recommended start) waits for your merge. The panel at `:8787` shows every step live.
+
+## The shape
+
+```
+beeverforge/
+├── contracts/     Pydantic models — the framework↔project↔agent↔board interface
+├── registry.py    the set of projects one deployment drives (add one = data, not code)
+├── policy/        the quality floor: stack presets + org defaults + conformance
+├── adapters/      the provider axes — a project mixes them freely; the core ships GitHub,
+│   │              Azure DevOps and Jira on every axis below that has a vendor, and an
+│   │              add-on package adds a kind through the `beeverforge.adapters` entry points
+│   ├── tracker/     GitHub Issues, Jira, Azure DevOps work items
+│   ├── board/       GitHub Projects, Jira status, Azure DevOps boards
+│   ├── forge/       GitHub, Azure Repos — branches, PRs, merges, tags
+│   ├── environment/ CI / deploy / health, read-only — GitHub Actions, Azure Pipelines
+│   ├── agent/       CodingAgentAdapter — Claude Code, Codex, Kimi, OpenCode
+│   ├── reviewer/    the independent review
+│   ├── channel/     the panel — the reference surface; a chat channel is an add-on package (beeverforge-slack)
+│   └── sandbox/     container = real; worktree = local/test; a cloud box is an add-on package (beeverforge-aws)
+├── orchestrator/  the deterministic state machine (the spine)
+├── runtime/       the durable engine (Temporal): poller, jobs, promotion tail
+└── cli.py         `beeverforge` — project-first commands
+```
+
+## The roles you can switch on
+
+| role | what it is | where it lives |
+|---|---|---|
+| **engineering loop** | ticket → reviewed PR → merge | on by default; this README |
+| **post-merge** | watch your deploy, walk your stages, gate production | opt-in per project — [ONBOARDING §13](docs/ONBOARDING.md) says what silence means |
+| **tech-lead** | diagnoses parked jobs, proposes the fix, acts on your yes | the panel; a chat channel such as Slack is an add-on package (beeverforge-slack), never a prerequisite |
+| **product owner** | requirements as reviewed docs in a context repo; accept/queue/release | `/product/<name>` on the panel — [docs/reference/product-role.md](docs/reference/product-role.md) |
+| **release gate** | production is approved by a named human with a password, always | [docs/reference/product-role.md §3](docs/reference/product-role.md) |
+
+## Documentation
+
+**One path, three references.** The map is [docs/README.md](docs/README.md); this is the short
+form:
+
+| read this | when |
+|---|---|
+| [docs/ONBOARDING.md](docs/ONBOARDING.md) | **start here** — the whole guided session on your own codebase, and the only onboarding there is |
+| [docs/setup/one-machine.md](docs/setup/one-machine.md) | one repository, one terminal, one credential — the door that needs no account anywhere |
+| [docs/setup/github.md](docs/setup/github.md) | the path sends you here for GitHub: the App screen by screen, a personal account's board token, a board by hand |
+| [docs/setup/azure-devops.md](docs/setup/azure-devops.md) | …or here for the all-Microsoft side: PAT scopes, board states, registration by clone URL |
+| [docs/setup/previews.md](docs/setup/previews.md) | a change running before its pull request merges: what the deployment needs to run and serve previews |
+| [docs/STATUS.md](docs/STATUS.md) | the honest read before deciding anything |
+| [docs/reference/configuration.md](docs/reference/configuration.md) | manifest / registry / environment — who owns which setting, promotion chains |
+| [docs/reference/cli.md](docs/reference/cli.md) | every command (the `env`/`box`/`product` surfaces are walked in ONBOARDING) |
+| [docs/reference/product-role.md](docs/reference/product-role.md) | switching on the product owner |
+| [docs/writing-an-addon.md](docs/writing-an-addon.md) | your deployment needs a provider the core does not ship — a row, end to end, editing nothing here |
+| [docs/adr/](docs/adr/) | why it is built this way (58 decision records) |
+
+## Status
+
+Working, and honest about where. The whole loop — sizing → box proof → agent → your gates → PR
+→ independent review → merge — has run end to end on four stacks (Python,
+serverless TypeScript, .NET, multi-repo) against real GitHub, real Jira and real Azure DevOps.
+The suite runs in both orders on every change and new guards are proven by mutation before they
+count — the current size, the commit it was measured at, and everything that is NOT settled are
+in [`docs/STATUS.md`](docs/STATUS.md), which is the one place any of those numbers live.
+
+BeeverForge was previously released as OpenFactory, up to 0.7.0 (`openfactory` on PyPI).
+BeeverForge 0.1.0 is OpenFactory 0.7.0 under a new name; its earlier history is at
+<https://github.com/BeeverForge/openfactory-core>.
+
+## Taking part
+
+Issues and pull requests are welcome, and the bar is written down rather than implied:
+[CONTRIBUTING.md](CONTRIBUTING.md) explains the house rules (a guard for every behaviour, a
+mutation for every guard) and how to add a provider to an axis without touching the core.
+**There is no CLA** — Apache-2.0 §5 already covers what you submit, and you keep the copyright
+on what you write. Everyone taking part is held to the [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## License
+
+[Apache-2.0](LICENSE). The [NOTICE](NOTICE) file separates the free code from the defended
+brand. Security reports: see [SECURITY.md](SECURITY.md). Contributions: [CONTRIBUTING.md](CONTRIBUTING.md).