docs: align README exec guidance with durable-by-default persistence#167
Closed
andrei-hasna wants to merge 2 commits into
Closed
docs: align README exec guidance with durable-by-default persistence#167andrei-hasna wants to merge 2 commits into
andrei-hasna wants to merge 2 commits into
Conversation
codex-rs/README.md still framed `codewith exec --ephemeral` as the generic way to run without persisting session rollout files, nudging automation authors toward lifecycle bypass. Align the exec section with docs/exec.md: headless exec persists rollout files by default, --durable/--persist state that contract explicitly, and --ephemeral is only for intentional one-off runs that should not be materialized on disk.
…cf0-c6c7b4bf9107-609f1806
Contributor
Author
|
[codewith] Worker merge check update: I refreshed this PR branch to current main via |
Contributor
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Aligns the
codewith execonboarding text incodex-rs/README.mdwith the durable persistence contract already documented indocs/exec.md.Previously
codex-rs/README.md:54read:This framed
--ephemeralas the generic programmatic exec mode, nudging automation authors toward lifecycle bypass instead of durable headless execution.The README now states the same contract as
docs/exec.md:codewith execpersists session rollout files by default so long-running automation can resume/inspect the thread later.--durable/--persiststate that contract explicitly.--ephemeralis only for intentional one-off runs that should not be materialized on disk.Scope
Docs-only. No product code changes. Single file:
codex-rs/README.md.Validation
rg -n -- "--ephemeral|--durable|--persist|persist session|persisting session" docs/exec.md codex-rs/README.md— both docs now describe the same contract.git diff --check— clean.git diff --name-status HEAD^..HEAD— onlycodex-rs/README.md.Fingerprint:
open-codewith/architecture-drift/exec-docs/headless-exec-persistence-guidance/a6ff8387f3ad5afb