Skip to main content

Sandboxing for AI coding agents, built on Podman.

Project description

terok

terok

PyPI License: Apache-2.0 REUSE status Quality Gate Status

[!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.

terok ecosystem at a glance

Acknowledgements

CASUS
HZDR
Terok was started at the
Center for Advanced Systems Understanding (CASUS), an institute of
Helmholtz-Zentrum Dresden-Rossendorf (HZDR) at the end of 2025.

See also
Terok at HELMHOLTZ.software and the
topic page at the
Scientific Computing Core (SCC) group of CASUS.

What you get

Hardening

  • Rootless Podman — no daemon, no privileged user namespace
  • Default-deny egress firewall — via 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 six-package stack

Package Role
terok (this repo) Project orchestration, TUI, sickbay
terok-executor Per-task agent runner, image factory, auth flows
terok-sandbox Hardened Podman runtime, credential vault, git gate
terok-shield nftables egress firewall + audit
terok-clearance Live allow/deny prompts via D-Bus + varlink
terok-util Shared foundations: CLI registry types, XDG paths, config stack

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 — enables the systemd-creds vault passphrase tier (TPM2-sealed on systemd ≥ 257); the gate / vault / clearance services themselves run per container, no systemd units
  • dnsmasq and dig — DNS plumbing the egress firewall uses
  • A desktop notification daemon — for the Allow / Deny popups path

Installation

pipx install terok

One-time setup

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:

terok uninstall                         # reverse of setup; preserves credential DB

First project

Launch the TUI:

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:

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.

Headless agent runs (unattended)

# 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

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 for details.

Configuration

Global Config

Location: ~/.config/terok/config.yml

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:

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 for the full mechanics.

Contributing

See the Developer Guide.

License

See LICENSE file.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

terok-0.8.3.tar.gz (446.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

terok-0.8.3-py3-none-any.whl (477.9 kB view details)

Uploaded Python 3

File details

Details for the file terok-0.8.3.tar.gz.

File metadata

  • Download URL: terok-0.8.3.tar.gz
  • Upload date:
  • Size: 446.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for terok-0.8.3.tar.gz
Algorithm Hash digest
SHA256 4efa3d69384d1150709bb8259447dd6dbac9d90fca8f2000263d2c8fe71041a2
MD5 36f348c28eb2691579bf14291bdf4703
BLAKE2b-256 c6abf009590186804e8979b9086a0d6b751ef44c6fe36622f2f51cf9f06c5fa9

See more details on using hashes here.

Provenance

The following attestation bundles were made for terok-0.8.3.tar.gz:

Publisher: release.yml on terok-ai/terok

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file terok-0.8.3-py3-none-any.whl.

File metadata

  • Download URL: terok-0.8.3-py3-none-any.whl
  • Upload date:
  • Size: 477.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for terok-0.8.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b4aaafa107e865561d0b76e36243916cb349c99ead2bede6f00c10badd69d1e1
MD5 7997c558a8b161c4994457cc9ea430b0
BLAKE2b-256 7da67505b9f3dbd1b4167c2957e4ec8e193e4eb15bb87f724babf427efb48d78

See more details on using hashes here.

Provenance

The following attestation bundles were made for terok-0.8.3-py3-none-any.whl:

Publisher: release.yml on terok-ai/terok

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page