terok-executor 0.1.0__tar.gz

terok_executor-0.1.0/LICENSE

@@ -0,0 +1,177 @@
+
+                                 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

terok_executor-0.1.0/LICENSES/Apache-2.0.txt

@@ -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.

terok_executor-0.1.0/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.4
+Name: terok-executor
+Version: 0.1.0
+Summary: Single-agent task runner for hardened Podman containers
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: LICENSES/Apache-2.0.txt
+Keywords: podman,containers,agent,ai,coding-agent
+Author: Jiri Vyskocil
+Author-email: jiri@vyskocil.com
+Maintainer: Jiri Vyskocil
+Maintainer-email: jiri@vyskocil.com
+Requires-Python: >=3.12,<3.15
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Typing :: Typed
+Requires-Dist: Jinja2 (>=3.1)
+Requires-Dist: agent-client-protocol (>=0.10.1)
+Requires-Dist: prompt-toolkit (>=3.0)
+Requires-Dist: pydantic (>=2.9)
+Requires-Dist: rich (>=13.0)
+Requires-Dist: ruamel.yaml (>=0.18)
+Requires-Dist: terok-sandbox (>=0.1.0,<0.2.0)
+Requires-Dist: terok-util (>=0.1.0,<0.2.0)
+Requires-Dist: tomli-w (>=1.0)
+Project-URL: Changelog, https://github.com/terok-ai/terok-executor/blob/master/CHANGELOG.md
+Project-URL: Documentation, https://terok-ai.github.io/terok-executor/
+Project-URL: Homepage, https://terok.ai/
+Project-URL: Issues, https://github.com/terok-ai/terok-executor/issues
+Project-URL: Repository, https://github.com/terok-ai/terok-executor
+Project-URL: Security, https://github.com/terok-ai/terok-executor/security/policy
+Description-Content-Type: text/markdown
+
+# terok-executor
+
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![REUSE status](https://api.reuse.software/badge/github.com/terok-ai/terok-executor)](https://api.reuse.software/info/github.com/terok-ai/terok-executor)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=terok-ai_terok-executor&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=terok-ai_terok-executor)
+
+One command to run an AI coding agent inside a hardened, rootless
+Podman container.
+
+`terok-executor` builds the container, launches the agent against
+the directory you point it at, and keeps real credentials on the
+host.  Use it on its own as a CLI, or import its `AgentRunner` from
+Python when you want library-grade control.
+
+<p align="center">
+  <img src="docs/img/architecture.svg" alt="terok ecosystem — terok-executor sits between project orchestration and the hardened runtime">
+</p>
+
+## Quick start
+
+```bash
+pip install terok-executor
+terok-executor run claude ~/my-workspace
+```
+
+The first `run` interactively offers any missing prerequisites — sandbox
+services, container images, agent credentials.
+Mandatory items (services, images) block the launch if
+declined; optional ones (SSH key, auth) print the consequence and
+proceed.
+
+Individual steps would be:
+
+```bash
+terok-executor setup                               # install sandbox services + build base images
+terok-executor auth claude                         # authenticate (OAuth or API key)
+terok-executor run claude <dir> -p "Fix the bug"   # run the agent with an initial prompt
+```
+
+## Use as a library
+
+```python
+from terok_executor import AgentRunner
+
+runner = AgentRunner()
+runner.run_headless(
+    agent="claude",
+    repo=".",
+    prompt="Fix the failing test in test_auth.py",
+    max_turns=25,
+)
+```
+
+`AgentRunner` exposes four launch methods — `run_headless`,
+`run_interactive`, `run_web`, `run_tool` — all with the same
+hardening guarantees.
+
+## Supported agents
+
+| Agent | Auth | Description |
+|-------|------|-------------|
+| Claude Code | OAuth*, API key | Anthropic Claude Code |
+| Codex | OAuth*, API key | OpenAI Codex CLI |
+| Vibe | API key | Mistral Vibe |
+| OpenCode | API key | Generic LLM endpoint driver — bundled defaults for Helmholtz Blablador, KISSKI AcademicCloud, and your own endpoint |
+| gh | OAuth, API key | GitHub CLI |
+| glab | API key | GitLab CLI |
+| CodeRabbit | API key | CodeRabbit (sidecar tool) |
+| SonarCloud | API key | SonarCloud scanner (sidecar tool) |
+
+\* Claude and Codex OAuth are experimental, and support must be explicitly allowed in the config file. 
+
+`terok-executor agents` lists the live roster (add `--all` to
+include the tool entries).
+
+## Where it sits in the stack
+
+terok-executor is the per-task layer.  Above it,
+[terok](https://github.com/terok-ai/terok) composes many concurrent
+runs across many projects.  Below it, terok-executor delegates the
+host-side security boundary
+([terok-sandbox](https://github.com/terok-ai/terok-sandbox)): the
+credential vault, the git gate, the egress firewall hooks, the
+systemd service lifecycle.
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `run` | Launch an agent (headless, interactive, or web) |
+| `setup` | Bootstrap sandbox services + container images |
+| `uninstall` | Remove sandbox services + container images |
+| `auth` | Authenticate a provider |
+| `agents` | List the agent roster |
+| `build` | Build base + agent images explicitly |
+| `run-tool` | Run a sidecar tool (CodeRabbit, SonarCloud) |
+| `list` | List running containers |
+| `stop` | Stop a running container |
+| `show-config` | Print the effective `SandboxConfig` as YAML (diffable across orchestrators) |
+| `vault` | Vault management (start, stop, status, install, routes) |
+
+### Config override
+
+Two top-level flags (precede the subcommand, like `docker --config`):
+
+- `--config PATH` — read this `config.yml` instead of the layered system/user paths (sets `TEROK_CONFIG_FILE` for the invocation).
+- `--raw` — ignore any `config.yml`; use sandbox/executor dataclass defaults only.
+
+Higher-layer orchestrators (such as `terok`) typically construct a `SandboxConfig` from their own resolution chain and pass it into the executor as a library; the public expectation is that, for the fields they own in `config.yml`, the resulting sub-environment matches what standalone `terok-executor` would produce against the same file.  Use `show-config` on both sides to verify.
+
+## Development
+
+See the [Developer Guide](https://terok-ai.github.io/terok-executor/developer/).
+
+## License
+
+[Apache-2.0](LICENSES/Apache-2.0.txt)
+

terok_executor-0.1.0/README.md

@@ -0,0 +1,117 @@
+# terok-executor
+
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![REUSE status](https://api.reuse.software/badge/github.com/terok-ai/terok-executor)](https://api.reuse.software/info/github.com/terok-ai/terok-executor)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=terok-ai_terok-executor&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=terok-ai_terok-executor)
+
+One command to run an AI coding agent inside a hardened, rootless
+Podman container.
+
+`terok-executor` builds the container, launches the agent against
+the directory you point it at, and keeps real credentials on the
+host.  Use it on its own as a CLI, or import its `AgentRunner` from
+Python when you want library-grade control.
+
+<p align="center">
+  <img src="docs/img/architecture.svg" alt="terok ecosystem — terok-executor sits between project orchestration and the hardened runtime">
+</p>
+
+## Quick start
+
+```bash
+pip install terok-executor
+terok-executor run claude ~/my-workspace
+```
+
+The first `run` interactively offers any missing prerequisites — sandbox
+services, container images, agent credentials.
+Mandatory items (services, images) block the launch if
+declined; optional ones (SSH key, auth) print the consequence and
+proceed.
+
+Individual steps would be:
+
+```bash
+terok-executor setup                               # install sandbox services + build base images
+terok-executor auth claude                         # authenticate (OAuth or API key)
+terok-executor run claude <dir> -p "Fix the bug"   # run the agent with an initial prompt
+```
+
+## Use as a library
+
+```python
+from terok_executor import AgentRunner
+
+runner = AgentRunner()
+runner.run_headless(
+    agent="claude",
+    repo=".",
+    prompt="Fix the failing test in test_auth.py",
+    max_turns=25,
+)
+```
+
+`AgentRunner` exposes four launch methods — `run_headless`,
+`run_interactive`, `run_web`, `run_tool` — all with the same
+hardening guarantees.
+
+## Supported agents
+
+| Agent | Auth | Description |
+|-------|------|-------------|
+| Claude Code | OAuth*, API key | Anthropic Claude Code |
+| Codex | OAuth*, API key | OpenAI Codex CLI |
+| Vibe | API key | Mistral Vibe |
+| OpenCode | API key | Generic LLM endpoint driver — bundled defaults for Helmholtz Blablador, KISSKI AcademicCloud, and your own endpoint |
+| gh | OAuth, API key | GitHub CLI |
+| glab | API key | GitLab CLI |
+| CodeRabbit | API key | CodeRabbit (sidecar tool) |
+| SonarCloud | API key | SonarCloud scanner (sidecar tool) |
+
+\* Claude and Codex OAuth are experimental, and support must be explicitly allowed in the config file. 
+
+`terok-executor agents` lists the live roster (add `--all` to
+include the tool entries).
+
+## Where it sits in the stack
+
+terok-executor is the per-task layer.  Above it,
+[terok](https://github.com/terok-ai/terok) composes many concurrent
+runs across many projects.  Below it, terok-executor delegates the
+host-side security boundary
+([terok-sandbox](https://github.com/terok-ai/terok-sandbox)): the
+credential vault, the git gate, the egress firewall hooks, the
+systemd service lifecycle.
+
+## Commands
+
+| Command | Description |
+|---------|-------------|
+| `run` | Launch an agent (headless, interactive, or web) |
+| `setup` | Bootstrap sandbox services + container images |
+| `uninstall` | Remove sandbox services + container images |
+| `auth` | Authenticate a provider |
+| `agents` | List the agent roster |
+| `build` | Build base + agent images explicitly |
+| `run-tool` | Run a sidecar tool (CodeRabbit, SonarCloud) |
+| `list` | List running containers |
+| `stop` | Stop a running container |
+| `show-config` | Print the effective `SandboxConfig` as YAML (diffable across orchestrators) |
+| `vault` | Vault management (start, stop, status, install, routes) |
+
+### Config override
+
+Two top-level flags (precede the subcommand, like `docker --config`):
+
+- `--config PATH` — read this `config.yml` instead of the layered system/user paths (sets `TEROK_CONFIG_FILE` for the invocation).
+- `--raw` — ignore any `config.yml`; use sandbox/executor dataclass defaults only.
+
+Higher-layer orchestrators (such as `terok`) typically construct a `SandboxConfig` from their own resolution chain and pass it into the executor as a library; the public expectation is that, for the fields they own in `config.yml`, the resulting sub-environment matches what standalone `terok-executor` would produce against the same file.  Use `show-config` on both sides to verify.
+
+## Development
+
+See the [Developer Guide](https://terok-ai.github.io/terok-executor/developer/).
+
+## License
+
+[Apache-2.0](LICENSES/Apache-2.0.txt)