Install.md: A standard for LLM-executable installation
4 months ago
- #AI
- #automation
- #documentation
- Proposal for a standard /install.md file providing LLM-executable installation instructions.
- Background: Installing software should be automated by AI, reducing human effort and adapting to different environments.
- Current documentation is human-focused, creating friction for AI agents.
- Proposal: Developers add an install.md file with structured, LLM-executable instructions.
- Users can pipe the file directly into an LLM (e.g., Claude) for autonomous execution.
- Mintlify auto-generates install.md for hosted documentation, with options to customize or disable.
- Format includes headers, action prompts, objectives, verification criteria, and step-by-step instructions.
- Example provided for Mintlify CLI installation, including prerequisites and verification steps.
- Advantages: Adapts to any environment, human-readable, reduces maintenance, and improves agent usability.
- Security: Human-readable design allows review before execution, with optional step-by-step approval.
- Open-source spec available at installmd.org and GitHub for contributions.
- FAQ addresses concerns about security, versioning, and compatibility with existing tools.