Skip to content

docs: clarify uvx vs uv tool install in CLAUDE_CODE_SETUP.md#4542

Open
vibeyclaw wants to merge 1 commit into
rysweet:mainfrom
vibeyclaw:fix/clarify-uvx-install-comment
Open

docs: clarify uvx vs uv tool install in CLAUDE_CODE_SETUP.md#4542
vibeyclaw wants to merge 1 commit into
rysweet:mainfrom
vibeyclaw:fix/clarify-uvx-install-comment

Conversation

@vibeyclaw

Copy link
Copy Markdown

Fixes #4499

What changed

The # Try without installing (temporary) comment on uvx amplihack install was misleading — it implies nothing is installed, but uvx amplihack install still runs amplihack's install command and sets up agents/skills in the current project directory.

Changes

  • Rewrote the two code comments in the Permanent Setup section to clearly label each as Option 1 / Option 2 with a description of what each does
  • Added a > Note block below the code block explaining the real difference: uvx runs it without permanently adding amplihack to PATH, while uv tool install does

Before / After

Before:

# Try without installing (temporary)
uvx amplihack install

# Or install permanently
uv tool install amplihack

After:

# Option 1: Run via uvx (no permanent entry in PATH, but still installs amplihack's
# agents/skills into your project — suitable for trying it out)
uvx amplihack install

# Option 2: Install permanently (adds `amplihack` to your PATH via uv)
uv tool install amplihack

Note: uvx amplihack install does run amplihack's install command... The difference from Option 2 is that the amplihack binary itself is not added to your PATH permanently...

Fixes rysweet#4499

The 'Try without installing (temporary)' label was misleading —
 still runs amplihack's install command and
sets up agents/skills in the project. Rewrote the code block comments
to clearly explain what each option does and added a Note block
distinguishing the two approaches.
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.

docs: CLAUDE_CODE_SETUP.md "Try without installing" label misrepresents what uvx amplihack install does

1 participant