corral AGENTS.md

Documentation guidance for Corral, a command-line tool that transfers and resumes terminal sessions across coding agents such as Claude Code, Codex, Cursor, and others.

In plain words
What is it for?
Use it when changing, reviewing, releasing, or diagnosing Corral’s command-line, session-management, interface, or documentation components.
Why use it?
It directs agents to the right component documentation for development and troubleshooting, including session lists, split screens, releases, and platform behavior.

Instructions file for CodexOpenCode

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add instructions/x0c/corral/agents-md
Clone the repo
git clone --depth 1 https://github.com/x0c/corral

Made for: Codex, OpenCode.

Per session 16,616 This file is loaded in full into every session.
When invoked 16,616 The same file — it is already loaded in full.
Security scan B 1 finding. Scan, not verified.
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 $0.16616 $0.16616
Opus 5 $0.08308 $0.08308
Sonnet 5 $0.03323 $0.03323
Haiku 4.5 $0.01662 $0.01662

Measured 2d ago against content hash bbba9d7cc428, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade B, and why

corral AGENTS.md scanned grade B with 1 finding 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 2d 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.

Asks for rootmediumPrivilege escalation

A mod that escalates privileges can change anything on the machine, not only the project.

- **「默认跳过全部权限问询」是本项目的既定产品默认,不是待讨论选项**(机主 2026-08-01 明确拍板)。凡是 corral 拉起运行时的路径——原生恢复、跨运行时接力、空白新建、直启透传,以及未来的命令拦截/shim 入口——都必须自动垫上该运行时的放行参数,让用户拿到的是开箱免打断的体验。新增运行时时,找出并验证它的放行参数属于接入工作的必做项,不是可选增强;找不到就在维护指南里如实记录能力差距,而不是默默留空。放行参数在
AGENTS.md · 246 lines

How it starts

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

Corral

终端会话接力 CLI,支持跨 Claude Code / Codex / OpenCode / Kimi Code / Cursor / Pi 会话恢复与接力。

通用工程规范:Python 规范

文档导航

