install.md Generator
Create LLM-executable installation instructions
What is install.md?
The install.md standard provides LLM-executable installation instructions. Unlike traditional docs written for humans, install.md is designed for AI agents to autonomously install your software.
Usage
Users can pipe your install.md directly to an AI agent:
curl -fsSL https://yourdocs.com/install.md | claude
Generate from any GitHub repository
Supports: github.com/owner/repo, owner/repo, or full GitHub URLs
Enter a GitHub repository URL to analyze and generate install.md
We'll extract README, package.json, workflows, and releases
Format Reference
Required Elements
- •
H1- Product name (lowercase-hyphenated) - •
OBJECTIVE:- Installation goal - •
DONE WHEN:- Success criteria - •
## TODO- Checkbox list - •
EXECUTE NOW:- Final call-to-action
Optional Elements
- •
>- Blockquote description - • Step sections with code blocks
- • Multiple package manager options
- • Platform-specific instructions
- • Link to llms.txt for troubleshooting