terok 0.8.0__tar.gz

terok-0.8.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-0.8.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-0.8.0/PKG-INFO

@@ -0,0 +1,265 @@
+Metadata-Version: 2.4
+Name: terok
+Version: 0.8.0
+Summary: Sandboxing for AI coding agents, built on Podman.
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: LICENSES/Apache-2.0.txt
+Keywords: podman,containers,tasks,developer-tools,cli
+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 :: Security
+Classifier: Topic :: System :: Systems Administration
+Classifier: Typing :: Typed
+Requires-Dist: argcomplete (>=3.1)
+Requires-Dist: jinja2 (>=3.1)
+Requires-Dist: platformdirs (>=4.5.1)
+Requires-Dist: pydantic (>=2.6)
+Requires-Dist: requests (>=2.31)
+Requires-Dist: rich (>=13.0)
+Requires-Dist: ruamel.yaml (>=0.18)
+Requires-Dist: terok-clearance (>=0.7.0,<0.8.0)
+Requires-Dist: terok-executor (>=0.1.0,<0.2.0)
+Requires-Dist: terok-sandbox (>=0.1.0,<0.2.0)
+Requires-Dist: terok-shield (>=0.7.0,<0.8.0)
+Requires-Dist: terok-util (>=0.1.0,<0.2.0)
+Requires-Dist: textual-serve (>=1.1.0)
+Requires-Dist: textual[syntax] (==8.2.5)
+Requires-Dist: unique-namer (>=1.3)
+Project-URL: Changelog, https://github.com/terok-ai/terok/blob/master/CHANGELOG.md
+Project-URL: Documentation, https://terok-ai.github.io/terok/
+Project-URL: Homepage, https://terok.ai/
+Project-URL: Issues, https://github.com/terok-ai/terok/issues
+Project-URL: Repository, https://github.com/terok-ai/terok
+Project-URL: Security, https://github.com/terok-ai/terok/security/policy
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://terok-ai.github.io/terok/terok-logo-w.svg">
+    <img src="https://terok-ai.github.io/terok/terok-logo-b.svg" alt="terok" width="120">
+  </picture>
+</p>
+
+# terok
+
+[![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)](https://api.reuse.software/info/github.com/terok-ai/terok)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=terok-ai_terok&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=terok-ai_terok)
+
+> [!WARNING]
+> Terok is in **alpha** development phase. It is under active development and until version
+> 1.0.0 is released, APIs, internals, and security boundaries may change
+> without deprecation notice. Not recommended for production deployment.
+
+An open, Podman-native runtime for sandboxing AI coding agents in YOLO mode.
+
+Terok runs each agent task inside a hardened, rootless container with
+default-deny outbound networking, a credential vault that keeps real
+keys on the host, a per-task git checkpoint, and a desktop
+notification path for live allow/deny decisions.  It ships a CLI
+and a Textual TUI on top of a stack of independently-released
+Python packages.
+
+<p align="center">
+  <img src="docs/img/architecture.svg" alt="terok ecosystem at a glance">
+</p>
+
+## What you get
+
+### Hardening
+
+- **Rootless Podman** — no daemon, no privileged user namespace
+- **Default-deny egress firewall** — via [terok-shield](https://github.com/terok-ai/terok-shield)
+- **Credential vault** — secrets stay on the host
+- **Per-task git gate** — a git mirror that the agent pushes through;
+  a human-review point before changes leave your machine
+- **Live Allow / Deny prompts** — desktop notifications on blocked outbound traffic
+
+### Features
+
+- **Projects ⊃ Tasks** — long-lived project config, ephemeral task
+  containers; many tasks per project.
+- **Headless / interactive / web interface** — pick the launch mode
+  per task; same agents, same hardening.
+- **Layered images** — base distro · agent CLIs · per-project
+  snippet, cached and reused across projects; Ubuntu / Debian /
+  Fedora / nvidia/cuda out of the box, GPU passthrough for projects
+  whose base image supports it.
+- **Multi-vendor agents** — Claude Code, Codex, Copilot, Vibe, plus
+  custom LLM endpoints via OpenCode.
+
+## The five-package stack
+
+| Package | Role |
+|---------|------|
+| **terok** (this repo) | Project orchestration, TUI, sickbay |
+| [terok-executor](https://github.com/terok-ai/terok-executor) | Per-task agent runner, image factory, auth flows |
+| [terok-sandbox](https://github.com/terok-ai/terok-sandbox) | Hardened Podman runtime, credential vault, git gate |
+| [terok-shield](https://github.com/terok-ai/terok-shield) | nftables egress firewall + audit |
+| [terok-clearance](https://github.com/terok-ai/terok-clearance) | Live allow/deny prompts via D-Bus + varlink |
+
+## Quick Start
+
+### Prerequisites
+
+Hard dependencies:
+
+- **Podman** (rootless)
+- **`nft`** (nftables CLI)
+- **Python 3.12+**
+- **OpenSSH client** — for private git repos
+
+Optional but recommended:
+
+- **systemd** user session — runs the gate / vault / clearance daemons
+- **`dnsmasq`** and **`dig`** — DNS plumbing the egress firewall uses
+- A desktop **notification daemon** — for the Allow / Deny popups path
+
+### Installation
+
+```bash
+pipx install terok
+```
+
+### One-time setup
+
+```bash
+terok setup                             # idempotent; safe to re-run after upgrades
+```
+
+`setup` installs the shield OCI hooks, the XDG desktop entry for the TUI, and shell
+completions for your detected shell.
+
+To remove everything later:
+
+```bash
+terok uninstall                         # reverse of setup; preserves credential DB
+```
+
+### First project
+
+Launch the TUI:
+
+```bash
+terok                                   # bare `terok` runs the TUI
+```
+
+- Press **n** to run the project wizard (creates config, builds images, sets up SSH + gate)
+- Select your new project, press **a** to authenticate your agent
+- **Tab** to the task list, press **c** to start a CLI task
+
+Or do the same from the command line:
+
+```bash
+terok auth claude                       # authenticate host-wide
+terok auth                              # interactive menu — pick multiple providers
+terok project wizard                    # interactive project setup
+terok task run myproj                   # create a CLI task and attach (default on TTY)
+terok task run myproj --mode toad       # web interface (browser access)
+terok login myproj t3x                  # re-attach later by task ID prefix
+```
+
+For manual project configuration or CI, see the [User Guide](docs/usage.md).
+
+### Headless agent runs (autopilot)
+
+```bash
+# Run an agent headlessly with a prompt (uses default_agent config; falls back to claude)
+terok task run myproj "Fix the authentication bug"
+
+# With model override and timeout
+terok task run myproj "Add tests" --model opus --timeout 3600
+
+# Use a specific provider
+terok task run myproj "Fix the bug" --provider codex
+```
+
+### Common Commands
+
+```bash
+terok project list                      # List projects
+terok config paths                      # Show resolved paths and config
+terok task list <project>               # List tasks
+terok task delete <project> <task_id>   # Delete a task
+terok login <project> <id_prefix>       # Attach to running task
+terok project init <project>            # Full setup: ssh + generate + build + gate
+terok project wizard                    # Interactive project creation
+terok image usage                       # Disk usage across projects and images
+terok sickbay                           # In-container health checks
+terok panic                             # Emergency kill-switch
+terok image list [project]              # List terok images
+terok image cleanup [--dry-run]         # Remove orphaned images
+terok completions install               # Re-install shell completions
+```
+
+## Notes
+
+- **SELinux hosts**: install the policy module before `terok setup`,
+  otherwise the shield + clearance services bind sockets as
+  `unconfined_t` and podman will refuse to talk to them.  The exact
+  install command (a `sudo bash` over the script terok-sandbox
+  ships) is printed by `terok setup` when the policy is missing —
+  run it once, then re-run `terok setup`.
+- **AppArmor hosts**: install the policy otherwise the shield's dnsmasq won't 
+  be able to read its confguration.  The exact install command (a `sudo bash` over 
+  the script terok-sandbox ships) is printed by `terok setup` when the policy is 
+  missing — run it once, then re-run `terok setup`.
+- **Clipboard**: If mouse selection doesn't copy to your clipboard,
+  hold **Shift** while selecting, then **Shift+Ctrl+C** to copy.
+  See [Tips](docs/usage.md#tips) for details.
+
+## Configuration
+
+### Global Config
+
+Location: `~/.config/terok/config.yml`
+
+```yaml
+git:
+  human_name: "Your Name"
+  human_email: "your@email.com"
+
+image:
+  agents: "all"   # default roster selection for every project
+```
+
+If `git.human_name` and `git.human_email` are omitted, terok falls
+through to your host `git config`.  Setting them in `config.yml` is
+the way to override the host-level identity for container commits.
+
+To see what you can pick from for `image.agents`:
+
+```bash
+terok agents                            # list available AI coding agents
+```
+
+Officially-tested base images for `image.base_image`: `ubuntu:24.04`,
+`fedora:44`, `quay.io/podman/stable`, `nvcr.io/nvidia/nvhpc`.  Other
+images in the same family (`ubuntu:*`, `debian:*`, `fedora:*`,
+`nvcr.io/nvidia/*`, `quay.io/podman/*`) work via auto-detection;
+anything else needs an explicit `image.family: deb|rpm` override.
+See [docs/usage.md](docs/usage.md#choosing-which-agents-to-bake-in)
+for the full mechanics.
+
+## Contributing
+
+See the [Developer Guide](docs/developer.md).
+
+## License
+
+See [LICENSE](LICENSE) file.
+