以下文档在涉及对应领域的开发、评审或排查时先读取。领域知识库与验证细则见组件内说明。

  • cli/AGENTS.md:改、评审或发布 Corral CLI 工具前必读(含领域知识库、截图验收,以及**排查「GitHub 持续发单测失败邮件 / 流水线作业排队十几小时 / macOS 作业挂死」「敲原命令没进托管」「启动 Pi 出现 No project session found with id」「新开 Pi 会话切走后消失 / 标题和 prompt 历史挂到另一空 Pi 分屏 / /resume 看不到其它会话」「看不到历史 Pi 会话 / 只能看到最近的 Pi / 旧 Pi 会话搬家之后去哪了 / 搬家挡发版」「钉过的 Pi 不在 pinned / 不筛项目名就不在置顶区、一筛又出现」「刚在分屏里开的两个会话自己拆开 / 变成两张独立卡」「分屏两格画面一模一样 / 两个会话内容相同」「分屏两格但每格画面只占一半 / 像被压成 1/4」「活跃会话看不到翻页 / Mac 没有 PageUp PageDown」「Cursor 画面疯狂抽动 / 宽度抖动 / 有的会话抖有的不抖」「本机与开发机版本对不上」「助手还在跑、侧栏却显示已结束」「Cursor 会话不见了 / 刚开的会话从列表消失」「Cursor 子代理还在跑、主会话却显示已结束」「还能执行 pickup / 敲 corral command not found / 新名无法启动」「Ctrl+R 后卡住 / 强停打出 Python 堆栈 / 退出后鼠标一点就出现 ^[[<」「英文会话却出中文标题 / 标题跟界面语言走」「自身 CPU 占用过高 / 风扇狂转 / 两个窗口特别吃 CPU」「Cursor 进程过多 / 活动监视器一堆 agent」「ci-test 跑很久像卡住 / 发版检查跑三遍 / 不要每次都跑这么重」**的入口)。**有人提议做 Windows / WSL 兼容时进 cli/docs/design/WINDOWS_COMPATIBILITY_DESIGN.md(2026-08-27 已裁定不做)。用 Corral 导出的会话数据写周报 / 日报 / 工作总结,或排查「导出内容不够写总结」时,从这里进 cli/docs/SKILL.md 的「拿会话数据做总结 / 周报时的边界」节。 Remote:ssh://[email protected]:2222/Max/corral.git
  • ios/AGENTS.md:改、评审、构建或真机验收手机客户端前必读(含签名推送、钥匙串共享、禁止 resize、模拟器/真机脚本)。用户可见改动完成后必须立刻装到 iPhone Max,不读会只改源码让真机继续跑旧过滤/旧界面。界面视觉、两端状态色、会话展示字号与**助手官方标识(禁止自绘)**见 ios/docs/UI_DESIGN_KNOWLEDGE_BASE.md排查「两台开发机点进去会话一模一样 / 打开会话后闪退」进 iOS 故障排查索引。 Remote:ssh://[email protected]:2222/Max/corral-ios.git
  • cli/docs/REMOTE_KNOWLEDGE_BASE.md:改、评审或排查手机 ↔ 开发机远程接力协议、配对、推送密文、画面差分、审查手机互联网连接 / 中继 / 配对安全线、换网连不上 / 中继开关与默认地址、任意网络可达策略、corral remote start 一直不退出、会话列表或打开历史极慢 / 进列表仍先转圈 / 转圈后开发机响应超时、打开大历史第一次仍像卡死 / 详情把通道堵住、Cursor 用户气泡出现整段系统上下文、Codex 详情第一句是系统说明、Pi 会话在手机上是空聊天、两台开发机点进去会话一模一样、发了消息对话不更新 / 看不到助手回复 / This session is no longer in the list / 对话在刷但选择题还卡在底上 / 两道题合成一排选项前必读(验收必须走中继上的整表订阅+每个助手一条详情,禁止用 5 条摘要、单条 Codex 或本机 unittest 冒充)。个人中继部署拓扑见 agentsync 基础设施知识库 corral-relay.caozc.top 节(覆盖安装后服务起不来 / 刚换程序公网通道掉线也进该节)。审查「中继会不会偷看 / 扫码等不等于把电脑交出去 / 合盖后别人占了公网通道」进该文「安全边界」。
  • cli/docs/design/MOBILE_REMOTE_DATA_PLANE_DESIGN.md:规划、设计、评审或排查手机会话列表/历史加载慢、进列表仍先转圈、不要堆滚动分页进详情后返回没反应、实时数据被大历史拖住、打开大历史第一次解析整份 JSONL、Cursor 上下文泄漏、Codex 消息缺失、Pi 手机聊天空白发了消息对话不更新 / 会话已不在列表里对话在刷但选择题还卡在底上 / 两道题合成一排选项、直连/中继切换与断线恢复前必读。不读会把压缩或超时当成完整方案,漏掉缓存分页、尾部偏移读取、控制/数据隔离、序号恢复和真实设备验收。
  • cli/docs/design/PI_SESSION_IDENTITY_EXTENSION_DESIGN.md:设计、开发、评审或排查 Pi / Codex 托管会话身份、pane 错绑、claim 协议、插件自动安装、旧隔离目录迁移前必读。不读会继续沿用已废弃的每会话小房间、让子代理抢主画面、破坏 Pi 原生恢复列表,或在身份不确定时误绑会话。

Read the full file on GitHub · 246 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. 2d ago First seen · 246 lines · 16,616 tokens per session scan B bbba9d7cc428

Subscribe to this mod's changes

corral AGENTS.md is an instructions file published in the GitHub repository x0c/corral (2 stars, last pushed 2d ago), licensed MIT. It adds 16,616 tokens to every session, about $0.0831 per session on Opus 5. A static security scan graded it B with 1 finding (asks for root). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.