Skip to content

Docs/windows instructions#3

Open
hanley-development wants to merge 4 commits into
MacSteini:mainfrom
hanley-development:docs/windows-instructions
Open

Docs/windows instructions#3
hanley-development wants to merge 4 commits into
MacSteini:mainfrom
hanley-development:docs/windows-instructions

Conversation

@hanley-development

Copy link
Copy Markdown

Summary

  • Document Windows as a supported runtime path now that Codex home resolution is cross-platform.
  • Add PowerShell examples for running the script, local-only usage, syntax checks, and optional CODEX_HOME setup.
  • Replace hardcoded ~/.codex README assumptions with resolved <Codex home> wording for auth, local usage, troubleshooting, and privacy guidance.

Why

The code now resolves Codex data from CODEX_HOME when set, otherwise Path.home() / ".codex". The README still described macOS/Linux-only usage and literal ~/.codex assumptions, which made the workflow unclear for Windows users and custom Codex home layouts.

User Impact

  • Existing macOS/Linux users keep the same default behavior and commands.
  • Windows users get direct PowerShell commands using the Python launcher.
  • Users with custom Codex data locations know to set CODEX_HOME before running reports.

Test Plan

  • python -B -m unittest
  • python -m py_compile .\codex_usage.py
  • ruff check .\codex_usage.py .\tests
  • ruff format --check .\codex_usage.py .\tests
  • pyflakes .\codex_usage.py .\tests

@hanley-development hanley-development marked this pull request as ready for review June 23, 2026 21:27
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.

1 participant