pi-hofund 0.0.0-stage → 0.2.0

package/INTENT

@@ -0,0 +1,13 @@
+-- INTENT --
+
+This software is offered freely under the Mozilla Public License 2.0.
+
+But understand it was not built for authoritarians, profiteers, or those who trade in harm.
+
+If you turn this work against people or the planet, I want no part in what you build.
+
+I trust those who build with care. But if you use this work to advance systems of harm, I intently hope it fails when you need it most.
+
+Your intent, regardless of your will - shall find it's way back to you.
+
+(Flynn)

package/LICENSE

@@ -0,0 +1,382 @@
+# Mozilla Public License Version 2.0
+
+1. Definitions
+
+---
+
+1.1. "Contributor"
+means each individual or legal entity that creates, contributes to
+the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+means the combination of the Contributions of others (if any) used
+by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+means Source Code Form to which the initial Contributor has attached
+the notice in Exhibit A, the Executable Form of such Source Code
+Form, and Modifications of such Source Code Form, in each case
+including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+means a work that combines Covered Software with other material, in
+a separate file or files, that is not Covered Software.
+
+1.8. "License"
+means this document.
+
+1.9. "Licensable"
+means having the right to grant, to the maximum extent possible,
+whether at the time of the initial grant or subsequently, any and
+all of the rights conveyed by this License.
+
+1.10. "Modifications"
+means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+means any patent claim(s), including without limitation, method,
+process, and apparatus claims, in any patent Licensable by such
+Contributor that would be infringed, but for the grant of the
+License, by the making, using, selling, offering for sale, having
+made, import, or transfer of either its Contributions or its
+Contributor Version.
+
+1.12. "Secondary License"
+means either the GNU General Public License, Version 2.0, the GNU
+Lesser General Public License, Version 2.1, the GNU Affero General
+Public License, Version 3.0, or any later versions of those
+licenses.
+
+1.13. "Source Code Form"
+means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+means an individual or a legal entity exercising rights under this
+License. For legal entities, "You" includes any entity that
+controls, is controlled by, or is under common control with You. For
+purposes of this definition, "control" means (a) the power, direct
+or indirect, to cause the direction or management of such entity,
+whether by contract or otherwise, or (b) ownership of more than
+fifty percent (50%) of the outstanding shares or beneficial
+ownership of such entity.
+
+2. License Grants and Conditions
+
+---
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+Licensable by such Contributor to use, reproduce, make available,
+modify, display, perform, distribute, and otherwise exploit its
+Contributions, either on an unmodified basis, with Modifications, or
+as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+for sale, have made, import, and otherwise transfer either its
+Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+or
+
+(b) for infringements caused by: (i) Your and any other third party's
+modifications of Covered Software, or (ii) the combination of its
+Contributions with other software (except as part of its Contributor
+Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+
+---
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+Form, as described in Section 3.1, and You must inform recipients of
+the Executable Form how they can obtain a copy of such Source Code
+Form by reasonable means in a timely manner, at a charge no more
+than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+License, or sublicense it under different terms, provided that the
+license for the Executable Form does not attempt to limit or alter
+the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+
+---
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+
+---
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+---
+
+-                                                                      *
+-   6. Disclaimer of Warranty \*
+- ------------------------- \*
+-                                                                      *
+- Covered Software is provided under this License on an "as is" \*
+- basis, without warranty of any kind, either expressed, implied, or \*
+- statutory, including, without limitation, warranties that the \*
+- Covered Software is free of defects, merchantable, fit for a \*
+- particular purpose or non-infringing. The entire risk as to the \*
+- quality and performance of the Covered Software is with You. \*
+- Should any Covered Software prove defective in any respect, You \*
+- (not any Contributor) assume the cost of any necessary servicing, \*
+- repair, or correction. This disclaimer of warranty constitutes an \*
+- essential part of this License. No use of any Covered Software is \*
+- authorized under this License except under this disclaimer. \*
+-                                                                      *
+
+---
+
+---
+
+-                                                                      *
+-   7. Limitation of Liability \*
+- -------------------------- \*
+-                                                                      *
+- Under no circumstances and under no legal theory, whether tort \*
+- (including negligence), contract, or otherwise, shall any \*
+- Contributor, or anyone who distributes Covered Software as \*
+- permitted above, be liable to You for any direct, indirect, \*
+- special, incidental, or consequential damages of any character \*
+- including, without limitation, damages for lost profits, loss of \*
+- goodwill, work stoppage, computer failure or malfunction, or any \*
+- and all other commercial damages or losses, even if such party \*
+- shall have been informed of the possibility of such damages. This \*
+- limitation of liability shall not apply to liability for death or \*
+- personal injury resulting from such party's negligence to the \*
+- extent applicable law prohibits such limitation. Some \*
+- jurisdictions do not allow the exclusion or limitation of \*
+- incidental or consequential damages, so this exclusion and \*
+- limitation may not apply to You. \*
+-                                                                      *
+
+---
+
+8. Litigation
+
+---
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+
+---
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+
+---
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+## Exhibit A - Source Code Form License Notice
+
+This Source Code Form is subject to the terms of the Mozilla Public
+License, v. 2.0. If a copy of the MPL was not distributed with this
+file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+## Exhibit B - "Incompatible With Secondary Licenses" Notice
+
+This Source Code Form is "Incompatible With Secondary Licenses", as
+defined by the Mozilla Public License, v. 2.0.

package/README.md

@@ -1,3 +1,220 @@
-# Temporary Holding Version
+<div align="center">
+	<img width="320" height="320" src=".github/logo.svg" alt="pi-hofund logo" />
+	<br>
+	<h1>pi-hofund</h1>
+	<p>Bifrost AI Gateway control-plane extension for the Pi coding agent</p>
+	<br>
+	<a href="https://github.com/f1yn/pi-hofund/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/f1yn/pi-hofund/ci.yml?branch=main" alt="CI Status" /></a>
+	<a href="https://www.npmjs.com/package/pi-hofund"><img src="https://img.shields.io/npm/v/pi-hofund.svg" alt="npm version" /></a>
+	<a href="LICENSE"><img src="https://img.shields.io/badge/license-MPL--2.0-blue.svg" alt="License: MPL-2.0" /></a>
+	<br />
+	<sub style="opacity: .5; text-align: center;">Iconography from <a href="https://github.com/game-icons/icons">game-icons</a>, licensed under <a href="https://github.com/game-icons/icons/blob/master/license.txt">CC BY 3.0</a>.</sub>
+</div>
 
-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.
+`pi-hofund` is an extension for the [Pi coding agent](https://github.com/earendil-works/pi) that connects directly to a self-hosted [Bifrost AI Gateway](https://www.getmaxim.ai/bifrost).
+
+Instead of treating Bifrost as just an OpenAI-compatible URL, `pi-hofund` exposes the gateway's control plane to Pi: dynamic model catalogs, Virtual MCP tool servers, managed skills, and prompt repositories are integrated into Pi as native surfaces, scoped to your Bifrost Virtual Key.
+
+## Why pi-hofund?
+
+Pointing Pi at an OpenAI-compatible proxy URL only provides raw chat completions. You still have to transcribe model IDs by hand, guess context limits and pricing, configure MCP servers individually, and manually distribute skills and prompt templates.
+
+`pi-hofund` turns Bifrost into the single source of truth for your Pi environment:
+
+| Surface | Generic OpenAI Base URL | With `pi-hofund` |
+| --- | --- | --- |
+| **Models** | Transcribe model IDs manually; guess limits, pricing, and reasoning parameters | Auto-registered `bifrost` provider derived live from Bifrost's `/v1/models` catalog |
+| **Tools (MCP)** | Manually maintain tool configs in `mcp.json` | Dynamic tool discovery: registers one MCP server per Virtual MCP slug, with a whole-key fallback |
+| **Skills** | Manually copy and sync `SKILL.md` folders across machines | Opt-in, atomic sync of Bifrost's public skills bundles into `~/.pi/agent/skills/` |
+| **Prompts** | Manually maintain prompt templates | Opt-in sync of versioned prompt repositories into `~/.pi/agent/prompts/bifrost/` |
+| **Freshness** | Static until configuration files are edited | TTL-checked, coalesced background refresh, re-synced on session start or on demand |
+| **Governance** | Treated as an unmetered, generic client | Gateway budgets, rate limits, team scopes, and audit logs remain strictly enforced |
+
+### Core Design Principles
+
+- **Derived, never guessed:** Every model attribute (reasoning capabilities, context windows, pricing, thinking levels) is derived directly from Bifrost's rich model catalog. There are no fallback catalogs, magnitude guesses, or arbitrary `compat` flags.
+- **Scoped & governed:** All inference and tool calls pass through your Bifrost Virtual Key (VK). Prompts require an optional management key; skills sync from public bundles. Pi only accesses what your key is permitted to see.
+- **Safe & non-destructive:** Synced assets carry a `managed-by: pi-hofund` front-matter marker. Existing local skills and custom prompts without this marker are never overwritten or removed.
+- **Zero runtime dependencies:** Built entirely on Node.js built-ins (`node:zlib` for archive handling) and Pi extension APIs.
+
+## Prerequisites
+
+- **Node.js** >= 22
+- **[Pi coding agent](https://github.com/earendil-works/pi)** (`@earendil-works/pi-coding-agent`)
+- A running **[Bifrost](https://www.getmaxim.ai/bifrost)** instance with a valid Virtual Key (and an optional Management Key if prompt repository sync is enabled)
+
+## Quickstart
+
+### 1. Install the extension
+
+Install `pi-hofund` as a persistent Pi package:
+
+```bash
+pi install npm:pi-hofund
+```
+
+_(To test the extension for a single run without installing, use `pi -e npm:pi-hofund`.)_
+
+### 2. Connect to Bifrost
+
+Launch Pi and run the login command:
+
+```text
+/login bifrost
+```
+
+Pi will prompt you for:
+
+1. **Bifrost URL** — the mount URL of your gateway (e.g. `https://bifrost.example.com/openai/v1`).
+2. **Virtual Key** — your Bifrost virtual key.
+
+Credentials are saved securely in Pi's credential store (`~/.pi/agent/auth.json`). The login flow writes the resolved shape itself — `{ type: "api_key", key: "pi-hofund-keyless", env: { BIFROST_URL, BIFROST_VIRTUAL_KEY } }` — so the extension always finds the gateway URL and virtual key it needs, and re-running `/login bifrost` repairs any legacy bare-key entry. The virtual key is never written to `settings.json` and is never read from global environment variables.
+
+### 3. Start using models
+
+Models from your Bifrost gateway are available immediately under the `bifrost/` provider prefix:
+
+```text
+/model bifrost/<model-id>
+```
+
+To set Bifrost as your default provider, add `"defaultProvider": "bifrost"` in `~/.pi/agent/settings.json`.
+
+### 4. Enable optional surfaces
+
+Run the interactive settings menu to enable MCP, skills, or prompt syncing:
+
+```text
+/bifrost:settings
+```
+
+Toggle desired features with `Space`, save with `Ctrl+S`, or reload the catalog on demand using `/bifrost:reload`.
+
+## Surfaces & Features
+
+### Dynamic Model Catalog (`bifrost/*`)
+
+The `bifrost` provider registers all models exposed by your Virtual Key via Bifrost's `/v1/models` catalog:
+
+- Context limits, max tokens, pricing, and reasoning flags are populated directly from gateway metadata.
+- Catalog updates are cached with a configurable TTL (default 6 hours) and refreshed automatically on session start.
+- Concurrent refreshes are coalesced into a single network call.
+- Run `/bifrost:reload` at any time to bypass the cache and force an immediate refresh.
+
+### Per-Upstream Request Hooks
+
+Each `src/providers/<upstream>.ts` file is auto-discovered and may adjust the outgoing headers, the outgoing chat-completions body, and each incoming stream event for models whose id starts with that upstream:
+
+- The shipped `opencode-go` override attaches `x-bf-eh-x-opencode-session: <pi session id>`, which Bifrost forwards so an opencode session stays pinned to one backend. Nothing else is rewritten.
+- Hooks run in-process, perform no network I/O, and a throwing hook is reported and bypassed.
+
+### Virtual MCP Tool Servers
+
+When `hofund.features.mcp` is enabled:
+
+- `pi-hofund` queries Bifrost for Virtual MCP configurations assigned to your Virtual Key.
+- Virtual MCP slugs register as native Pi MCP servers via `pi.registerMcpServer`.
+- If no virtual slugs exist, a whole-key fallback server (`mcp__hofund`) is registered so all key-accessible tools remain available.
+- All MCP servers unregister cleanly on session shutdown.
+
+### Managed Skills Sync
+
+When `hofund.features.skills` is enabled:
+
+- Pi downloads the public skills archive from Bifrost and materializes them as flat skill directories inside `~/.pi/agent/skills/`.
+- **Safety guarantee:** Synced skills are tagged with `managed-by: pi-hofund` in their `SKILL.md` front-matter. Unmanaged user skills are preserved and never modified or deleted during sync or cleanup.
+- Use `hofund.zipPathPrefix` (e.g. `"pi/"`) to limit synchronization to a subfolder within the upstream archive.
+
+### Prompt Repositories
+
+When `hofund.features.prompts` is enabled (requires a management key):
+
+- Synchronizes versioned prompts from Bifrost's prompt repository into `~/.pi/agent/prompts/bifrost/`.
+- Bifrost's ordered message arrays and parameter specifications are projected into Pi's markdown template structure.
+- As with skills, prompts are tracked via manifests and local unmanaged templates are preserved.
+
+## Interactive Commands
+
+| Command | Purpose |
+| --- | --- |
+| `/login bifrost` | Interactively prompt for gateway URL and Virtual Key, then write the resolved credential (URL + key in `env`) to `auth.json`. |
+| `/bifrost:settings` | Open the interactive TUI settings screen to toggle MCP, skills, and prompts, or view current config. |
+| `/bifrost:reload` | Force an immediate catalog refresh and re-run active surface syncs. |
+
+## Configuration Reference
+
+Settings can be managed interactively with `/bifrost:settings` or edited directly in `~/.pi/agent/settings.json` under the `hofund` key:
+
+```json
+{
+	"hofund": {
+		"url": "https://bifrost.example.com/openai/v1",
+		"features": {
+			"mcp": true,
+			"skills": true,
+			"prompts": false
+		},
+		"modelTtlMinutes": 360,
+		"zipPathPrefix": "pi"
+	}
+}
+```
+
+### Options
+
+| Setting | Type | Default | Description |
+| --- | --- | --- | --- |
+| `hofund.url` | string | _required_ | Base URL of your Bifrost OpenAI-compatible endpoint (e.g. `https://bifrost.example.com/openai/v1`). |
+| `hofund.features.mcp` | boolean | `false` | Discover and register Virtual MCP tool servers. |
+| `hofund.features.skills` | boolean | `false` | Synchronize Bifrost public skills into `~/.pi/agent/skills/`. |
+| `hofund.features.prompts` | boolean | `false` | Synchronize prompt repository into `~/.pi/agent/prompts/bifrost/` (requires management key). |
+| `hofund.modelTtlMinutes` | number | `360` | Catalog refresh cache duration in minutes. |
+| `hofund.zipPathPrefix` | string | `undefined` | Restrict skills sync to a specific subfolder inside the skills ZIP bundle. |
+| `hofund.apiKey` | string | `undefined` | Optional upstream API authentication key. |
+| `hofund.managementKey` | string | `undefined` | Management API key for prompt sync (prefer setting `HOFUND_MANAGEMENT_KEY` in environment). |
+
+### Environment Variables & CLI Flags
+
+For headless environments, Docker containers, or scripted setups, configuration resolves using the following precedence:
+
+1. **CLI Flags:** `--hofund-url`, `--hofund-api-key`, `--hofund-virtual-key`
+2. **Environment Variables:**
+   - `BIFROST_URL` — Gateway base URL.
+   - `BIFROST_API_KEY` — Optional upstream API key.
+   - `HOFUND_MANAGEMENT_KEY` — Management API key (used for prompt repository access).
+3. **Settings File:** `~/.pi/agent/settings.json` (`hofund.*` block).
+4. **Credential Store:** `~/.pi/agent/auth.json` (populated via `/login bifrost`).
+
+_Note on security: The Virtual Key is read from `auth.json` or the explicit `--hofund-virtual-key` flag. It is never read from ambient environment variables to avoid accidental exposure in process listings or logs._
+
+## Advanced: Upstream Traffic Overrides
+
+If a specific model provider routed behind Bifrost requires payload adjustments or custom stream handling, `pi-hofund` supports file-discovered overrides:
+
+- Drop a module at `src/providers/<upstream>.ts` (where `<upstream>` matches the first segment of the model ID, e.g. `opencode-go`).
+- Export `processOutgoing(body, meta)` to modify outgoing JSON request payloads.
+- Export `processIncoming(event, meta)` to transform streamed assistant message events.
+- See [`docs/extending.md`](docs/extending.md) for details and conventions.
+
+## Behind the Name
+
+In Norse mythology, **Bifröst** is the burning rainbow bridge connecting the realms, and **Hǫfuð** (Hofund) is the sword of Heimdall, guardian of the bridge. As Heimdall keeps watch over the crossing, `pi-hofund` watches the connection between Pi and Bifrost, ensuring models, tools, skills, and governance flow smoothly across.
+
+## Development
+
+```bash
+npm run check          # Typecheck with tsc
+npm run test           # Run Vitest test suite
+npm run lint           # Lint with oxlint
+npm run format:check   # Check code formatting with oxfmt
+```
+
+For guidelines on architecture and invariants, consult:
+
+- [`docs/ATLAS.md`](docs/ATLAS.md) — Architecture reference, invariants, and module map.
+- [`docs/code.md`](docs/code.md) — Code style and formatting rules.
+- [`docs/extending.md`](docs/extending.md) — Adding custom upstream overrides or surfaces.
+
+## License
+
+[Mozilla Public License 2.0 (MPL-2.0)](LICENSE).