agent-tui: Instructions file for Codex

AGENTS.md

agent-tui AGENTS.md is an instructions file for Codex, OpenCode from pproenca/agent-tui. It costs 1,311 tokens per session, scanned A, original, MIT.

A project guide for agent-tui, a command-line tool that lets AI agents control terminal applications through managed terminal sessions. It describes the code layers, repository structure, and rules such as structured errors and dependency direction.

In plain words
What is it for?
Use it when navigating the agent-tui repository, adding features, fixing bugs, handling errors, or checking whether code follows its architecture and async rules.
Why use it?
It gives agents the boundaries and conventions needed to change the Rust project without placing code in the wrong layer or violating its safety rules.

Instructions file for CodexOpenCode

Written for Codex and OpenCode: the file is AGENTS.md. Also seen: reads .claude/ paths.

This is pproenca/agent-tui's own configuration. It tells Codex and OpenCode how to work on agent-tui itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything agent-tui configures →

Reuse

Borrowing it

Nothing to install: this file belongs to pproenca/agent-tui. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/pproenca/agent-tui/master/AGENTS.md
Clone the repo
git clone --depth 1 https://github.com/pproenca/agent-tui

Made for: Codex, OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for agent-tui AGENTS.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/pproenca/agent-tui/agents-md/github.svg)](https://agentmods.dev/instructions/pproenca/agent-tui/agents-md)
Your own site
<a href="https://agentmods.dev/instructions/pproenca/agent-tui/agents-md"><img src="https://agentmods.dev/badge/instructions/pproenca/agent-tui/agents-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for agent-tui AGENTS.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/pproenca/agent-tui/agents-md"><img src="https://agentmods.dev/badge/instructions/pproenca/agent-tui/agents-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
Per session 1,311 This file is loaded in full into every session.
When invoked 1,311 The same file — it is already loaded in full.
Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5.1 $0.01311 $0.01311
Opus 5.5 $0.00524 $0.00524
Sonnet 5.5 $0.00262 $0.00262
Haiku 4.5 $0.00131 $0.00131

Measured 2mo ago against content hash f7ae6c3f31f3, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

agent-tui AGENTS.md scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2mo ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

AGENTS.md · 100 lines

How it starts

The opening of the file, as written. The whole thing — 100 lines — stays where its author put it; the contents beside it link to each section on GitHub.

agent-tui — Agent Guide

CLI tool that enables AI agents to programmatically drive terminal applications. Manages PTY sessions via a background daemon with JSON-RPC WebSocket API and embedded web UI.

Non-Negotiable Rules

  1. Dependencies flow forward only. common → domain → usecases → adapters/infra → app → facade. No reverse imports. Validated by just boundaries and CI.
  2. No panics in production code. unwrap_used and expect_used are denied workspace-wide. Use ?, anyhow::Context, or thiserror types. Tests may unwrap.
  3. No blocking in async context. std::thread::sleep, unbounded channels, and std::process::exit (except main.rs) are banned via Clippy disallowed methods.
  4. All errors use structured types. Domain errors use thiserror; infra/app errors use anyhow with .context(). Never swallow errors silently.
  5. Facade crate is a shell. cli/crates/agent-tui/ contains only main.rs, lib.rs, and bin/*.rs. All logic lives in layer crates.

Repository Map

Path What it contains
ARCHITECTURE.md Domain boundaries, dependency graph, layer descriptions, where new code goes
docs/design-docs/ Design history, core beliefs, architectural decisions
docs/api/ OpenAPI + AsyncAPI specs, example clients (Rust, JS)
docs/ops/ Process model, deployment patterns
docs/agents/ Matt Pocock engineering workflow config: issue tracker, labels, project board, and domain docs
docs/cli/ Auto-generated CLI reference (do not hand-edit)
cli/docs/architecture/ Clean Architecture target state and dependency matrix
cli/docs/plans/ Historical refactor/restructure plans
.harness/ Machine-readable harness config (domains, principles, enforcement, quality)
skills/ Agent skill definitions and references

Tech Stack

  • Rust 1.88+ (2024 edition) — Tokio async runtime, Axum WebSocket server, Clap CLI
  • TypeScript/Bun — Web UI with xterm.js terminal emulator
  • Build: Cargo workspace (8 crates) + just task runner
  • Key deps: portable-pty, tracing, serde, crossterm

Read the full file on GitHub · 100 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2mo ago First seen · 100 lines · 1,311 tokens per session scan A f7ae6c3f31f3

Subscribe to this mod's changes

agent-tui AGENTS.md is an instructions file published in the GitHub repository pproenca/agent-tui (122 stars, last pushed 8d ago), licensed MIT. It adds 1,311 tokens to every session, about $0.0052 per session on Opus 5.5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Related

Other instructions, from other repositories

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 9,715 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,461 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,750 tokens

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 4,261 tokens