10 Commits

• Prefer just test over cargo test in docs (#23910)

  `cargo test` for the core and other crates fails on a fresh macOS
  checkout without the right stack size variable. This change encourages
  using the just test command that sets the environment up correctly.
  
  As a bonus, this should encourage agents to get more benefit out of
  nextest's parallel execution.

  anp-oai · 2026-05-22 16:58:14 +00:00
  d53e68954a
• Ensure all mentions of cargo-install are --locked (#21592)

  There's already a preference for this in the codebase, but a few of them
  have drifted away. Generally `--locked` is preferred to reduce exposure
  to supply-chain attacks (and just generally improve reproducibility).
  
  In an ideal world these dependencies would maybe even be pinned to
  versions but Cargo is kinda bad at that for devtools. Still better to
  use --locked than not.

  Aria Desires · 2026-05-07 15:30:37 -07:00
  80a8563e48
• feat: discourage the use of the --all-features flag (#12429)

  ## Why
  
  Developers are frequently running low on disk space, and routine use of
  `--all-features` contributes to larger Cargo build caches in `target/`
  by compiling additional feature combinations.
  
  This change updates local workflow guidance to avoid `--all-features` by
  default and reserve it for cases where full feature coverage is
  specifically needed.
  
  ## What Changed
  
  - Updated `AGENTS.md` guidance for `codex-rs` to recommend `cargo test`
  / `just test` for full-suite local runs, and to call out the disk-usage
  cost of routine `--all-features` usage.
  - Updated the root `justfile` so `just fix` and `just clippy` no longer
  pass `--all-features` by default.
  - Updated `docs/install.md` to explicitly describe `cargo test
  --all-features` as an optional heavier-weight run (more build time and
  `target/` disk usage).
  
  ## Verification
  
  - Confirmed the `justfile` parses and the recipes list successfully with
  `just --list`.

  Michael Bolin · 2026-02-20 23:02:24 -08:00
  264fc444b6
• docs: use --locked when installing cargo-nextest (#12377)

  ## What
  
  Updates the optional `cargo-nextest` install command in
  `docs/install.md`:
  
  - `cargo install cargo-nextest` -> `cargo install --locked
  cargo-nextest`
  
  ## Why
  
  The current docs command can fail during source install because recent
  `cargo-nextest` releases intentionally require `--locked`.
  
  Repro (macOS, but likely not platform-specific):
  - `cargo install cargo-nextest`
  - Fails with a compile error from `locked-tripwire` indicating:
    - `Nextest does not support being installed without --locked`
    - suggests `cargo install --locked cargo-nextest`
  
  Using the locked command succeeds:
  - `cargo install --locked cargo-nextest`
  
  ## How
  
  Single-line docs change in `docs/install.md` to match current
  `cargo-nextest` install requirements.
  
  ## Validation
  
  - Reproduced failure locally using a temporary `CARGO_HOME` directory
  (clean Cargo home)
  - Example command used: `CARGO_HOME=/tmp/cargo-home-test cargo install
  cargo-nextest`
  - Confirmed success with `cargo install --locked cargo-nextest`

  derekf-oai · 2026-02-20 14:12:13 -08:00
  9176f09cb8
• feat(core): add configurable log_dir (#10678)

  Adds a top-level `log_dir` config key (defaults to `$CODEX_HOME/log`) so
  one-off runs can redirect `codex-tui.log` via `-c`, e.g.:
  
    codex -c log_dir=./.codex-log
  
  Also resolves relative paths in CLI `-c/--config` overrides for
  `AbsolutePathBuf` values against the effective cwd (when available).
  
  Tests:
  - cargo test -p codex-core

  Josh McKinney · 2026-02-05 01:23:30 +00:00
  cddfd1e675
• chore: update outdated docs (#8701)
  Thibault Sottiaux · 2026-01-03 02:19:52 -08:00
  ee9d441777
• Replaced user documentation with links to developers docs site (#8662)

  This eliminates redundant user documentation and allows us to focus our
  documentation investments.
  
  I left tombstone files for most of the existing ".md" docs files to
  avoid broken links. These now contain brief links to the developers docs
  site.

  Eric Traut · 2026-01-02 13:01:53 -07:00
  ab753387cc
• docs: point dev checks to just (#7673)

  Update install and contributing guides to use the root justfile helpers
  (`just fmt`, `just fix -p <crate>`, and targeted tests) instead of the
  older cargo fmt/clippy/test instructions that have been in place since
  459363e17b. This matches the justfile relocation to the repo root in
  952d6c946 and the current lint/test workflow for CI (see
  `.github/workflows/rust-ci.yml`).

  Victor · 2025-12-06 18:57:08 -08:00
  b2cb05d562
• chore: subject docs/*.md to Prettier checks (#4645)

  Apparently we were not running our `pnpm run prettier` check in CI, so
  many files that were covered by the existing Prettier check were not
  well-formatted.
  
  This updates CI and formats the files.

  Michael Bolin · 2025-10-03 11:35:48 -07:00
  c32e9cfe86
• README / docs refactor (#2724)

  This PR cleans up the monolithic README by breaking it into a set
  navigable pages under docs/ (install, getting started, configuration,
  authentication, sandboxing and approvals, platform details, FAQ, ZDR,
  contributing, license). The top‑level README is now more concise and
  intuitive, (with corrected screenshots).
  
  It also consolidates overlapping content from codex-rs/README.md into
  the top‑level docs and updates links accordingly. The codex-rs README
  remains in place for now as a pointer and for continuity.
  
  Finally, added an extensive config reference table at the bottom of
  docs/config.md.
  
  ---------
  
  Co-authored-by: easong-openai <easong@openai.com>

  Reuben Narad · 2025-08-27 10:30:39 -07:00
  459363e17b