Skip to content

[config-dir-clarify] docs(readme): fix config dir to ~/.code; clarify ~/.codex precedence#182

Closed
just-every-code wants to merge 1 commit into
mainfrom
issue-181
Closed

[config-dir-clarify] docs(readme): fix config dir to ~/.code; clarify ~/.codex precedence#182
just-every-code wants to merge 1 commit into
mainfrom
issue-181

Conversation

@just-every-code

Copy link
Copy Markdown

Fixes #181

This PR corrects misleading configuration directory references in the README and clarifies precedence between legacy and fork paths.

What changed

  • Replace ~/.coder with ~/.code in two spots:
    • Backwards-compat note now reads: "Supports ~/.codex/* (if present) or defaults to ~/.code/*".
    • Auth storage path now references ~/.code/auth.json (still reads legacy ~/.codex/auth.json).

Why

  • The code resolves the config home via CODE_HOME/CODEX_HOME, then falls back to:
    • ~/.codex if it exists (backward compatibility), otherwise
    • ~/.code (fork default).
  • README incorrectly mentioned ~/.coder, which is unrelated to config resolution.

References

  • Implementation: codex-rs/core/src/config.rs (find_codex_home) uses ~/.codex if present, else ~/.code.

Validation

  • Ran ./build-fast.sh from repo root; build completed successfully with no warnings or errors.

Impact

  • Documentation now matches actual behavior; users won’t be misled about where configuration and auth are stored.

Auto-generated for issue #181 by a workflow.
Author: @github-actions[bot]

@github-actions

Copy link
Copy Markdown

Preview Build

You can run this right now! In your terminal just use:

code preview config-dir-clarify

This will run the version of Code we've created for this issue.

Direct downloads:

After you run it, please comment here and let me know if it does what you need.

@ntoxeg

ntoxeg commented Sep 17, 2025

Copy link
Copy Markdown

Still doesn't clarify what happens when both of ~/.code and ~/.codex are present, are configurations merged together? Which one wins conflicts?

@zemaj zemaj closed this Sep 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Misleading configuration directories

3 participants