Skip to content

Add LLM agent installation instructions#17895

Draft
dirien wants to merge 2 commits intomasterfrom
dirien/llm-agent-install-docs
Draft

Add LLM agent installation instructions#17895
dirien wants to merge 2 commits intomasterfrom
dirien/llm-agent-install-docs

Conversation

@dirien
Copy link
Copy Markdown
Contributor

@dirien dirien commented Mar 10, 2026

Summary

Adds a dedicated "For LLM agents" section to the download/install page, inspired by oh-my-openagent's installation guide. This section provides structured, step-by-step instructions that AI coding agents (Claude Code, Cursor, Copilot, Windsurf, Codex, Gemini CLI, etc.) can follow when helping users install and configure Pulumi.

Changes

  • Added new "For LLM agents" section between "Verify installation" and "Enhance your AI coding assistant with agent skills"
  • 6 sequential steps: check existing install, detect OS and install, verify PATH, authenticate, create project, install agent skills
  • Agent guidelines covering safe defaults (no unsolicited profile modifications, prefer package managers, check before installing)
  • Info callout directing human readers to skip the section

Test plan

  • Verify page renders correctly with make serve
  • Confirm Hugo shortcodes (notes) render properly
  • Check all internal links resolve (#enhance-your-ai-coding-assistant-with-agent-skills, /docs/install/versions/, etc.)

Add a dedicated "For LLM agents" section with step-by-step instructions
that AI coding agents can follow when helping users install and configure
Pulumi. Includes detection, OS-specific install commands, verification,
authentication, project creation, and agent skills installation.
@claude
Copy link
Copy Markdown
Contributor

claude bot commented Mar 10, 2026

Docs Review — PR #17895

Overall this is a well-structured addition. The step-by-step format is clear and the content is accurate. A few issues to address:

Issues

  1. Inconsistent Claude Code command (line 584): The new section uses claude plugin add pulumi/agent-skills, but the existing "Enhance your AI coding assistant with agent skills" section directly below (line 607) uses claude plugin marketplace add pulumi/agent-skills. These should match. Based on the existing content, the correct command appears to be:

    claude plugin marketplace add pulumi/agent-skills
    
  2. H2 heading case (line 495): Per STYLE-GUIDE.md, H2+ headings should use sentence case. "For LLM agents" is already sentence case, so this is fine — but the H3 subheadings like "Step 1: Check for an existing installation" mix numbering with headings. Consider whether the numbered-step pattern is the best approach here, since the style guide recommends using ordered lists (1.) for steps. The current heading-per-step approach is reasonable for LLM parsing, so this is a minor style note rather than a blocker.

  3. Heading case nit (line 544): "Step 3: Verify the installation and configure PATH" — "PATH" is fine as all-caps since it's a technical term, just confirming this is intentional.

  4. Missing period (line 501): "When a user asks you to help with Pulumi, follow these steps in order" — should end with a period for consistency:

    When a user asks you to help with Pulumi, follow these steps in order.
    

    Edit: On re-reading the diff, this line does already end with a period. Disregard this item.

  5. npx skills command (line 588): npx skills add pulumi/agent-skills --skill '*' — verify this is the current correct invocation. The existing "Universal installation" section below uses npx @anthropic-ai/agent-skills or similar. Make sure the command here matches the canonical form documented in the existing section.

Suggestions

  • Consider linking "Pulumi Cloud" in Step 4 (line 560) to the Pulumi Cloud docs on first mention, per style guide convention of linking product names.
  • Step 5 template list (line 577): This is a long inline list. Consider formatting as a bullet list or a short table for better readability, especially for LLM agents parsing the content.

What looks good

  • The {{% notes "info" %}} callout telling human readers to skip is a nice UX touch.
  • Internal anchor links (#enhance-your-ai-coding-assistant-with-agent-skills, #installing-betas-and-previous-versions) resolve correctly.
  • The /docs/install/versions/ link resolves via alias.
  • Agent guidelines section is clear and promotes safe defaults.
  • No spelling or grammar issues found.
  • No file moves, so no alias concerns.

Mention me (@claude) if you'd like additional reviews or help with fixes.

Rename heading from "For LLM agents" to "For AI coding assistants"
and move the section higher on the page so AI coding assistants
find it earlier when reading the page via RAG or llms.txt.
@pulumi pulumi deleted a comment from pulumi-bot Mar 10, 2026
@pulumi-bot
Copy link
Copy Markdown
Collaborator


{{% /chooser %}}

## For AI coding assistants
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## For AI coding assistants
## AI agent installation guide

@dirien dirien marked this pull request as draft March 10, 2026 22:45
@dirien
Copy link
Copy Markdown
Contributor Author

dirien commented Mar 10, 2026

@CamSoper FYI and followup from our slack chat.

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.

4 participants