Skip to content

docs: align README exec guidance with durable-by-default persistence #167

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
andrei-hasna wants to merge 2 commits into from
Closed

docs: align README exec guidance with durable-by-default persistence #167

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
278cbcc
docs: align README exec guidance with durable-by-default persistence
andrei-hasna Jul 6, 2026
1d7523c
Merge branch 'main' into openloops/open-codewith/9b038ca7-a443-4750-8…
andrei-hasna Jul 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion codex-rs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ You can enable notifications by configuring a script that is run whenever the ag
### `codewith exec` to run Codewith programmatically/non-interactively

To run Codewith non-interactively, run `codewith exec PROMPT` (you can also pass the prompt via `stdin`) and Codewith will work on your task until it decides that it is done and exits. If you provide both a prompt argument and piped stdin, Codewith appends stdin as a `<stdin>` block after the prompt so patterns like `echo "my output" | codewith exec "Summarize this concisely"` work naturally. Output is printed to the terminal directly. You can set the `RUST_LOG` environment variable to see more about what's going on.
Use `codewith exec --ephemeral ...` to run without persisting session rollout files to disk.
Headless `codewith exec` runs persist session rollout files by default so long-running automation can resume or inspect the thread later. Use `--durable` or `--persist` when a workflow needs to state that contract explicitly, and use `codewith exec --ephemeral ...` only for intentional one-off runs that should not be materialized on disk.

### Compact output defaults

Expand Down
Loading