iris-harness 0.1.0__tar.gz

iris_harness-0.1.0/LICENSE

@@ -0,0 +1,190 @@
+
+                                 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.
+
+      "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 the 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 the 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 any 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
+
+   Copyright 2026 IRIS Development Team
+
+   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.

iris_harness-0.1.0/PKG-INFO

@@ -0,0 +1,249 @@
+Metadata-Version: 2.4
+Name: iris-harness
+Version: 0.1.0
+Summary: IRIS - Intelligent Reasoning & Integration System: Privacy-first agentic AI assistant with local-first LLM orchestration
+License: Apache-2.0
+License-File: LICENSE
+Keywords: ai,llm,assistant,privacy,agentic,langchain,langgraph,ollama,local-first,react-loop
+Author: IRIS Development Team
+Requires-Python: >=3.12,<3.14
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Environment :: Web Environment
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Communications :: Email
+Classifier: Topic :: Office/Business :: Scheduling
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Provides-Extra: all
+Provides-Extra: email
+Provides-Extra: ml
+Requires-Dist: apscheduler (>=3.10.0,<4.0.0)
+Requires-Dist: beautifulsoup4 (>=4.12,<5.0)
+Requires-Dist: chromadb (>=0.5.0)
+Requires-Dist: cryptography (>=43,<51)
+Requires-Dist: ddgs (>=9.14,<10.0)
+Requires-Dist: duckdb (>=1.1,<2)
+Requires-Dist: fastapi (>=0.109,<1)
+Requires-Dist: google-api-python-client (>=2.0,<3.0) ; extra == "email" or extra == "all"
+Requires-Dist: google-auth (>=2.0,<3.0) ; extra == "email" or extra == "all"
+Requires-Dist: google-auth-oauthlib (>=1.0,<2.0) ; extra == "email" or extra == "all"
+Requires-Dist: httpcore (>=1,<2)
+Requires-Dist: httpx (>=0.27,<1)
+Requires-Dist: keyring (>=25.0.0,<26.0.0)
+Requires-Dist: langchain-core (>=1.6,<2.0)
+Requires-Dist: langchain-ollama (>=1.1,<2.0)
+Requires-Dist: langchain-openai (>=1.6,<2.0)
+Requires-Dist: numpy (>=1.26)
+Requires-Dist: openinference-instrumentation-langchain (>=0.1.0)
+Requires-Dist: opentelemetry-api (>=1.20.0)
+Requires-Dist: opentelemetry-exporter-otlp (>=1.20.0)
+Requires-Dist: opentelemetry-instrumentation-httpx (>=0.62b1)
+Requires-Dist: opentelemetry-sdk (>=1.20.0)
+Requires-Dist: pillow (>=12.1.0,<13.0.0)
+Requires-Dist: prompt_toolkit (>=3.0)
+Requires-Dist: psutil (>=6.0.0,<7.0.0)
+Requires-Dist: pyarrow (>=15.0)
+Requires-Dist: pydantic (>=2.0,<3.0)
+Requires-Dist: pyjwt (>=2.13,<3.0)
+Requires-Dist: pypdfium2 (>=5.9.0,<6.0.0)
+Requires-Dist: pytesseract (>=0.3.13,<0.4.0)
+Requires-Dist: python-dotenv (>=1.2.1,<2.0.0)
+Requires-Dist: python-multipart (>=0.0.31)
+Requires-Dist: pyyaml (>=6.0,<7.0)
+Requires-Dist: scikit-learn (>=1.3) ; extra == "email" or extra == "all"
+Requires-Dist: sentence-transformers (>=5.5.1,<6.0.0) ; extra == "ml" or extra == "all"
+Requires-Dist: starlette (>=1.3.1,<2)
+Requires-Dist: trafilatura (>=2.1.0,<3.0.0)
+Requires-Dist: uvicorn (>=0.27,<1)
+Requires-Dist: watchdog (>=4.0.0,<5.0.0)
+Project-URL: Bug Tracker, https://github.com/evarness-ai/iris-harness/issues
+Project-URL: Changelog, https://github.com/evarness-ai/iris-harness/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://github.com/evarness-ai/iris-harness/blob/main/README.md
+Project-URL: Homepage, https://github.com/evarness-ai/iris-harness
+Project-URL: Repository, https://github.com/evarness-ai/iris-harness
+Description-Content-Type: text/markdown
+
+# IRIS
+
+**The governed agent harness for small local models.**
+
+IRIS runs an agent loop (classify, plan, act with tools, curate the answer) on models
+that fit on a laptop. Every model call and every tool call passes through a governance
+kernel you cannot unplug, and a turn that can be answered exactly is answered with no
+model at all. Everything outside the loop and the kernel is a plugin, written against a
+small, stable SDK.
+
+The proof is the email assistant that ships with it: a private inbox assistant that
+reads, sorts and labels your mail on a local model, writes nothing until you approve it,
+and leaves an audit row for every call.
+
+Documentation: **https://evarness-ai.github.io/iris-harness/**
+
+## Try it in three minutes
+
+You need [uv](https://docs.astral.sh/uv/) or [pipx](https://pipx.pypa.io/); neither ships with Python, and `pip install uv` is the shortest route ([details](https://evarness-ai.github.io/iris-harness/getting-started/install/)).
+
+```bash
+uv tool install "iris-harness[email]"   # or: pipx install "iris-harness[email]"
+iris doctor                             # can IRIS run here, and what to fix
+iris email demo                         # a synthetic mailbox, a scripted model, no network
+iris email setup                        # then your own mailbox (IMAP or Gmail), step by step
+```
+
+If `iris` is not found after installing, add `~/.local/bin` to your PATH: run `uv tool update-shell` (or `pipx ensurepath`) and open a new terminal.
+
+`iris email demo` needs no account, no credentials and no model server. It fetches a
+200-message synthetic mailbox, sorts it, previews and writes labels, prints a first
+digest, and ends with what it did, audit rows included. For your own mail you need
+[Ollama](https://ollama.com/download) and 16 GB of RAM; `iris doctor --fix` pulls the
+starter model. Step by step: [Getting started](https://evarness-ai.github.io/iris-harness/getting-started/install/);
+if something does not work, see the [common setup gotchas](https://evarness-ai.github.io/iris-harness/guides/setup-gotchas/).
+
+## Build on it
+
+A plugin is a package with a `manifest.yaml` and a `setup(api)`. Scaffold one, with a
+test that passes offline, by kind:
+
+```bash
+iris plugins new weather-now --kind tool   # or channel, mail-provider, research-provider, skill
+cd weather-now && pip install -e ".[test]" && pytest
+```
+
+Through `PluginAPI` a plugin registers deterministic handlers, tools, agents, scheduled
+jobs, channels and approval executors. Each lands on the same machinery the core uses,
+so the same governance applies, with no side door. `iris_harness.testing` runs your
+plugin inside a real governed IRIS in your test, on a scripted model, and lets you
+assert on the audit ledger.
+
+| Use case | What IRIS gives you |
+|---|---|
+| **A private email assistant** | Triage, a daily digest and labels on a local model. Personal data never reaches a cloud model; nothing changes in your mailbox until you approve it, once per account. |
+| **Your own domain agent** | Tools, deterministic handlers and an agent on the governed loop ([`examples/05-your-own-agent`](examples/05-your-own-agent/)). |
+| **Proactive routines** | Scheduled jobs that deliver to a channel: Telegram, web push, the web console ([`examples/04-routine-to-telegram`](examples/04-routine-to-telegram/)). |
+| **Governed research** | One `research` tool over a provider chain (SearXNG, Tavily, Brave, DuckDuckGo), cached and reranked, behind the egress gate. |
+| **Safe code execution** | A bounded model-to-sandbox loop that runs shell commands in a container. |
+
+Nine runnable examples, each tested in CI, are in [`examples/`](examples/README.md).
+What a plugin may import, and the deprecation rule that protects it, is the
+[stable API](docs/reference/stable-api.md).
+
+## Why a harness
+
+- **Determinism is a primitive.** On one grounded action, a 7B model called the right
+  tool 25% of the time and a 35B model 0%; a deterministic handler did it 100% of the
+  time. A plugin can claim the turns it can answer exactly, and IRIS governs those
+  answers like generated ones: the input screen before, the model-free response checks
+  after, an audit row marked `deterministic`.
+- **Governance is a passage, not a filter.** Data is classified before it moves.
+  Personal and secret data stays on local models. Secrets reach tools as vault handles,
+  never as prompt text. Writes ask once; destructive actions wait for your approval.
+- **Every call is audited.** Each model call, tool call and answer writes a ledger row.
+  A [proof bundle](docs/reference/proof-bundle.md) lets a CI job verify the email
+  assistant's invariants offline: no personal data to a cloud model, no mailbox write
+  without an approval, every call and answer audited. Check them yourself:
+
+  ```bash
+  iris governance proof-bundle export --out bundle.json
+  iris governance proof-bundle verify bundle.json   # exit 0 verified, 1 a violation
+  ```
+- **The model-free guards hold.** In an adversarial battery of 14 probes against the
+  full guard stack, 11 were fully defended; the misses were in model-based judges, and
+  the deterministic guards held. Since then every answer, generated or not, passes the
+  model-free guards.
+
+## See every decision
+
+The web console shows the ledger. Governance has the kernel's posture and the proof
+bundle's invariants, checked against the audit rows; Call trace has each turn as a graph,
+with the governance decision at every hook. Both are from `iris email demo`:
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/evarness-ai/iris-harness/raw/main/docs/assets/screenshots/governance-dark.webp">
+  <img alt="The Governance screen after the email demo: the kernel's protections, mostly on, over the run's audit entries, and the proof bundle verified, with no-private-to-cloud and mailbox-write-approved holding." src="https://github.com/evarness-ai/iris-harness/raw/main/docs/assets/screenshots/governance-light.webp" width="800">
+</picture>
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/evarness-ai/iris-harness/raw/main/docs/assets/screenshots/call-trace-dark.webp">
+  <img alt="The Call trace of the first-chat welcome turn: four steps, no model call, with the pre_response guard's allow decision open in the detail panel." src="https://github.com/evarness-ai/iris-harness/raw/main/docs/assets/screenshots/call-trace-light.webp" width="800">
+</picture>
+
+## What ships
+
+| Part | Where |
+|---|---|
+| The agentic core: router, planner, ReAct loop, executor, curator, with tiered model routing (a router model, local tiers on Ollama or LM Studio, an opt-in cloud tier) | `src/iris_harness/agent/`, `config/llm_tiers.yaml` |
+| The governance kernel: classification, the egress gate, a Fernet vault, tool policy, approvals, an out-of-process evaluator, the audit ledger | `src/iris_harness/kernel/governance/` |
+| The plugin SDK and host | `src/iris_harness/sdk/`, `src/iris_harness/runtime/plugin_host/` |
+| Reference plugins: `system`, `research`, `code_exec`, and the Telegram, web and web-push channels | `src/iris_harness/plugins_builtin/` |
+| The email assistant: the mail record and the `gmail`, `imap` and `email_workflows` plugins | `src/iris_personal/` |
+| **memris**, the memory graph: claims with provenance | `src/memris/` |
+| Four services: the IRIS API (chat, the MCP server, the web console; 8003), the Governor (8080), the evaluator (8090), the channel gateway (8006) | `src/iris_harness/server/` |
+| The web console (React), built into the released package | `webui/` |
+
+IRIS runs on macOS (Apple Silicon) and Linux; on Windows, use WSL2. It collects no
+telemetry. It is pre-1.0: the stable API changes only after a deprecation cycle, and
+everything else may change in any release.
+
+## Run the services
+
+The scheduled jobs (the email sweep and judge) and the web console run in the IRIS API.
+[Run with Docker](https://evarness-ai.github.io/iris-harness/guides/docker/) keeps it
+up as a service:
+
+```bash
+export IRIS_AUTH_SECRET="$(openssl rand -hex 32)"
+docker compose up        # Ollama, the Governor and the IRIS API, on 127.0.0.1 only
+```
+
+The [email assistant guide](https://evarness-ai.github.io/iris-harness/guides/email/)
+shows how to run the API from an install and pair the web console.
+
+## Contributing
+
+Plugins are the contribution unit. This is the shortest path from a clone to a change you
+can check. You need Python 3.12 or 3.13 (`.python-version` pins 3.12) and
+[Poetry](https://python-poetry.org/) 2.x.
+
+```bash
+git clone https://github.com/evarness-ai/iris-harness.git && cd iris-harness
+poetry install --with dev --extras email
+poetry run iris email demo               # the whole stack from source: no account, no model server
+```
+
+Tests need two environment variables, and run on the narrowest path that covers your
+change:
+
+```bash
+export IRIS_AUTH_SECRET="test-secret-for-testing" IRIS_DISABLE_WARMUP=1
+poetry run pytest tests/unit/<the path you changed>
+```
+
+Before you push, run the local gate: `scripts/ci_local.sh --fast` while you iterate (ruff,
+black, mypy, import contracts, the tests for what changed), and `scripts/ci_local.sh`
+before a pull request (the full suite, a playground smoke run, the secret and PII scan).
+
+Where to look first:
+
+| You are changing | Start here |
+|---|---|
+| A plugin | `iris plugins new` (above), [`examples/`](examples/README.md), [stable API](docs/reference/stable-api.md) |
+| The turn pipeline | `src/iris_harness/runtime/turn/` |
+| Governance (classification, egress, approvals, audit) | `src/iris_harness/kernel/governance/` |
+| The email assistant | `src/iris_personal/` |
+| The web console | `webui/` |
+
+Read [CONTRIBUTING.md](CONTRIBUTING.md) (the governance rules every change keeps, DCO
+sign-off, the stable-tier rule) and the [code of conduct](CODE_OF_CONDUCT.md). Coding
+agents: [AGENTS.md](AGENTS.md). Questions and ideas go to GitHub Discussions; bugs to
+Issues. Report vulnerabilities privately as described in [SECURITY.md](SECURITY.md).
+Changes are listed in [CHANGELOG.md](CHANGELOG.md).
+
+## License
+
+Apache License 2.0; see [LICENSE](LICENSE). IRIS is, and will remain, Apache-2.0.
+

iris_harness-0.1.0/README.md

@@ -0,0 +1,178 @@
+# IRIS
+
+**The governed agent harness for small local models.**
+
+IRIS runs an agent loop (classify, plan, act with tools, curate the answer) on models
+that fit on a laptop. Every model call and every tool call passes through a governance
+kernel you cannot unplug, and a turn that can be answered exactly is answered with no
+model at all. Everything outside the loop and the kernel is a plugin, written against a
+small, stable SDK.
+
+The proof is the email assistant that ships with it: a private inbox assistant that
+reads, sorts and labels your mail on a local model, writes nothing until you approve it,
+and leaves an audit row for every call.
+
+Documentation: **https://evarness-ai.github.io/iris-harness/**
+
+## Try it in three minutes
+
+You need [uv](https://docs.astral.sh/uv/) or [pipx](https://pipx.pypa.io/); neither ships with Python, and `pip install uv` is the shortest route ([details](https://evarness-ai.github.io/iris-harness/getting-started/install/)).
+
+```bash
+uv tool install "iris-harness[email]"   # or: pipx install "iris-harness[email]"
+iris doctor                             # can IRIS run here, and what to fix
+iris email demo                         # a synthetic mailbox, a scripted model, no network
+iris email setup                        # then your own mailbox (IMAP or Gmail), step by step
+```
+
+If `iris` is not found after installing, add `~/.local/bin` to your PATH: run `uv tool update-shell` (or `pipx ensurepath`) and open a new terminal.
+
+`iris email demo` needs no account, no credentials and no model server. It fetches a
+200-message synthetic mailbox, sorts it, previews and writes labels, prints a first
+digest, and ends with what it did, audit rows included. For your own mail you need
+[Ollama](https://ollama.com/download) and 16 GB of RAM; `iris doctor --fix` pulls the
+starter model. Step by step: [Getting started](https://evarness-ai.github.io/iris-harness/getting-started/install/);
+if something does not work, see the [common setup gotchas](https://evarness-ai.github.io/iris-harness/guides/setup-gotchas/).
+
+## Build on it
+
+A plugin is a package with a `manifest.yaml` and a `setup(api)`. Scaffold one, with a
+test that passes offline, by kind:
+
+```bash
+iris plugins new weather-now --kind tool   # or channel, mail-provider, research-provider, skill
+cd weather-now && pip install -e ".[test]" && pytest
+```
+
+Through `PluginAPI` a plugin registers deterministic handlers, tools, agents, scheduled
+jobs, channels and approval executors. Each lands on the same machinery the core uses,
+so the same governance applies, with no side door. `iris_harness.testing` runs your
+plugin inside a real governed IRIS in your test, on a scripted model, and lets you
+assert on the audit ledger.
+
+| Use case | What IRIS gives you |
+|---|---|
+| **A private email assistant** | Triage, a daily digest and labels on a local model. Personal data never reaches a cloud model; nothing changes in your mailbox until you approve it, once per account. |
+| **Your own domain agent** | Tools, deterministic handlers and an agent on the governed loop ([`examples/05-your-own-agent`](examples/05-your-own-agent/)). |
+| **Proactive routines** | Scheduled jobs that deliver to a channel: Telegram, web push, the web console ([`examples/04-routine-to-telegram`](examples/04-routine-to-telegram/)). |
+| **Governed research** | One `research` tool over a provider chain (SearXNG, Tavily, Brave, DuckDuckGo), cached and reranked, behind the egress gate. |
+| **Safe code execution** | A bounded model-to-sandbox loop that runs shell commands in a container. |
+
+Nine runnable examples, each tested in CI, are in [`examples/`](examples/README.md).
+What a plugin may import, and the deprecation rule that protects it, is the
+[stable API](docs/reference/stable-api.md).
+
+## Why a harness
+
+- **Determinism is a primitive.** On one grounded action, a 7B model called the right
+  tool 25% of the time and a 35B model 0%; a deterministic handler did it 100% of the
+  time. A plugin can claim the turns it can answer exactly, and IRIS governs those
+  answers like generated ones: the input screen before, the model-free response checks
+  after, an audit row marked `deterministic`.
+- **Governance is a passage, not a filter.** Data is classified before it moves.
+  Personal and secret data stays on local models. Secrets reach tools as vault handles,
+  never as prompt text. Writes ask once; destructive actions wait for your approval.
+- **Every call is audited.** Each model call, tool call and answer writes a ledger row.
+  A [proof bundle](docs/reference/proof-bundle.md) lets a CI job verify the email
+  assistant's invariants offline: no personal data to a cloud model, no mailbox write
+  without an approval, every call and answer audited. Check them yourself:
+
+  ```bash
+  iris governance proof-bundle export --out bundle.json
+  iris governance proof-bundle verify bundle.json   # exit 0 verified, 1 a violation
+  ```
+- **The model-free guards hold.** In an adversarial battery of 14 probes against the
+  full guard stack, 11 were fully defended; the misses were in model-based judges, and
+  the deterministic guards held. Since then every answer, generated or not, passes the
+  model-free guards.
+
+## See every decision
+
+The web console shows the ledger. Governance has the kernel's posture and the proof
+bundle's invariants, checked against the audit rows; Call trace has each turn as a graph,
+with the governance decision at every hook. Both are from `iris email demo`:
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/evarness-ai/iris-harness/raw/main/docs/assets/screenshots/governance-dark.webp">
+  <img alt="The Governance screen after the email demo: the kernel's protections, mostly on, over the run's audit entries, and the proof bundle verified, with no-private-to-cloud and mailbox-write-approved holding." src="https://github.com/evarness-ai/iris-harness/raw/main/docs/assets/screenshots/governance-light.webp" width="800">
+</picture>
+
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/evarness-ai/iris-harness/raw/main/docs/assets/screenshots/call-trace-dark.webp">
+  <img alt="The Call trace of the first-chat welcome turn: four steps, no model call, with the pre_response guard's allow decision open in the detail panel." src="https://github.com/evarness-ai/iris-harness/raw/main/docs/assets/screenshots/call-trace-light.webp" width="800">
+</picture>
+
+## What ships
+
+| Part | Where |
+|---|---|
+| The agentic core: router, planner, ReAct loop, executor, curator, with tiered model routing (a router model, local tiers on Ollama or LM Studio, an opt-in cloud tier) | `src/iris_harness/agent/`, `config/llm_tiers.yaml` |
+| The governance kernel: classification, the egress gate, a Fernet vault, tool policy, approvals, an out-of-process evaluator, the audit ledger | `src/iris_harness/kernel/governance/` |
+| The plugin SDK and host | `src/iris_harness/sdk/`, `src/iris_harness/runtime/plugin_host/` |
+| Reference plugins: `system`, `research`, `code_exec`, and the Telegram, web and web-push channels | `src/iris_harness/plugins_builtin/` |
+| The email assistant: the mail record and the `gmail`, `imap` and `email_workflows` plugins | `src/iris_personal/` |
+| **memris**, the memory graph: claims with provenance | `src/memris/` |
+| Four services: the IRIS API (chat, the MCP server, the web console; 8003), the Governor (8080), the evaluator (8090), the channel gateway (8006) | `src/iris_harness/server/` |
+| The web console (React), built into the released package | `webui/` |
+
+IRIS runs on macOS (Apple Silicon) and Linux; on Windows, use WSL2. It collects no
+telemetry. It is pre-1.0: the stable API changes only after a deprecation cycle, and
+everything else may change in any release.
+
+## Run the services
+
+The scheduled jobs (the email sweep and judge) and the web console run in the IRIS API.
+[Run with Docker](https://evarness-ai.github.io/iris-harness/guides/docker/) keeps it
+up as a service:
+
+```bash
+export IRIS_AUTH_SECRET="$(openssl rand -hex 32)"
+docker compose up        # Ollama, the Governor and the IRIS API, on 127.0.0.1 only
+```
+
+The [email assistant guide](https://evarness-ai.github.io/iris-harness/guides/email/)
+shows how to run the API from an install and pair the web console.
+
+## Contributing
+
+Plugins are the contribution unit. This is the shortest path from a clone to a change you
+can check. You need Python 3.12 or 3.13 (`.python-version` pins 3.12) and
+[Poetry](https://python-poetry.org/) 2.x.
+
+```bash
+git clone https://github.com/evarness-ai/iris-harness.git && cd iris-harness
+poetry install --with dev --extras email
+poetry run iris email demo               # the whole stack from source: no account, no model server
+```
+
+Tests need two environment variables, and run on the narrowest path that covers your
+change:
+
+```bash
+export IRIS_AUTH_SECRET="test-secret-for-testing" IRIS_DISABLE_WARMUP=1
+poetry run pytest tests/unit/<the path you changed>
+```
+
+Before you push, run the local gate: `scripts/ci_local.sh --fast` while you iterate (ruff,
+black, mypy, import contracts, the tests for what changed), and `scripts/ci_local.sh`
+before a pull request (the full suite, a playground smoke run, the secret and PII scan).
+
+Where to look first:
+
+| You are changing | Start here |
+|---|---|
+| A plugin | `iris plugins new` (above), [`examples/`](examples/README.md), [stable API](docs/reference/stable-api.md) |
+| The turn pipeline | `src/iris_harness/runtime/turn/` |
+| Governance (classification, egress, approvals, audit) | `src/iris_harness/kernel/governance/` |
+| The email assistant | `src/iris_personal/` |
+| The web console | `webui/` |
+
+Read [CONTRIBUTING.md](CONTRIBUTING.md) (the governance rules every change keeps, DCO
+sign-off, the stable-tier rule) and the [code of conduct](CODE_OF_CONDUCT.md). Coding
+agents: [AGENTS.md](AGENTS.md). Questions and ideas go to GitHub Discussions; bugs to
+Issues. Report vulnerabilities privately as described in [SECURITY.md](SECURITY.md).
+Changes are listed in [CHANGELOG.md](CHANGELOG.md).
+
+## License
+
+Apache License 2.0; see [LICENSE](LICENSE). IRIS is, and will remain, Apache-2.0.

iris_harness-0.1.0/config/behaviors/reminders.default.md

@@ -0,0 +1,42 @@
+---
+name: reminders
+description: How IRIS handles requests to remember, schedule, or follow up on something later.
+match_intents: [calendar]
+match_keywords: [remind, reminder, reminders, follow up, follow-up, schedule, deadline, by sunday, by monday, by tuesday, by wednesday, by thursday, by friday, by saturday]
+---
+
+# Behavior — Reminders
+
+When the user asks to be reminded of something, scheduled for something, or
+followed up on by a date, treat it as a durable commitment — not a passing
+chat turn. The reminder must survive process restarts and be findable in a
+future session.
+
+## Recipe
+
+1. **Confirm the intent in one short sentence.** No preamble; state what
+   you're capturing and the date/time you parsed. If the time is ambiguous,
+   ask exactly one question, then stop.
+2. **Call `add_reminder`** (or the `create_reminder` tool in the loop). It
+   writes the reminder to the one reminder store: a calendar reminder event
+   plus its delivery row, delivered on the user's channels at that time.
+   Dates and times are the user's local time.
+3. **Use the calendar event tools only for events.** `add_calendar_event`,
+   `edit_calendar_event` and `delete_calendar_event` manage standalone
+   events; a reminder is never written by hand or to a file.
+4. **Tell the user when it will fire.** One line: the reminder text and its
+   local date and time. Do not bury this in a long response.
+5. **Do not invent recurrence.** If the user did not say how often it
+   repeats, create a one-time reminder and state that assumption briefly.
+
+## What to avoid
+
+- Writing a reminder to any file (a markdown table, `~/.iris/reminders/`,
+  `~/.iris/sandbox/<random-hash>/`) — the reminder store is the only place a
+  reminder lives, and only `add_reminder` / `create_reminder` write it.
+- Silently dropping the reminder into chat history with no persistence.
+- Long acknowledgement messages. The user wants the commitment captured,
+  not a recap.
+- Asking more than one clarifying question. If multiple things are unclear,
+  pick the most blocking one and proceed with sensible defaults for the
+  rest, then state the assumptions you made.