Skip to content

[codex] docs: add Codex install note#1757

Draft
ketpatil77 wants to merge 1 commit into
headroomlabs-ai:mainfrom
ketpatil77:codex/headroom-install-docs-uv-tools
Draft

[codex] docs: add Codex install note#1757
ketpatil77 wants to merge 1 commit into
headroomlabs-ai:mainfrom
ketpatil77:codex/headroom-install-docs-uv-tools

Conversation

@ketpatil77

@ketpatil77 ketpatil77 commented Jul 3, 2026

Copy link
Copy Markdown

Description

README lacked a practical note for Codex and other MCP clients that cannot reliably inherit a shell PATH. That makes command = "headroom" brittle for uv-installed setups.

Changes Made

  • Added a short Codex/global-install section to README.
  • Documented uv tool install "headroom-ai[all]" and command -v headroom.
  • Showed the absolute-path MCP config pattern.

Testing

  • Reviewed the README diff for placement and command correctness.
  • Confirmed the example path flow matches the documented uv install pattern.

Impact

Users can install Headroom once as a persistent uv tool and point Codex/MCP at a stable binary path instead of depending on ambient PATH inheritance.

@github-actions

github-actions Bot commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

PR governance

This PR does not yet satisfy the required template fields:

  • Missing required section Type of Change.
  • Missing required section Real Behavior Proof.
  • Missing required section Review Readiness.
  • Paste real command output or artifact links in TestingTest Output.

Please update the PR body, or move the PR back to draft while it is still in progress.

@github-actions github-actions Bot added the status: needs author action Pull request body or readiness checklist still needs author updates label Jul 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

status: needs author action Pull request body or readiness checklist still needs author updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant