Local control plane for orchestrating Codex agent lanes over the Codex App Server.
Project description
dispatch
Local control plane for orchestrating Codex agent lanes over the Codex App Server. One authored contract per operation, projected to CLI + MCP (+ remote later) with no drift.
Quick Start
Install the CLI from PyPI:
uv tool install outfitter-dispatch
dispatch --help
dispatchd --help
dispatch doctor
dispatch up --json
dispatch down --json
From a source checkout:
uv sync
uv run dispatch --help
uv run dispatch doctor --no-app-server
uv run dispatch models --no-refresh
uv run dispatch usage --no-refresh
uv run dispatch up --json
uv run dispatch daemon status
Create an owned managed thread, send it work, and inspect the daemon:
uv run dispatch new \
--name docs \
--cwd /path/to/dispatch \
--goal "Finish the docs review." \
--text "Please summarize the current stack state."
uv run dispatch list
uv run dispatch get <dispatch-ref>
uv run dispatch tail <dispatch-ref> --limit 20
uv run dispatch daemon log --limit 10
uv run dispatch down --json
For durable or parallel launches, point new at a launch packet directory and
preview it without side effects: dispatch new --name lane-a --cwd /repo --packet ./packet --dry-run --json, then --stage all to write durable session files under
.agents/sessions/<ref>/. See docs/usage/README.md for
packet layout, file/stdin inputs, and staging.
Use owned managed threads for turn-writing work. Existing desktop Codex threads can be attached as
managed threads, but ADR-0005 blocks turn-writing and history-mutating commands such
as send, stop, goal set, and goal clear on attached lanes by default. A
local operator can explicitly opt in with [policy] allow_attached_writes = true
in ~/.dispatch/config.toml; list --json and get --json expose
writable, capabilities, and write_locked_reason so scripts can tell which
lanes can receive writes. Every managed thread has a dispatch-local ref; full
Codex thread UUIDs remain accepted everywhere.
Titles and @handles are mutable convenience labels, not stable identity. Metadata
lifecycle actions (rename, archive, restore) can target managed refs or raw
unmanaged Codex thread ids. search uses App Server search for broad discovery, while
query uses Dispatch's local indexed managed-history substrate. Attach is metadata-only
by default; use dispatch sync <selector> when you want dispatch to refresh its local
indexed view of an attached thread. If <selector> is a raw unmanaged Codex thread id,
sync first registers it as an attached read/metadata-managed lane, then refreshes the
index. dispatch list --unmanaged --archived shows archived Codex sessions before you
decide whether to sync or restore them. Bare dispatch history reads Dispatch's local
index only; selector-scoped transcript reads through tail, history, or
transcript-inclusive get use App Server thread/read(includeTurns:true) as the
canonical source and backfill Dispatch's normalized local history index for that one
thread.
Interactive App Server requests use dispatch request list and one generic
dispatch request respond <id> '<json>' path. Owned threads default to durable
attention; attached/unmanaged requests default to deny. dispatch schema "request respond" exposes the same response contract projected into grouped MCP tools.
History capture is configurable in ~/.dispatch/config.toml. The default
standard mode captures operational facts and bounded searchable history
metadata while keeping raw provider payloads gated. Live App Server events are
stored as compact summaries; transcript reads index bounded turns, item text,
tool names, and file/thread refs without retaining raw item payloads unless the
retention policy allows it. Minimal capture keeps turn-level state but skips
item-level transcript rows. Bare history overview is a local indexed summary.
Normal selector-scoped history item/tool/file views render from the normalized
index after refreshing one thread from the App Server, while history --raw
remains a live raw-payload inspection path. Use debug only for development
with bounded temp state; debug retention can store bounded raw provider event
and item payloads with truncation markers for reducer/search diagnosis:
[history]
capture = "standard" # minimal | standard | debug
raw_payload_retention = "debug" # off | errors | debug | all
max_text_bytes = 8192
max_payload_bytes = 65536
dispatch doctor reports the active capture mode and warns when debug/raw
retention is enabled.
new reports whether the first message was accepted by the App Server, not whether
assistant work completed. Use get to inspect the latest turn state and persisted
App Server errors, or watch for a bounded live event sample. Slash commands in
--text are plain text; use --goal when creating a native App Server goal.
Use dispatch models before pinning model or service-tier presets; Dispatch
resolves aliases such as fast from the live App Server model catalog, accepts
model-defined reasoning efforts, reports input/personality capabilities, and
keeps omitted model/tier values on Codex defaults.
For the operator guide, CLI/MCP examples, triggers, and plugin setup, start at
docs/usage/README.md.
Start troubleshooting with dispatch doctor. It checks PATH visibility, the Codex CLI
and auth footprint, daemon socket/pidfile state, registry schema/integrity, packaged
skills/plugin assets, and a low-risk Codex App Server initialize smoke. If doctor reports
an old registry schema, stop the daemon and run dispatch registry migrate before
starting it again.
Agent And Plugin Support
This repo ships first-party skills in skills/:
skills/dispatch/SKILL.mdteaches agents how to operate dispatch safely.skills/dm/SKILL.mdis the dispatch-backed "dispatch message" workflow for short inter-lane messages.
The workspace-local Codex plugin bundle lives at plugins/dispatch/,
with a marketplace entry in .agents/plugins/marketplace.json.
Restart Codex if the plugin does not appear immediately.
Project Docs
docs/development/design.md- architecture and design notes.docs/adrs/- accepted architecture decisions.docs/research/- verified Codex App Server findings..agents/plans/v0/RETRO.md- v0 execution ledger and verification record.
For contributors, AGENTS.md is the canonical fieldguide.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file outfitter_dispatch-0.8.2.tar.gz.
File metadata
- Download URL: outfitter_dispatch-0.8.2.tar.gz
- Upload date:
- Size: 327.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
92094fef79c256d06955e862d5cd9194dfdff58f53d355611422524e5fa83108
|
|
| MD5 |
483631e5f97302c7546ef0041335c1be
|
|
| BLAKE2b-256 |
106a5c054085f64ec2299f5105093a37e499605f6c02ea24a644dac1ad3f58c1
|
Provenance
The following attestation bundles were made for outfitter_dispatch-0.8.2.tar.gz:
Publisher:
publish.yml on outfitter-dev/dispatch
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
outfitter_dispatch-0.8.2.tar.gz -
Subject digest:
92094fef79c256d06955e862d5cd9194dfdff58f53d355611422524e5fa83108 - Sigstore transparency entry: 2143293394
- Sigstore integration time:
-
Permalink:
outfitter-dev/dispatch@70407aa5e1bdf0c99f8f657beb62337448f7f8e8 -
Branch / Tag:
refs/tags/v0.8.2 - Owner: https://github.com/outfitter-dev
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@70407aa5e1bdf0c99f8f657beb62337448f7f8e8 -
Trigger Event:
release
-
Statement type:
File details
Details for the file outfitter_dispatch-0.8.2-py3-none-any.whl.
File metadata
- Download URL: outfitter_dispatch-0.8.2-py3-none-any.whl
- Upload date:
- Size: 216.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
12b27de1b75f7274f65f51bb61be87795e665d1070981d7899e92cff28759af3
|
|
| MD5 |
2b776d6ea942fa35d1fe3bc65b64a37a
|
|
| BLAKE2b-256 |
b4302b377788d7d73fb50cc36791de17885f3b55b5ce12ad7b6763e5aef4400c
|
Provenance
The following attestation bundles were made for outfitter_dispatch-0.8.2-py3-none-any.whl:
Publisher:
publish.yml on outfitter-dev/dispatch
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
outfitter_dispatch-0.8.2-py3-none-any.whl -
Subject digest:
12b27de1b75f7274f65f51bb61be87795e665d1070981d7899e92cff28759af3 - Sigstore transparency entry: 2143293405
- Sigstore integration time:
-
Permalink:
outfitter-dev/dispatch@70407aa5e1bdf0c99f8f657beb62337448f7f8e8 -
Branch / Tag:
refs/tags/v0.8.2 - Owner: https://github.com/outfitter-dev
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@70407aa5e1bdf0c99f8f657beb62337448f7f8e8 -
Trigger Event:
release
-
Statement type: