rapier-runtime 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (74) hide show
  1. rapier_runtime-0.1.0/.gitignore +31 -0
  2. rapier_runtime-0.1.0/LICENSE +202 -0
  3. rapier_runtime-0.1.0/PKG-INFO +249 -0
  4. rapier_runtime-0.1.0/README.md +219 -0
  5. rapier_runtime-0.1.0/SECURITY.md +41 -0
  6. rapier_runtime-0.1.0/docs/STATUS.md +57 -0
  7. rapier_runtime-0.1.0/docs/mcp-server-scope.md +102 -0
  8. rapier_runtime-0.1.0/docs/threat-model.md +75 -0
  9. rapier_runtime-0.1.0/manifests/echo.yaml +12 -0
  10. rapier_runtime-0.1.0/manifests/sparring.full.yaml +37 -0
  11. rapier_runtime-0.1.0/manifests/sparring.proposer.yaml +17 -0
  12. rapier_runtime-0.1.0/manifests/sparring.spar.yaml +32 -0
  13. rapier_runtime-0.1.0/pyproject.toml +58 -0
  14. rapier_runtime-0.1.0/site/README.md +47 -0
  15. rapier_runtime-0.1.0/site/coming-soon.html +106 -0
  16. rapier_runtime-0.1.0/site/index.html +393 -0
  17. rapier_runtime-0.1.0/src/rapier/__init__.py +70 -0
  18. rapier_runtime-0.1.0/src/rapier/_json.py +39 -0
  19. rapier_runtime-0.1.0/src/rapier/cli.py +244 -0
  20. rapier_runtime-0.1.0/src/rapier/convergence.py +93 -0
  21. rapier_runtime-0.1.0/src/rapier/envelope.py +66 -0
  22. rapier_runtime-0.1.0/src/rapier/ledger.py +71 -0
  23. rapier_runtime-0.1.0/src/rapier/manifest.py +75 -0
  24. rapier_runtime-0.1.0/src/rapier/mcp/__init__.py +9 -0
  25. rapier_runtime-0.1.0/src/rapier/mcp/server.py +184 -0
  26. rapier_runtime-0.1.0/src/rapier/mcp/tools.py +125 -0
  27. rapier_runtime-0.1.0/src/rapier/models.py +352 -0
  28. rapier_runtime-0.1.0/src/rapier/onboarding.py +128 -0
  29. rapier_runtime-0.1.0/src/rapier/pipeline.py +145 -0
  30. rapier_runtime-0.1.0/src/rapier/presets.py +83 -0
  31. rapier_runtime-0.1.0/src/rapier/secrets.py +72 -0
  32. rapier_runtime-0.1.0/src/rapier/stage.py +98 -0
  33. rapier_runtime-0.1.0/src/rapier/stages/__init__.py +6 -0
  34. rapier_runtime-0.1.0/src/rapier/stages/echo.py +28 -0
  35. rapier_runtime-0.1.0/src/rapier/stages/proposer/__init__.py +7 -0
  36. rapier_runtime-0.1.0/src/rapier/stages/proposer/phase_stages.py +101 -0
  37. rapier_runtime-0.1.0/src/rapier/stages/proposer/phases.py +201 -0
  38. rapier_runtime-0.1.0/src/rapier/stages/resolver/__init__.py +22 -0
  39. rapier_runtime-0.1.0/src/rapier/stages/resolver/_binding.py +33 -0
  40. rapier_runtime-0.1.0/src/rapier/stages/resolver/_extract.py +82 -0
  41. rapier_runtime-0.1.0/src/rapier/stages/resolver/anchored_fix.py +52 -0
  42. rapier_runtime-0.1.0/src/rapier/stages/resolver/author.py +62 -0
  43. rapier_runtime-0.1.0/src/rapier/stages/resolver/citation_gate.py +123 -0
  44. rapier_runtime-0.1.0/src/rapier/stages/resolver/compose.py +457 -0
  45. rapier_runtime-0.1.0/src/rapier/stages/resolver/cross_review.py +45 -0
  46. rapier_runtime-0.1.0/src/rapier/stages/resolver/definitiveness_gate.py +55 -0
  47. rapier_runtime-0.1.0/src/rapier/verify/__init__.py +4 -0
  48. rapier_runtime-0.1.0/src/rapier/verify/_bootstrap.py +66 -0
  49. rapier_runtime-0.1.0/src/rapier/verify/_llm_shim.py +131 -0
  50. rapier_runtime-0.1.0/src/rapier/verify/_vendor/PROVENANCE.md +14 -0
  51. rapier_runtime-0.1.0/src/rapier/verify/_vendor/cite_check.py +1093 -0
  52. rapier_runtime-0.1.0/src/rapier/verify/_vendor/lib_llm.py +288 -0
  53. rapier_runtime-0.1.0/src/rapier/verify/_vendor/spar_cross_review.py +296 -0
  54. rapier_runtime-0.1.0/src/rapier/verify/_vendor/spar_definitiveness_gate.py +770 -0
  55. rapier_runtime-0.1.0/src/rapier/verify/_vendor/spar_verify_gate.py +233 -0
  56. rapier_runtime-0.1.0/src/rapier/verify/_vendor/verify_grounding.py +795 -0
  57. rapier_runtime-0.1.0/src/rapier/verify/service.py +46 -0
  58. rapier_runtime-0.1.0/tests/test_cli.py +83 -0
  59. rapier_runtime-0.1.0/tests/test_convergence.py +95 -0
  60. rapier_runtime-0.1.0/tests/test_envelope.py +25 -0
  61. rapier_runtime-0.1.0/tests/test_extract_json.py +36 -0
  62. rapier_runtime-0.1.0/tests/test_full_ceremony.py +154 -0
  63. rapier_runtime-0.1.0/tests/test_manifest.py +38 -0
  64. rapier_runtime-0.1.0/tests/test_mcp.py +159 -0
  65. rapier_runtime-0.1.0/tests/test_models_vendors.py +65 -0
  66. rapier_runtime-0.1.0/tests/test_onboarding.py +99 -0
  67. rapier_runtime-0.1.0/tests/test_pipeline.py +155 -0
  68. rapier_runtime-0.1.0/tests/test_policy.py +51 -0
  69. rapier_runtime-0.1.0/tests/test_proposer_g2.py +35 -0
  70. rapier_runtime-0.1.0/tests/test_proposer_stages.py +78 -0
  71. rapier_runtime-0.1.0/tests/test_resolver_stages.py +236 -0
  72. rapier_runtime-0.1.0/tests/test_secrets.py +40 -0
  73. rapier_runtime-0.1.0/tests/test_vendor_policy_v4.py +104 -0
  74. rapier_runtime-0.1.0/tests/test_verify_service.py +63 -0
