tmux-orche 0.3.5

Typer-based CLI for tmux-backed Codex orchestration sessions

中文 · Install Guide

tmux-orche

tmux-backed Codex orchestration for OpenClaw fire-and-forget workflows.

tmux-orche lets OpenClaw hand work to Codex, return immediately, and continue later through the same persistent tmux session. That keeps OpenClaw from burning tokens while Codex works in the background.

OpenClaw Workflow

1. OpenClaw creates or reuses a Codex session with orche session-new.
2. OpenClaw sends the task with orche send.
3. orche returns immediately.
4. Codex keeps running in tmux.
5. When notify arrives, OpenClaw or another agent inspects the same session with status, read, or history.
6. The session stays available until it is explicitly closed.

Quick Start

Create or reuse a session:

orche session-new \
  --cwd /path/to/repo \
  --agent codex \
  --name repo-codex-main \
  --discord-channel-id 123456789012345678

Send work and return immediately:

orche send --session repo-codex-main "analyze the failing tests and propose a fix"

Inspect the same session later:

orche status --session repo-codex-main
orche read --session repo-codex-main --lines 120
orche history --session repo-codex-main --limit 20

Close it when done:

orche close --session repo-codex-main

Installation

Full step-by-step install guide: https://github.com/parkgogogo/tmux-orche/raw/main/install.md

Install from PyPI:

pip install tmux-orche

Install with uv:

uv tool install tmux-orche

Install from source:

git clone https://github.com/parkgogogo/orche
cd orche
python3 -m venv .venv
source .venv/bin/activate
pip install -U pip
pip install .

Commands

• orche session-new --cwd /repo --agent codex --name repo-codex-main --discord-channel-id 123456789012345678 Create or reuse a persistent Codex tmux session.
• orche send --session repo-codex-main "review the recent auth changes" Send a task into an existing session and return immediately.
• orche status --session repo-codex-main Check whether the session and Codex process are still running.
• orche read --session repo-codex-main --lines 80 Read recent terminal output from the live session.
• orche type --session repo-codex-main --text "yes" Type text into the live Codex session without pressing Enter.
• orche keys --session repo-codex-main --key Enter Send one or more key presses to the live Codex session.
• orche history --session repo-codex-main --limit 20 Show recent local control actions for that session.
• orche sessions list Show stored sessions from local metadata.
• orche sessions clearall Close and remove all stored sessions.
• orche close --session repo-codex-main Close the session when the work is finished.
• orche config list Show current runtime configuration.

Interactive Input

Use type and keys when Codex is waiting on an interactive prompt inside the tmux session.

Read the latest output first:

orche read --session repo-codex-main --lines 40

Type text without submitting it:

orche type --session repo-codex-main --text "yes"

Then send Enter:

orche keys --session repo-codex-main --key Enter

This is useful for prompts such as trust confirmations, shell confirmations, or any other step where Codex is paused waiting for input.

You can also send multiple keys in one command:

orche keys --session repo-codex-main --key Down --key Down --key Enter

Config

Manage runtime settings:

orche config list
orche config get discord.channel-id
orche config set discord.channel-id 123456789012345678
orche config set discord.bot-token "$BOT_TOKEN"
orche config set discord.mention-user-id 123456789012345678
orche config set notify.enabled true

Config file:

~/.config/orche/config.json

State directory:

~/.local/share/orche/

Troubleshooting

Cancel a stuck turn

If Codex is stuck, running in the wrong direction, or needs to be stopped without losing the session:

orche cancel --session repo-codex-main

This interrupts the current Codex turn but keeps the session alive, allowing you to read output and send a corrected task.

Compare with close:

• cancel: Interrupt current turn, keep session (for stuck or still-running tasks)
• close: End entire session (for completed or abandoned tasks)

Prerequisites

• tmux
• tmux-bridge
• codex CLI
• Python 3.9+

License

MIT