This repository was archived by the owner on Sep 1, 2026. It is now read-only.
Repository navigation
v1.0.0
SwiftASB v1.0.0 is the first stable Swift-native public API for the core Codex app-server lifecycle.
Public Surface
CodexAppServeris the root owner for starting/stopping the local Codex
app-server subprocess, initializing the session, starting/resuming/forking
threads, paging stored threads and turns, listing models, listing MCP server
statuses, and reading passive diagnostics.CodexThreadis the conversation-scoped owner for starting turns, observing
thread events, naming threads, updating thread metadata, compacting context,
rolling back trailing turns, reading local history windows, and creating
SwiftUI-friendly observable companions.CodexTurnHandleis the active-turn owner for observing turn events,
answering approval and elicitation requests, steering text, interrupting
work, reading the minimap, and completing into a sealed turn snapshot.- SwiftUI companion surfaces are stable for v1:
Dashboard,Minimap,
RecentTurns,RecentFiles, andRecentCommands. - Public diagnostics cover runtime warnings, guardian warnings, model reroutes,
and model-verification events through hand-owned Swift values.
Intentionally Internal Surfaces
- Generated
CodexWire...models remain internal scaffolding and are not part
of the public Swift API. - Broader app-server families remain post-v1 until their consumer workflows are
clearer, including guardian denied-action approval, marketplace/account
management, remote-control status, thread goals, realtime, fuzzy file search,
hook mutation, external-agent config import, richer MCP progress, and
structured patch previews. - A one-shot
run(...)convenience API is intentionally deferred until the
lower-level lifecycle has more production mileage.
Compatibility Window
- The first v1 compatibility promise is intentionally narrow: reviewed support
for Codex CLI0.128.x. - SwiftASB discovers
codexfrom an explicit executable URL,PATH, common
Homebrew locations, or the npm global prefix, and exposes startup diagnostics
throughcliExecutableDiagnostics(). - Future Codex CLI schema dumps must be classified before generated shapes are
promoted to public or observable behavior.
Migration Notes
- Existing
v0.9.xconsumers should update the SwiftPM dependency to
from: "1.0.0"once the tag is published. - The v1 API surface has removed stale pre-v1 compatibility shims and phantom
fields that no longer exist in the reviewedv0.128.0schema. - Same-thread overlapping turns are rejected client-side with
CodexAppServerError.invalidState; use separate threads for concurrent
turns. - Prompt-driven approval behavior remains runtime-dependent. Deterministic
approval regression coverage uses the real app-server with a local mock
Responses provider.
Validation Performed
swift buildswift testbash scripts/repo-maintenance/validate-all.shgit diff --checkxcodebuild docbuild -scheme SwiftASB -destination generic/platform=macOS -derivedDataPath tmp/xcode-docc/DerivedDatascripts/run-live-codex-approval-probe.shscripts/run-live-codex-file-scenario.shscripts/run-live-codex-rollback-scenario.sh
Known Post-V1 Work
- Confirm Swift Package Index listing and DocC rendering after the public tag is
indexed. - Promote
hooks/listas a near-term diagnostics/capability surface. - Add broader live server-request coverage for permissions and MCP elicitation
if those become stronger public runtime guarantees. - Continue tuning recent companion cache calibration, richer file previews,
archive-aware retention, and rollback forensic archival.