runeward 0.2.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.
@@ -0,0 +1,67 @@
1
+ # Binaries (built at the repo root). Anchored with a leading slash so these do
2
+ # NOT match the cmd/<name> source dirs or deploy/helm/runeward/.
3
+ /bin/
4
+ /dist/bin/
5
+ /runeward
6
+ /runeward-agent
7
+ /runeward-browser
8
+ /runeward-egress
9
+
10
+ # Go
11
+ *.test
12
+ *.out
13
+ /vendor/
14
+
15
+ # Python
16
+ __pycache__/
17
+ *.pyc
18
+
19
+ # Local scratch / runtime state
20
+ /.tmp/
21
+ /.runeward-fleet
22
+
23
+ # Ledger / signing keys / runtime state (should only live under $RUNEWARD_STATE_DIR)
24
+ *.key
25
+ *.pem
26
+ ledger.jsonl
27
+ fleets.json
28
+ .env
29
+ .env.*
30
+
31
+ # Editor/local config with machine-specific absolute paths
32
+ /.cursor/
33
+
34
+ # Release build outputs (produced in CI)
35
+ /dist-bin/
36
+ /dist-chart/
37
+ /dist-release/
38
+ *.tgz
39
+
40
+ # Docs site build output (MkDocs)
41
+ /site/
42
+
43
+ # Local profiles carry secret references — never commit user-global ones.
44
+ /.runeward/
45
+
46
+ # Local scratch notes / runbooks (not part of the published docs)
47
+ /NOTES-*.md
48
+
49
+ # OS / editor
50
+ .DS_Store
51
+ *.swp
52
+
53
+ ROADMAP.md
54
+
55
+ # Node (TypeScript adapter) — installed deps + build output
56
+ /adapters/typescript/node_modules/
57
+ /adapters/typescript/dist/
58
+ /adapters/python/dist/
59
+
60
+ # Signed-profile artifacts produced by `profile sign` during testing
61
+ *.toml.sig
62
+
63
+ # Scratch profiles generated inline by the E2E walkthrough (see docs §33)
64
+ /examples/budget-demo.toml
65
+ /examples/limits-demo.toml
66
+ /examples/loop-demo.toml
67
+ /examples/secret-env.toml
runeward-0.2.0/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or Derivative
95
+ Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work, excluding
103
+ those notices that do not pertain to any part of the Derivative
104
+ Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and do
117
+ not modify the License. You may add Your own attribution notices
118
+ within Derivative Works that You distribute, alongside or as an
119
+ addendum to the NOTICE text from the Work, provided that such
120
+ additional attribution notices cannot be construed as modifying
121
+ the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 The runeward Authors
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,217 @@
1
+ Metadata-Version: 2.4
2
+ Name: runeward
3
+ Version: 0.2.0
4
+ Summary: Python SDK for governing AI agent execution with policy, approvals, isolation, budgets, and signed evidence.
5
+ Project-URL: Homepage, https://github.com/Runewardd/runeward
6
+ Project-URL: Repository, https://github.com/Runewardd/runeward
7
+ Project-URL: Documentation, https://runewardd.github.io/runeward/
8
+ Project-URL: Issues, https://github.com/Runewardd/runeward/issues
9
+ Project-URL: Changelog, https://github.com/Runewardd/runeward/releases
10
+ Author: Runeward contributors
11
+ License-Expression: Apache-2.0
12
+ License-File: LICENSE
13
+ Keywords: agents,ai,crewai,governance,langchain,llamaindex,mcp,openai-agents,sandbox,strands
14
+ Classifier: Development Status :: 3 - Alpha
15
+ Classifier: Intended Audience :: Developers
16
+ Classifier: Operating System :: OS Independent
17
+ Classifier: Programming Language :: Python :: 3
18
+ Classifier: Programming Language :: Python :: 3.9
19
+ Classifier: Programming Language :: Python :: 3.10
20
+ Classifier: Programming Language :: Python :: 3.11
21
+ Classifier: Programming Language :: Python :: 3.12
22
+ Classifier: Programming Language :: Python :: 3.13
23
+ Classifier: Programming Language :: Python :: 3.14
24
+ Classifier: Topic :: Software Development :: Libraries
25
+ Classifier: Typing :: Typed
26
+ Requires-Python: >=3.9
27
+ Provides-Extra: crewai
28
+ Requires-Dist: crewai>=0.30; extra == 'crewai'
29
+ Requires-Dist: pydantic>=2; extra == 'crewai'
30
+ Provides-Extra: langchain
31
+ Requires-Dist: langchain-core>=0.2; extra == 'langchain'
32
+ Provides-Extra: llamaindex
33
+ Requires-Dist: llama-index-core>=0.11; extra == 'llamaindex'
34
+ Provides-Extra: openai-agents
35
+ Requires-Dist: openai-agents>=0.0.1; extra == 'openai-agents'
36
+ Provides-Extra: strands
37
+ Requires-Dist: strands-agents>=1.0; extra == 'strands'
38
+ Description-Content-Type: text/markdown
39
+
40
+ # runeward (Python)
41
+
42
+ A dependency-light Python client and agent-framework adapters for the
43
+ [Runeward](https://github.com/Runewardd/runeward) **agent governance harness**.
44
+ Put policy, human approvals, isolated Citadels, Rationing, and signed Chronicles
45
+ around an existing agent without replacing its model or framework.
46
+
47
+ The core client uses **only the Python standard library** (`urllib`). The
48
+ LangChain, CrewAI, LlamaIndex, OpenAI Agents SDK, and Strands helpers are
49
+ optional extras and are imported lazily, so the base client works with nothing
50
+ else installed.
51
+
52
+ ## Install
53
+
54
+ ```bash
55
+ pip install runeward # core client only (no third-party deps)
56
+ pip install "runeward[langchain]" # + LangChain tools
57
+ pip install "runeward[crewai]" # + CrewAI tools
58
+ pip install "runeward[llamaindex]" # + LlamaIndex tools
59
+ pip install "runeward[openai-agents]" # + OpenAI Agents SDK tools
60
+ pip install "runeward[strands]" # + Strands Agents SDK tools
61
+ ```
62
+
63
+ During local development from this directory:
64
+
65
+ ```bash
66
+ pip install -e .
67
+ ```
68
+
69
+ ## Quick start
70
+
71
+ Start the control plane first (`runeward serve`, default
72
+ `http://localhost:8080`), then:
73
+
74
+ ```python
75
+ from runeward import RunewardClient, RunewardDenied, RunewardApprovalRequired
76
+
77
+ rw = RunewardClient("http://localhost:8080")
78
+
79
+ sbx = rw.create_sandbox("dev") # -> {"id": "sbx_...", "backend": "docker", ...}
80
+ sid = sbx["id"]
81
+
82
+ result = rw.shell(sid, ["python3", "--version"])
83
+ print(result["stdout"]) # "Python 3.11.2\n"
84
+
85
+ rw.write_file(sid, "/workspace/main.py", "print(2 + 2)")
86
+ print(rw.python(sid, "exec(open('/workspace/main.py').read())")["stdout"]) # "4\n"
87
+
88
+ rw.kill_sandbox(sid) # always tear down when done
89
+ ```
90
+
91
+ Use `allow_insecure=True` (or `RUNEWARD_ALLOW_INSECURE_HTTP=1`) only when you must call a non-loopback `http://` control-plane endpoint.
92
+
93
+ ### Handling governance verdicts
94
+
95
+ The two governance outcomes are raised as typed exceptions. Handle them
96
+ explicitly — a denial must **not** be blindly retried, and an approval gate must
97
+ **pause** for a human:
98
+
99
+ ```python
100
+ try:
101
+ rw.shell(sid, ["rm", "-rf", "/"])
102
+ except RunewardDenied as e:
103
+ print("blocked by policy:", e.reason) # do NOT retry the same action
104
+
105
+ try:
106
+ rw.write_file(sid, "/etc/hosts", "127.0.0.1 example")
107
+ except RunewardApprovalRequired as e:
108
+ print("needs a human:", e.approval_id) # pause; ask an operator to approve/deny
109
+ ```
110
+
111
+ ### Approvals inbox
112
+
113
+ ```python
114
+ for a in rw.list_approvals():
115
+ print(a["id"], a["tool"], a["action"], a["reason"])
116
+
117
+ rw.approve("apr_31c") # or rw.deny("apr_31c")
118
+ ```
119
+
120
+ ### Chronicle (audit ledger)
121
+
122
+ ```python
123
+ events = rw.audit(sid) # this Citadel's Chronicle events
124
+ assert rw.verify_audit() # verify the tamper-evident hash chain
125
+ ```
126
+
127
+ ## Client method surface
128
+
129
+ | Method | REST endpoint |
130
+ | --- | --- |
131
+ | `healthz()` | `GET /healthz` |
132
+ | `list_profiles()` | `GET /v1/charters` |
133
+ | `create_sandbox(profile)` | `POST /v1/citadels` |
134
+ | `list_sandboxes()` / `get_sandbox(id)` / `kill_sandbox(id)` | `GET`/`GET`/`DELETE /v1/citadels[/{id}]` |
135
+ | `shell(sandbox, command, workdir="")` | `POST .../shell/exec` |
136
+ | `python(sandbox, code)` / `node(sandbox, code)` | `POST .../code/{python,node}` |
137
+ | `read_file` / `write_file` / `list_files` / `search_files` | `POST .../file/{read,write,list,search}` |
138
+ | `audit(sandbox)` / `verify_audit()` | `GET .../chronicle`, `GET /v1/chronicle/verify` |
139
+ | `list_approvals()` / `approve(id)` / `deny(id)` | `GET /v1/conclave`, `POST /v1/conclave/{id}/{approve,deny}` |
140
+
141
+ ## LangChain
142
+
143
+ ```python
144
+ from runeward import RunewardClient
145
+ from runeward.langchain_tools import make_runeward_tools
146
+
147
+ tools = make_runeward_tools(RunewardClient("http://localhost:8080"))
148
+ # Pass `tools` to any LangChain agent / AgentExecutor.
149
+ ```
150
+
151
+ The Python framework tools are named `runeward_create_sandbox`,
152
+ `runeward_shell`, …. Governance verdicts are returned as descriptive strings so
153
+ the agent can reason about a denial or an approval gate. (Note: the standalone
154
+ `runeward mcp` server now exposes the renamed `runeward_create_citadel` /
155
+ `runeward_kill_citadel` / `runeward_list_conclave` tools; the Python framework
156
+ tool names have not yet been updated to match.)
157
+
158
+ ## CrewAI
159
+
160
+ ```python
161
+ from runeward import RunewardClient
162
+ from runeward.crewai_tools import make_runeward_tools
163
+
164
+ tools = make_runeward_tools(RunewardClient("http://localhost:8080"))
165
+ # Attach `tools` to a crewai.Agent(tools=tools, ...).
166
+ ```
167
+
168
+ ## LlamaIndex
169
+
170
+ ```python
171
+ from runeward import RunewardClient
172
+ from runeward.llamaindex_tools import make_runeward_tools
173
+
174
+ tools = make_runeward_tools(RunewardClient("http://localhost:8080"))
175
+ # Pass `tools` to a FunctionAgent / ReActAgent / AgentRunner.
176
+ ```
177
+
178
+ Returns `llama_index.core.tools.FunctionTool` instances; the tool schema is
179
+ derived from each function's type hints and docstring.
180
+
181
+ ## OpenAI Agents SDK
182
+
183
+ ```python
184
+ from agents import Agent, Runner
185
+ from runeward import RunewardClient
186
+ from runeward.openai_agents_tools import make_runeward_tools
187
+
188
+ tools = make_runeward_tools(RunewardClient("http://localhost:8080"))
189
+ agent = Agent(name="builder", instructions="Use the sandbox tools.", tools=tools)
190
+ result = Runner.run_sync(agent, "Create a dev sandbox, run `node --version`, then tear it down.")
191
+ ```
192
+
193
+ Returns `@function_tool`-built tools; the SDK derives each schema from the
194
+ function's type hints and docstring.
195
+
196
+ ## Strands Agents SDK
197
+
198
+ ```python
199
+ from strands import Agent
200
+ from runeward import RunewardClient
201
+ from runeward.strands_tools import make_runeward_tools
202
+
203
+ tools = make_runeward_tools(RunewardClient("http://localhost:8080"))
204
+ agent = Agent(tools=tools)
205
+ agent("Create a dev sandbox, run `node --version`, then tear it down.")
206
+ ```
207
+
208
+ Returns `@tool`-decorated functions; Strands derives each schema from the
209
+ function's type hints and docstring.
210
+
211
+ ## Notes
212
+
213
+ - **`deny` is a policy decision, not a transient error.** Don't retry the same
214
+ action; pick a different, allowed approach.
215
+ - **`require-approval` is a hard pause.** Surface the `approval_id` to a human
216
+ and wait for the outcome.
217
+ - Prefer the tightest profile that lets the task succeed.
@@ -0,0 +1,178 @@
1
+ # runeward (Python)
2
+
3
+ A dependency-light Python client and agent-framework adapters for the
4
+ [Runeward](https://github.com/Runewardd/runeward) **agent governance harness**.
5
+ Put policy, human approvals, isolated Citadels, Rationing, and signed Chronicles
6
+ around an existing agent without replacing its model or framework.
7
+
8
+ The core client uses **only the Python standard library** (`urllib`). The
9
+ LangChain, CrewAI, LlamaIndex, OpenAI Agents SDK, and Strands helpers are
10
+ optional extras and are imported lazily, so the base client works with nothing
11
+ else installed.
12
+
13
+ ## Install
14
+
15
+ ```bash
16
+ pip install runeward # core client only (no third-party deps)
17
+ pip install "runeward[langchain]" # + LangChain tools
18
+ pip install "runeward[crewai]" # + CrewAI tools
19
+ pip install "runeward[llamaindex]" # + LlamaIndex tools
20
+ pip install "runeward[openai-agents]" # + OpenAI Agents SDK tools
21
+ pip install "runeward[strands]" # + Strands Agents SDK tools
22
+ ```
23
+
24
+ During local development from this directory:
25
+
26
+ ```bash
27
+ pip install -e .
28
+ ```
29
+
30
+ ## Quick start
31
+
32
+ Start the control plane first (`runeward serve`, default
33
+ `http://localhost:8080`), then:
34
+
35
+ ```python
36
+ from runeward import RunewardClient, RunewardDenied, RunewardApprovalRequired
37
+
38
+ rw = RunewardClient("http://localhost:8080")
39
+
40
+ sbx = rw.create_sandbox("dev") # -> {"id": "sbx_...", "backend": "docker", ...}
41
+ sid = sbx["id"]
42
+
43
+ result = rw.shell(sid, ["python3", "--version"])
44
+ print(result["stdout"]) # "Python 3.11.2\n"
45
+
46
+ rw.write_file(sid, "/workspace/main.py", "print(2 + 2)")
47
+ print(rw.python(sid, "exec(open('/workspace/main.py').read())")["stdout"]) # "4\n"
48
+
49
+ rw.kill_sandbox(sid) # always tear down when done
50
+ ```
51
+
52
+ Use `allow_insecure=True` (or `RUNEWARD_ALLOW_INSECURE_HTTP=1`) only when you must call a non-loopback `http://` control-plane endpoint.
53
+
54
+ ### Handling governance verdicts
55
+
56
+ The two governance outcomes are raised as typed exceptions. Handle them
57
+ explicitly — a denial must **not** be blindly retried, and an approval gate must
58
+ **pause** for a human:
59
+
60
+ ```python
61
+ try:
62
+ rw.shell(sid, ["rm", "-rf", "/"])
63
+ except RunewardDenied as e:
64
+ print("blocked by policy:", e.reason) # do NOT retry the same action
65
+
66
+ try:
67
+ rw.write_file(sid, "/etc/hosts", "127.0.0.1 example")
68
+ except RunewardApprovalRequired as e:
69
+ print("needs a human:", e.approval_id) # pause; ask an operator to approve/deny
70
+ ```
71
+
72
+ ### Approvals inbox
73
+
74
+ ```python
75
+ for a in rw.list_approvals():
76
+ print(a["id"], a["tool"], a["action"], a["reason"])
77
+
78
+ rw.approve("apr_31c") # or rw.deny("apr_31c")
79
+ ```
80
+
81
+ ### Chronicle (audit ledger)
82
+
83
+ ```python
84
+ events = rw.audit(sid) # this Citadel's Chronicle events
85
+ assert rw.verify_audit() # verify the tamper-evident hash chain
86
+ ```
87
+
88
+ ## Client method surface
89
+
90
+ | Method | REST endpoint |
91
+ | --- | --- |
92
+ | `healthz()` | `GET /healthz` |
93
+ | `list_profiles()` | `GET /v1/charters` |
94
+ | `create_sandbox(profile)` | `POST /v1/citadels` |
95
+ | `list_sandboxes()` / `get_sandbox(id)` / `kill_sandbox(id)` | `GET`/`GET`/`DELETE /v1/citadels[/{id}]` |
96
+ | `shell(sandbox, command, workdir="")` | `POST .../shell/exec` |
97
+ | `python(sandbox, code)` / `node(sandbox, code)` | `POST .../code/{python,node}` |
98
+ | `read_file` / `write_file` / `list_files` / `search_files` | `POST .../file/{read,write,list,search}` |
99
+ | `audit(sandbox)` / `verify_audit()` | `GET .../chronicle`, `GET /v1/chronicle/verify` |
100
+ | `list_approvals()` / `approve(id)` / `deny(id)` | `GET /v1/conclave`, `POST /v1/conclave/{id}/{approve,deny}` |
101
+
102
+ ## LangChain
103
+
104
+ ```python
105
+ from runeward import RunewardClient
106
+ from runeward.langchain_tools import make_runeward_tools
107
+
108
+ tools = make_runeward_tools(RunewardClient("http://localhost:8080"))
109
+ # Pass `tools` to any LangChain agent / AgentExecutor.
110
+ ```
111
+
112
+ The Python framework tools are named `runeward_create_sandbox`,
113
+ `runeward_shell`, …. Governance verdicts are returned as descriptive strings so
114
+ the agent can reason about a denial or an approval gate. (Note: the standalone
115
+ `runeward mcp` server now exposes the renamed `runeward_create_citadel` /
116
+ `runeward_kill_citadel` / `runeward_list_conclave` tools; the Python framework
117
+ tool names have not yet been updated to match.)
118
+
119
+ ## CrewAI
120
+
121
+ ```python
122
+ from runeward import RunewardClient
123
+ from runeward.crewai_tools import make_runeward_tools
124
+
125
+ tools = make_runeward_tools(RunewardClient("http://localhost:8080"))
126
+ # Attach `tools` to a crewai.Agent(tools=tools, ...).
127
+ ```
128
+
129
+ ## LlamaIndex
130
+
131
+ ```python
132
+ from runeward import RunewardClient
133
+ from runeward.llamaindex_tools import make_runeward_tools
134
+
135
+ tools = make_runeward_tools(RunewardClient("http://localhost:8080"))
136
+ # Pass `tools` to a FunctionAgent / ReActAgent / AgentRunner.
137
+ ```
138
+
139
+ Returns `llama_index.core.tools.FunctionTool` instances; the tool schema is
140
+ derived from each function's type hints and docstring.
141
+
142
+ ## OpenAI Agents SDK
143
+
144
+ ```python
145
+ from agents import Agent, Runner
146
+ from runeward import RunewardClient
147
+ from runeward.openai_agents_tools import make_runeward_tools
148
+
149
+ tools = make_runeward_tools(RunewardClient("http://localhost:8080"))
150
+ agent = Agent(name="builder", instructions="Use the sandbox tools.", tools=tools)
151
+ result = Runner.run_sync(agent, "Create a dev sandbox, run `node --version`, then tear it down.")
152
+ ```
153
+
154
+ Returns `@function_tool`-built tools; the SDK derives each schema from the
155
+ function's type hints and docstring.
156
+
157
+ ## Strands Agents SDK
158
+
159
+ ```python
160
+ from strands import Agent
161
+ from runeward import RunewardClient
162
+ from runeward.strands_tools import make_runeward_tools
163
+
164
+ tools = make_runeward_tools(RunewardClient("http://localhost:8080"))
165
+ agent = Agent(tools=tools)
166
+ agent("Create a dev sandbox, run `node --version`, then tear it down.")
167
+ ```
168
+
169
+ Returns `@tool`-decorated functions; Strands derives each schema from the
170
+ function's type hints and docstring.
171
+
172
+ ## Notes
173
+
174
+ - **`deny` is a policy decision, not a transient error.** Don't retry the same
175
+ action; pick a different, allowed approach.
176
+ - **`require-approval` is a hard pause.** Surface the `approval_id` to a human
177
+ and wait for the outcome.
178
+ - Prefer the tightest profile that lets the task succeed.