codex-flows

Codex app-server clients, flow automation, workspace backend tools, and repo-native workspace operations.

This repository is a monorepo. The npm package users should install is @peezy.tech/codex-flows, which publishes app-server client APIs, flow runtime helpers, workspace backend helpers, the codex-flows CLI, and runnable local backend bins. Gateway packages such as Discord integrations consume this package instead of being bundled into it. The full user documentation lives in the Tome docs site under docs/pages.

Start Here

• New users: read docs/pages/index.md.
• CLI reference: docs/pages/reference/cli.md.
• Workspace autonomy: docs/pages/guides/workspace-autonomy.md.
• Memory transplant: docs/pages/guides/memory-transplant.md.
• Thread transplant: docs/pages/guides/thread-transplant.md.
• Pack repos: docs/pages/guides/install-pack-repos.md.
• Single-package platform: docs/pages/concepts/single-package-platform.md.
• Maintainers and release operators: RELEASE.md.

Repo Map

• packages/codex-client: @peezy.tech/codex-flows, the app-server client, transports, workspace backend helpers, CLI, auth helpers, workbench reducers, and generated app-server protocol types.
• packages/flow-runtime: generic FlowEvent runtime, manifest loading, local execution, backend clients, and Node or gated Code Mode step runners.
• packages/flow-backend-convex: reusable Convex component for generic flow events, runs, attempts, leases, output, and result payloads.
• apps/workspace-backend: local workspace backend process with browser/control WebSocket and optional flow HTTP routes.
• apps/discord-bridge: Discord sidecar for Codex app-server threads, workspace delegation, workbench views, and flow inspection.
• apps/workspace-voice-gateway: broadcast-only Discord voice sidecar for selected workspace backend updates via the TTS worker.
• apps/flow-runner: CLI for listing and running local flow packages.
• apps/web: browser UI that talks to the local workspace backend.
• docs: Tome documentation source.
• flows: bundled flow packages.

Common Commands

Install dependencies:

vp install

Run checks:

vp run check:types
vp run test
vp run docs:build

Run the local backend and web app:

vp run workspace:backend --local-app-server
vp run dev

Run the local voice broadcast stack:

vp run voice:up

Inspect the CLI:

tsx packages/codex-client/src/cli/index.ts --help
codex-flows fetch
codex-flows workspace doctor
codex-flows memories transplant global-to-workspace
codex-flows threads transplant <thread-id> --from-codex-home ~/.codex --to-codex-home ./.codex
codex-flows pack inspect owner/repo

Documentation Model

The root README is intentionally short. Canonical documentation belongs in the docs site:

• Tutorials teach a first successful workflow.
• Guides cover operational tasks such as workspace autonomy, memory transplant, thread transplant, pack repo install, local backend operation, Discord bridge operation, and release flow operation.
• Reference pages define CLI commands, package exports, backend APIs, FlowEvent, FLOW_RESULT, and flow.toml.
• Concepts explain boundaries between app-server clients, flow automation, workspace backends, and product-owned domain completion.

Package READMEs stay npm-focused: install, exports, minimal examples, and links back to the docs site.

Published Packages

The canonical user-facing package is:

• @peezy.tech/codex-flows

Gateway packages are published separately and depend on the core package:

• @peezy.tech/codex-discord-bridge
• @peezy.tech/codex-workspace-voice-gateway

The release train still contains compatibility/library packages while the single-package platform consolidation continues:

• @peezy.tech/flow-runtime
• @peezy.tech/flow-backend-convex

Release procedure and remote policy are in RELEASE.md. In short: jojo.build is the canonical development remote, Codeberg is a push mirror, and GitHub is used for the npm publishing workflow.