@@ -0,0 +1,31 @@
1
+ # Python
2
+ __pycache__/
3
+ *.py[cod]
4
+ *.egg-info/
5
+ build/
6
+ dist/
7
+ .eggs/
8
+
9
+ # Environments
10
+ .venv/
11
+ venv/
12
+ env/
13
+
14
+ # Secrets — never commit
15
+ .env
16
+ *.env
17
+ !*.example.env
18
+
19
+ # Test / tooling
20
+ .pytest_cache/
21
+ .coverage
22
+ htmlcov/
23
+ .mypy_cache/
24
+ .ruff_cache/
25
+
26
+ # Rapier run artifacts (may contain decision content)
27
+ runs/
28
+
29
+ # Local test tooling (this environment lacks python3-venv)
30
+ .tools/
31
+ .pytmp/
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,249 @@
1
+ Metadata-Version: 2.4
2
+ Name: rapier-runtime
3
+ Version: 0.1.0
4
+ Summary: A code-orchestrated engine that runs the SPARRING method: grounded, cross-vendor adversarial review for AI-in-the-loop decisions.
5
+ Project-URL: Homepage, https://rapierruntime.com
6
+ Project-URL: Repository, https://github.com/muddyone/rapier-runtime
7
+ Project-URL: Issues, https://github.com/muddyone/rapier-runtime/issues
8
+ Project-URL: Paper, https://doi.org/10.5281/zenodo.21210265
9
+ Author-email: Bart Niedner <contact@resourceforge.com>
10
+ License-Expression: Apache-2.0
11
+ License-File: LICENSE
12
+ Keywords: adversarial-review,ai-governance,anti-sycophancy,decision-support,llm,sparring
13
+ Classifier: Development Status :: 3 - Alpha
14
+ Classifier: Intended Audience :: Developers
15
+ Classifier: License :: OSI Approved :: Apache Software License
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.10
18
+ Classifier: Programming Language :: Python :: 3.11
19
+ Classifier: Programming Language :: Python :: 3.12
20
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
21
+ Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
22
+ Requires-Python: >=3.10
23
+ Requires-Dist: pyyaml>=6.0
24
+ Requires-Dist: requests>=2.31
25
+ Provides-Extra: dev
26
+ Requires-Dist: pytest>=8.0; extra == 'dev'
27
+ Provides-Extra: mcp
28
+ Requires-Dist: mcp>=1.2; extra == 'mcp'
29
+ Description-Content-Type: text/markdown
30
+
31
+ # Rapier Runtime
32
+
33
+ **A code-orchestrated engine that runs the SPARRING method** — grounded,
34
+ cross-vendor adversarial review for AI-in-the-loop decisions.
35
+
36
+ Most AI tooling helps you *build* agent workflows. Rapier is different: it
37
+ *governs* them. It runs a structured, adversarial, grounded review over an AI's
38
+ proposed answer — cross-vendor by construction, with mechanical grounding
39
+ checks and a correctness gate — so that confident wrongness is structurally
40
+ hard to ship. The method is [SPARRING](https://github.com/muddyone/sparring-publicaccess);
41
+ Rapier is the runtime that executes it.
42
+
43
+ > **Method vs. runtime.** *SPARRING* is the method (the concept, described in
44
+ > its own papers and framework). *Rapier* is the runtime that executes a
45
+ > SPARRING method declared in a manifest. Upgrade the runtime, or swap a model
46
+ > in a manifest, without changing the method.
47
+
48
+ Free and open source (Apache-2.0). Not monetized.
49
+
50
+ ---
51
+
52
+ ## Status: pre-alpha — the full ceremony runs end-to-end (M0–M3 complete; M4 in progress)
53
+
54
+ This is early software, pinned pre-1.0 — but the whole method runs. What works
55
+ today:
56
+
57
+ - **The full SPARRING ceremony, end-to-end.** The **Proposer** (divergent
58
+ generation → false-novelty filter → the Cut — a cross-vendor convergence loop)
59
+ hands a committed option to the **Resolver** (author → cross-vendor review →
60
+ anchored correction → a correctness *definitiveness* gate → an external-canon
61
+ citation gate → a two-part report). Run the Resolver alone (`spar`) or the
62
+ whole loop (`sparring`).
63
+ - **Cross-vendor by construction.** Author and reviewer are always distinct
64
+ vendors when two keys are present, and it degrades *honestly* to single-vendor
65
+ (and says so) when only one is. Any role can be Anthropic, OpenAI, Gemini,
66
+ Grok, or any OpenAI-compatible endpoint — vendor and model names live only in
67
+ a manifest.
68
+ - **A manifest *is* the method.** Reorder stages, swap a model, or point two
69
+ roles at two vendors — with no engine-code change. Built-in presets (`spar`,
70
+ `sparring`, `proposer`) cover the common cases; `--settle` and `--verify` tune
71
+ the resolver.
72
+ - **Grounding + a correctness gate.** The definitiveness gate checks that every
73
+ hard specific in the answer is traceable to the given facts or explicitly
74
+ flagged as an estimate; the citation gate resolves cited external canon
75
+ (CWE / RFC / DOI / …). Both wrap one shared, battle-tested verification
76
+ service — no duplicate copies.
77
+ - **Auditable and safe by design.** Opt-in, redacted, owner-only run
78
+ persistence; a verbatim model-call transcript; env-only secrets + redaction;
79
+ `yaml.safe_load`; a [threat model](docs/threat-model.md) and a
80
+ [security policy](SECURITY.md).
81
+
82
+ 116 tests pass. Cross-vendor runs are live-proven (Anthropic×OpenAI, Gemini×Grok).
83
+
84
+ **Honest boundary.** The definitiveness gate, anchored correction, and the
85
+ two-part trust rider are *exploratory* governance instruments — useful, but not
86
+ yet validated by a pre-registered study. Rapier makes confident wrongness
87
+ structurally *harder to ship*; it does not make an answer correct.
88
+
89
+ ## Quickstart
90
+
91
+ ```bash
92
+ pip install . # or: pip install git+https://github.com/muddyone/rapier-runtime.git
93
+
94
+ export ANTHROPIC_API_KEY=... # author + gate
95
+ export OPENAI_API_KEY=... # a distinct cross-vendor reviewer
96
+ # (or GEMINI_API_KEY / XAI_API_KEY)
97
+
98
+ rapier spar --request "Should we adopt Kubernetes for one flat-traffic web app?"
99
+ rapier sparring --request "Monorepo or separate repos for our three services?"
100
+ ```
101
+
102
+ `spar` runs the Resolver on a chosen option; `sparring` runs the full four-phase
103
+ ceremony. Add `--settle N` for extra decision-stability rounds, or
104
+ `--verify off|gate|round` to tune the citation gate. Point `--ledger-dir` at a
105
+ directory to persist the run's transcript, report, and records.
106
+
107
+ No keys? The `mock` vendor needs none:
108
+
109
+ ```bash
110
+ rapier run --manifest manifests/echo.yaml --request "should we ship X?"
111
+ # -> [mock:rapier-echo-1] should we ship X?
112
+ ```
113
+
114
+ Runtime dependencies are just `requests` and `pyyaml` — every vendor is called
115
+ over the wire; no provider SDKs.
116
+
117
+ ## Configure your keys
118
+
119
+ Rapier reads vendor keys from the **environment only** — never from a file it
120
+ reads itself. Scaffold and check your setup:
121
+
122
+ ```bash
123
+ rapier init # writes .env.example (key names, no values)
124
+ # fill in .env, then load it into your shell:
125
+ set -a; source .env; set +a
126
+ rapier doctor # shows which vendors are configured (names only — never values)
127
+ ```
128
+
129
+ `doctor` reports each vendor's key env var as set/unset and whether cross-vendor
130
+ review is available (two or more keys). A ceremony launched with **no** keys
131
+ fails loudly with an actionable message instead of producing empty output.
132
+
133
+ ### Keep your keys loaded
134
+
135
+ Environment variables last only for the current shell, so `source .env` sets
136
+ them up for **this session** — a new terminal starts empty. That's the same as
137
+ `aws`, `gh`, and most API-key CLIs, and it's deliberate here: Rapier reads keys
138
+ only from the environment and never persists a secret itself. To avoid re-running
139
+ the command each time, set it up once:
140
+
141
+ - **Load in every shell** — add the source line to your shell profile (e.g.
142
+ `~/.bashrc` or `~/.zshrc`), pointing at a keys file you keep outside any repo:
143
+
144
+ ```bash
145
+ # add once to ~/.bashrc
146
+ set -a; source ~/.config/rapier/keys.env; set +a
147
+ ```
148
+
149
+ Simplest for a personal machine. (Trade-off: the keys then load into *every*
150
+ shell, and live in a file on disk — fine for your own box, less so on a shared
151
+ one.)
152
+
153
+ - **Load per directory — [`direnv`](https://direnv.net/)** — auto-loads a
154
+ project's `.env` when you `cd` in and unloads it when you leave. Cleaner
155
+ isolation; a one-time `direnv allow` per directory.
156
+
157
+ - **Per session** — just run `set -a; source .env; set +a` when you sit down to
158
+ use it. Fine for occasional use.
159
+
160
+ One gotcha: `source` runs the file as shell, so every value with spaces must be
161
+ **quoted** (`FOO="a b c"`, not `FOO=a b c`) or `source` will try to run the extra
162
+ words as a command. If sourcing errors, that's usually the cause.
163
+
164
+ ## Use it from an MCP client (optional)
165
+
166
+ Expose `spar` / `sparring` (and a `rapier_doctor` check) as tools to any MCP
167
+ client — Claude Desktop, editors, agents:
168
+
169
+ ```bash
170
+ pip install "rapier-runtime[mcp]"
171
+ ```
172
+
173
+ Point the client at the stdio server. Keys travel in the server's `env` block —
174
+ the client launches the process with them, and the engine reads them from the
175
+ environment (it still reads no secret from a file):
176
+
177
+ ```jsonc
178
+ {
179
+ "mcpServers": {
180
+ "rapier": {
181
+ "command": "rapier",
182
+ "args": ["mcp"],
183
+ "env": { "ANTHROPIC_API_KEY": "…", "OPENAI_API_KEY": "…" }
184
+ }
185
+ }
186
+ }
187
+ ```
188
+
189
+ ## Updating & staying current
190
+
191
+ Check your version, and update to the latest release:
192
+
193
+ ```bash
194
+ rapier --version # what you have (also shown by `rapier doctor`)
195
+ pip install -U rapier-runtime # update to the latest ( add [mcp] if you use the MCP server )
196
+ ```
197
+
198
+ Because Rapier can read files, fetch URLs, and call model vendors, **staying
199
+ current matters for security.** How to hear about issues:
200
+
201
+ - **Security fixes** are published as **GitHub Security Advisories**, which flow
202
+ into the Python vulnerability databases — so `pip-audit` and GitHub Dependabot
203
+ will flag an affected version automatically if you use them.
204
+ - **Watch [Releases](https://github.com/muddyone/rapier-runtime/releases)** on
205
+ GitHub (Watch → Custom → Releases) to be notified of new versions.
206
+ - **Found a vulnerability?** Report it privately — see
207
+ [`SECURITY.md`](SECURITY.md). Please don't open a public issue.
208
+
209
+ Rapier does **not** phone home to check for updates — nothing about your usage
210
+ leaves your machine except the model calls you configure.
211
+
212
+ ## A manifest is the method
213
+
214
+ ```yaml
215
+ name: echo
216
+ pipeline:
217
+ - stage: echo
218
+ config: { note: "hello from Rapier" }
219
+ roles:
220
+ author: { vendor: mock, model: rapier-echo-1 }
221
+ ```
222
+
223
+ Editing the manifest changes the method — reorder stages, swap a model, point
224
+ two roles at two different vendors — without touching engine code.
225
+
226
+ ## Roadmap
227
+
228
+ | Milestone | What | |
229
+ |---|---|---|
230
+ | M0 | Skeleton + threat model + security baseline | ✅ |
231
+ | M1 | Resolver ported (one shared grounding/verification service) | ✅ |
232
+ | M2 | The Proposer (convergence primitive; SPARK / Pattern Lock / the Cut; cross-vendor roles) | ✅ |
233
+ | M3 | Full controller + the `spar` / `sparring` adapters (the whole ceremony end-to-end) | ✅ |
234
+ | M4 | Hardening + packaging + first public release | in progress |
235
+
236
+ ## Development
237
+
238
+ ```bash
239
+ pip install -e '.[dev]'
240
+ pytest -q
241
+ ```
242
+
243
+ ## License
244
+
245
+ Apache-2.0. See [LICENSE](LICENSE).
246
+
247
+ ---
248
+
249
+ Rapier Runtime and the SPARRING method are projects of **[ResourceForge](https://resourceforge.com)**.