cadre-ai 1.0.0__tar.gz

cadre_ai-1.0.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 [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

cadre_ai-1.0.0/PKG-INFO

@@ -0,0 +1,385 @@
+Metadata-Version: 2.4
+Name: cadre-ai
+Version: 1.0.0
+Summary: A team of AI agents that builds or finishes a project on free model keys, staying inside every provider's limits.
+Keywords: ai-agents,multi-agent,llm,free-tier,rate-limit,groq,gemini,mcp
+Author: Rithik Krishna
+Author-email: Rithik Krishna <317035893+Daemon-VI@users.noreply.github.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Dist: fastapi>=0.115
+Requires-Dist: httpx>=0.27
+Requires-Dist: keyring>=25
+Requires-Dist: pydantic>=2.8
+Requires-Dist: pyyaml>=6
+Requires-Dist: rich>=13
+Requires-Dist: typer>=0.12
+Requires-Dist: tzdata>=2024.1
+Requires-Dist: uvicorn>=0.30
+Requires-Dist: mcp>=2.2,<3 ; extra == 'mcp'
+Requires-Python: >=3.12
+Project-URL: Homepage, https://github.com/Daemon-VI/cadre
+Project-URL: Source, https://github.com/Daemon-VI/cadre
+Project-URL: Issues, https://github.com/Daemon-VI/cadre/issues
+Project-URL: Changelog, https://github.com/Daemon-VI/cadre/blob/main/CHANGELOG.md
+Provides-Extra: mcp
+Description-Content-Type: text/markdown
+
+# Cadre
+
+**Cadre runs a team of AI agents that builds a new project or finishes an existing one, using
+only free model API keys.** It spreads the work across every provider you add, stays inside each
+one's rate limits, and when a day's quota runs out it parks the run and picks it up after the reset.
+
+You describe the team as one YAML file: who the agents are, which tools they may use, which
+checks decide "done", and how they work together. Reviewers are routed to a *different* model
+family from the builder. Programs such as tests and linters decide whether work passes, not model
+opinions, and votes are counted by code.
+
+## Quick start
+
+Cadre needs Python 3.12 or newer. Install it with `pipx install cadre-ai` or
+`uv tool install cadre-ai`, or run it without installing through
+[uv](https://docs.astral.sh/uv/getting-started/installation/) as `uvx --from cadre-ai cadre …`.
+The command is `cadre`.
+
+```bash
+cadre provider add groq             # 1. a free key from console.groq.com, typed at a hidden prompt
+cadre forecast project-finisher "Make the failing tests pass"                  # 2. will it fit today?
+cadre run project-finisher "Make the failing tests pass" --project ./my-repo --allow-exec   # 3.
+git -C my-repo log --stat cadre/<run-id>     # 4. review the branch; Cadre never merges
+```
+
+With no key at all, `cadre run decision-board "Should we open a second office?" --demo` runs an
+offline scripted team.
+
+## Measured, not claimed
+
+Every number here was observed on free Groq and Google AI Studio keys on 2026-09-17/18 and is
+recorded with its run id in [`docs/PROJECT_STATE.md`](https://github.com/Daemon-VI/cadre/blob/main/docs/PROJECT_STATE.md) (the M5 and M11
+tables).
+
+| What | Result |
+|---|---|
+| `decision-board` (a five-member council votes, then a memo is written) | succeeded · 15 calls · 21.5k tokens · 125 s |
+| `software-team --allow-exec` (spec → build → independent review → tests gate) | succeeded · 27 calls · 94.0k tokens · 466 s |
+| `project-finisher` on a half-built fixture repository | succeeded · 14 calls · 16.8k tokens · 123 s · owner's tree unchanged |
+| Capstone 1: build a unit-converter CLI | succeeded · `Ran 9 tests … OK` when re-run by hand |
+| Capstone 2: finish a half-built package | succeeded · `Ran 8 tests … OK` on the delivered branch; owner's HEAD, branch and working tree unchanged |
+| Defects that only real models exposed | 10, each fixed with a regression test built from the live response |
+| One-line change: rewrite the file vs `edit_file` | 7,056 vs 134 tokens (Cadre's 4-characters-a-token estimate) |
+| Server memory while a live run streamed | 64.5 MB idle, 72.9 MB peak |
+
+## Limitations
+
+- **Checks are not sandboxed.** A check runs code the agents wrote, as you, on your machine. The
+  model can only name a check declared in the org file, never supply a command, and checks need
+  `--allow-exec` or your approval. Don't give an untrusted goal to an org with checks. A
+  container runner is roadmap item M12.
+- **No run has parked live yet.** Parking on a daily limit and resuming after the reset is
+  verified with a fake clock. A real interrupted run did resume the next day without re-billing.
+- **Review quality is not measured.** Only the routing of reviewers to another model family is.
+- **Forecasts are rough.** They were off by up to 4.4× before recalibration, and 2.3× on a later
+  run, because history is kept per org and not per project size.
+- **Tested by hand on Windows only.** CI covers Linux and macOS.
+- **Free tiers change without notice.** Preset limits are dated starting values, corrected at
+  run time by each provider's rate-limit headers.
+
+## Install from source
+
+Python 3.12+ and [uv](https://docs.astral.sh/uv/).
+
+```bash
+git clone https://github.com/Daemon-VI/cadre && cd cadre
+uv sync
+uv run cadre init          # creates ~/.cadre (set CADRE_HOME to put it elsewhere)
+```
+
+## Try it with no key
+
+The demo mode swaps in a scripted, offline model that exercises every workflow end to end. It
+is plumbing, not intelligence: every answer it writes is marked `[demo]`.
+
+```bash
+uv run cadre run decision-board "Should we open a second office?" --demo
+uv run cadre run software-team "a word counter" --demo --allow-exec
+```
+
+## Front ends
+
+Cadre is one engine (`cadre serve`, a local API at `/api/v1`), and each of these is a thin client
+of it (ADR-024):
+
+- **AI editors (MCP):** `uvx --from "cadre-ai[mcp]" cadre mcp` gives Claude Code, VS Code, Cursor,
+  Windsurf and Antigravity five tools: forecast, start a run, run status, usage and list orgs.
+  They can't approve anything. There's a config snippet for each host in
+  [`docs/MCP_HOSTS.md`](https://github.com/Daemon-VI/cadre/blob/main/docs/MCP_HOSTS.md).
+- **GitHub Action:** label an issue `cadre` or comment `/cadre <goal>`. Cadre runs
+  `project-finisher` on the checkout and opens a pull request with its report and usage table.
+  Only the owner, members and collaborators can trigger it. Copy
+  [`examples/github-action/cadre.yml`](https://github.com/Daemon-VI/cadre/blob/main/examples/github-action/cadre.yml) and add a free key as a
+  repository secret.
+- **VS Code extension** (Marketplace and Open VSX, so also Antigravity, Cursor and Windsurf): see
+  [`editors/vscode`](https://github.com/Daemon-VI/cadre/tree/main/editors/vscode).
+- **Container:** `ghcr.io/daemon-vi/cadre`, non-root, state in `/data`, keys from environment
+  variables. See [`compose.yaml`](compose.yaml).
+- **Standalone downloads** for Windows, macOS and Linux are attached to each GitHub Release. They
+  are unsigned, so SmartScreen and Gatekeeper will warn. Checks that use `{python}` need a Python
+  on PATH.
+
+On a server, in CI or in a container with no keychain, set `CADRE_NO_KEYRING=1`, put keys in
+environment variables, and run `cadre provider add-from-env` to register every free provider
+whose key is present.
+
+## Add a free model
+
+```bash
+uv run cadre presets               # every provider Cadre knows, with free-tier notes
+uv run cadre provider add groq     # prompts for the key with input hidden
+uv run cadre provider list
+uv run cadre provider test groq
+uv run cadre provider key groq     # replace a stored key, e.g. after rotating it
+```
+
+The key goes to the OS credential store (Windows Credential Manager, macOS Keychain, Secret
+Service), never to a file. Environment variables work too, checked first:
+`CADRE_KEY_GROQ`, then the provider's usual name (`GROQ_API_KEY`). On a headless machine with no
+keychain (a server, a container, CI), set `CADRE_NO_KEYRING=1` and pass keys only as environment
+variables.
+
+Add as many providers as you have keys. More providers means more parallel capacity and real
+reviewer independence.
+
+```bash
+uv run cadre provider add gemini
+uv run cadre provider add openrouter          # discovers the current :free models
+uv run cadre provider models openrouter       # what the endpoint serves today
+uv run cadre provider set-model groq openai/gpt-oss-20b --tier fast --tpm 8000
+```
+
+## Run a team
+
+```bash
+uv run cadre run software-team "a CSV to Markdown table converter" --allow-exec
+uv run cadre run startup-company "Launch a flashcard app for engineering students"
+uv run cadre runs
+uv run cadre show <run-id> --events
+uv run cadre resume <run-id>        # finished steps are reused, not re-billed
+uv run cadre cancel <run-id>
+```
+
+Without `--allow-exec`, the first check asks you before running anything. Approval gates and
+agent questions are asked in the terminal; add `--yes` to auto-approve gates, or
+`--approve-elsewhere` to answer from the dashboard or `cadre approve <id>`.
+
+Every run gets a workspace at `~/.cadre/runs/<run-id>/workspace/`, with every file version kept
+under `versions/`.
+
+## Finish an existing project
+
+```bash
+uv run cadre run project-finisher "Make the failing tests pass" --project C:\path\to\repo --allow-exec
+```
+
+Cadre works in a git worktree on a new branch `cadre/<run-id>` and commits each finished step
+there with your repository's own identity. Your working tree, current branch and uncommitted
+changes are never touched (a dirty tree is refused unless you pass `--allow-dirty`), and Cadre
+never merges or pushes. Checks come from the org file and from `.cadre/checks.yaml` as committed
+at the base commit, for example:
+
+```yaml
+checks:
+  - name: tests
+    command: ["{python}", "-m", "pytest", "-q"]
+```
+
+The run ends by printing the branch's commits, `git diff --stat`, and the commands to review or
+discard it. `cadre runs cleanup` removes finished worktrees and keeps their branches.
+
+## Will it fit? Usage and forecasts
+
+```bash
+uv run cadre forecast software-team "a CSV to Markdown table converter"
+uv run cadre usage --days 7
+```
+
+The forecast answers *fits now*, *fits today after ~N min of waits*, *needs ~N days* or *cannot
+run*, and always says its basis: `measured, n = …` once an org has finished runs, or `no history,
+estimated from template size` before that. `cadre run` prints it before starting. The usage
+ledger shows requests, tokens and the share of each daily cap per day, provider and model, with
+the next reset in IST.
+
+## Long jobs: parking and resuming
+
+When every model a run can use has hit its *daily* limit, the run is **parked** instead of
+failing, with the time it can continue (each provider's own reset clock). Nothing already finished
+is repeated or billed again when it resumes.
+
+```bash
+uv run cadre serve                 # resumes parked runs by itself while it is running
+uv run cadre resume --due          # or resume every run whose reset has passed, once
+uv run cadre scheduler install     # or check every 30 minutes from the OS scheduler (asks first)
+```
+
+Budgets count everything a run has used across days. `max_days` (default 7) stops a run that has
+gone on too long; `max_tokens_per_day` spreads a job over several days; `cadre resume <id>
+--add-calls 20` raises a stopped run's allowance.
+
+## Dashboard
+
+```bash
+uv run cadre serve       # http://127.0.0.1:8765, loopback only
+uv run cadre ui          # opens the browser with the access token in the URL fragment
+```
+
+To reach it through a Tailscale name or from a container, add `--allowed-host NAME` (repeatable,
+exact names only); anything else is still refused. The API is versioned at `/api/v1`.
+
+Runs with a live timeline, files, per-agent token usage and results; organisations with a YAML
+editor and validator; models and keys with live quota bars; pending approvals.
+
+## Templates
+
+| Template | Pattern | What it does |
+|---|---|---|
+| `software-team` | sequence → review loop → docs | PM writes a spec, engineer builds and tests, an independent reviewer checks it, `compile` and `tests` checks gate it, a writer documents it |
+| `decision-board` | council | CFO, CTO, CMO and a risk officer propose, critique, and vote; the CEO chairs, breaks ties and writes the memo |
+| `startup-company` | manager | A founder plans a task graph for researcher, engineer, designer and marketer; a QA lead reviews each deliverable |
+| `project-finisher` | manager (repo checks, reviewer) | Finishes work in an existing repository (`--project`): the lead plans, the engineer edits, the repo's own checks gate, a reviewer on another family advises, a branch is delivered |
+| `research-desk` | parallel → review loop → approval | Three analysts in parallel, an editor merges, a fact-checker reviews, a human approves |
+
+Copy one to edit: `uv run cadre org new my-team --from software-team`, then
+`uv run cadre org validate my-team`.
+
+## The organisation file
+
+```yaml
+name: tiny-team
+agents:
+  - id: builder
+    role: Python engineer
+    tools: [list_files, read_file, write_file, run_check]
+  - id: reviewer
+    role: Code reviewer
+    diverse_from: builder          # prefer a different model family
+    tools: [list_files, read_file]
+checks:
+  - name: tests
+    command: ["{python}", "-m", "unittest", "discover", "-p", "test_*.py"]
+budget: {max_calls: 40, max_tokens: 150000, max_minutes: 20, max_parallel: 2}
+workflow:
+  - builder: builder
+    reviewers: [reviewer]
+    checks: [tests]
+    max_rounds: 3
+    task: "Build {goal} in app.py with tests in test_app.py."
+```
+
+Step types (`type:` may be omitted when the keys make it obvious):
+
+| Type | Does |
+|---|---|
+| `agent` | one agent, one task, bounded tool turns |
+| `sequence` | steps in order (a bare list is a sequence); `{prev}` is the last output |
+| `parallel` | steps at once, optionally combined by a `join` agent |
+| `review_loop` | builder → checks → reviewers (JSON verdicts) → feedback, up to `max_rounds` |
+| `council` | proposals → critique rounds → options → votes → tally (`majority`, `supermajority`, `unanimous`, `plurality`) → memo |
+| `manager` | manager plans a task graph, workers run it in dependency order, optional reviewer, final report |
+| `approval` | wait for a human |
+
+Templates can use `{goal}`, `{prev}` and `{out.<step id>}`. Tools: `list_files`, `read_file`,
+`search`, `write_file`, `edit_file`, `post_note`, `run_check`, `ask_human` (see *Agent tools*).
+Everything is validated before the first
+model call, and errors name their path in the file.
+
+## Free providers (checked 2026-09-17)
+
+Every free chat model a key reaches is its own quota bucket. Each provider also has its own
+daily clock and a recorded answer to "does the free tier train on my prompts?".
+
+| Preset | Models and limits Cadre starts from | Day resets | Trains on free prompts |
+|---|---|---|---|
+| `groq` | `openai/gpt-oss-120b`, `gpt-oss-20b`, `qwen/qwen3.8-27b`: 30 RPM, 1,000 RPD, 8,000 TPM, 200k TPD each (docs). Two model families on one key | rolling (no clock published; headers override) | no |
+| `gemini` | Seven chat models, each its own bucket: Gemini 3.8/3.7/3.6/3.5 Flash, 3 Flash preview, 3.5/3.1 Flash-Lite (the 2.5 models answered 404 to a new key on 2026-09-17). Google publishes no per-model numbers; Flash 20 RPD and Flash-Lite 500 RPD are third-party reports, the rest are guesses; a daily-quota 429 teaches Cadre the real limit | midnight Pacific (docs) | **yes** |
+| `openrouter` | `:free` models, discovered: 20 RPM, 50/day (1,000/day once 10 credits were ever bought) (docs) | UTC day (docs) | unknown — depends on the model's host |
+| `mistral` | medium/small: 2 RPM (reported) | not stated | **yes** unless you opt out |
+| `cohere` | `command-a-03-2025`: 20 RPM, 1,000 calls/month, non-commercial (docs) | not stated | yes unless you opt out |
+| `nvidia` | `meta/llama-3.3-70b-instruct`: 40 RPM (reported); trial credits | not stated | **yes** (trial terms) |
+| `cloudflare` | Llama 3.3 70B, gpt-oss-120b: 10,000 neurons/day, 300 RPM; needs `--param account_id=…` | 00:00 UTC (docs) | no |
+| `zai` | `glm-4.7-flash`, `glm-4.5-flash` (free per docs; limits guessed) | not stated | unknown |
+| `huggingface` | ~$0.10 credit/month | counted per UTC day (the credit itself is monthly) | unknown — depends on the upstream provider |
+| `ollama`, `llamacpp`, `lmstudio` | local, no key, no limits — slow on an 8 GB laptop | — | no |
+| `deepseek`, `openai`, `anthropic`, `custom` | **paid**, opt-in, same adapter. DeepSeek has no free tier, and OpenRouter listed no free DeepSeek model on 2026-09-17 | — | — |
+
+Free catalogues change without notice: Cerebras became a card-required trial and GitHub Models
+was retired in July 2026. These numbers are only starting values. Cadre overrides them with each
+provider's own rate-limit headers, `cadre provider refresh` shows what each endpoint serves today
+(`--apply` adds new models and disables vanished ones, never touching limits you set), and any
+number can be changed with `cadre provider set-model`. Cadre keeps 10% of every daily cap unused
+(`reserve_pct`) for other programs that share the key.
+
+Use **one account per provider.** Capacity grows by adding *different* providers; several
+accounts or projects at one provider to multiply a free limit breaks their terms.
+
+### Private runs
+
+`cadre run … --private` (or `privacy: private` in the org file) only uses providers that say they
+do not train on prompts — today Groq, Cloudflare and local models. The run records which models it
+excluded, and fails before its first call if none are left.
+
+## Agent tools
+
+`list_files`, `read_file` (optionally a line range), `search` (regex, capped), `write_file`,
+`edit_file` (replace one exact, unique match — far cheaper than rewriting a file), `post_note`,
+`run_check` (a check *named* in the org file) and `ask_human`. An agent only gets the tools its
+entry lists. Agents with file tools also see a capped repo map: paths, line counts and top-level
+Python classes and functions.
+
+## Safety
+
+- **Checks run code the agents wrote, as you, on your machine. This is not a sandbox.** The
+  model can only name a check declared in the org file; it never supplies a command. Checks run
+  in the run's workspace with a timeout, capped output, and an environment stripped of anything
+  that looks like a key, token or password. They need `--allow-exec` or your approval. Don't
+  give an untrusted goal to an org with checks; a container runner is on the roadmap.
+- File tools cannot leave the run workspace (absolute paths, `..`, symlinks, drive letters,
+  device names and alternate data streams are refused).
+- The API listens on 127.0.0.1, requires a bearer token (`~/.cadre/token`) on every call,
+  rejects non-loopback `Host` headers, sends no CORS headers, and serves a strict CSP.
+- Keys live in the OS credential store or your environment — never in `config.yaml`, the
+  database, events, API responses or logs. Loaded keys are redacted from everything stored.
+- Respect each provider's terms. Cadre spreads work across *different* providers; it does not
+  create accounts or rotate several keys of one provider to get around a limit.
+
+## Development
+
+```bash
+uv run pytest -q
+uv run ruff check src tests
+```
+
+The tests need no network and no key: HTTP is mocked and models are scripted. See
+[`CONTRIBUTING.md`](https://github.com/Daemon-VI/cadre/blob/main/CONTRIBUTING.md); report security problems privately as described in
+[`SECURITY.md`](https://github.com/Daemon-VI/cadre/blob/main/SECURITY.md).
+
+## Licence
+
+Apache-2.0. See [`LICENSE`](https://github.com/Daemon-VI/cadre/blob/main/LICENSE).
+
+## Documentation
+
+- [`docs/SRS.md`](https://github.com/Daemon-VI/cadre/blob/main/docs/SRS.md) — requirements (the refined idea, FR/NFR list)
+- [`docs/ARCHITECTURE.md`](https://github.com/Daemon-VI/cadre/blob/main/docs/ARCHITECTURE.md) — design and decision records
+- [`docs/OBJECTIVES.md`](https://github.com/Daemon-VI/cadre/blob/main/docs/OBJECTIVES.md) — objectives, how each is met, evidence
+- [`docs/TEST_PLAN.md`](https://github.com/Daemon-VI/cadre/blob/main/docs/TEST_PLAN.md) — test strategy and requirement traceability
+- [`docs/ROADMAP.md`](https://github.com/Daemon-VI/cadre/blob/main/docs/ROADMAP.md) — what comes next, and what was deferred and why
+- [`docs/PROJECT_STATE.md`](https://github.com/Daemon-VI/cadre/blob/main/docs/PROJECT_STATE.md) — where the project actually stands