LLM 実行可能インストール手順を提供する

/install.md

ファイルの標準化提案

概要

ソフトウェアのインストールは AI に任せるべきです。
人間は説明書を読む時間とコマンド実行に時間を費やしますが、エージェントは明確なタスク記述を受ければ 自律的に 手順を実行できます。

install.md

なぜ重要か
エージェントはドキュメントよりも速く成長します。プロダクトドキュメントはまだ人間向けで、インストールなどの日常作業を自動化するときに摩擦が生じます。

install.md

は、インストールを機械可読・エージェントフレンドリーなレシピへ変換することで、そのギャップを埋めます。

仕組み

1. プロジェクトのルートまたは

   /docs

   ディレクトリに

   install.md

   ファイル を追加します。
2. ユーザーはファイルを LLM に貼り付けるか、URL から直接パイプ (

   curl -fsSL https://example.com/install.md | claude

   ) で渡します。
3. LLM が手順を読み取り、OS・パッケージマネージャ等の環境を検知し、設定に合わせて実行（必要なら各ステップ前に承認要求）。
4. ファイルは人間が読めるため、実行前に何が起こるかを正確に確認できます。

例 URL:

https://<your-docs-url>/install.md

オプション上書き: Mintlify の自動生成ファイルを上書きしたい場合は独自の

install.md

を追加します。

install.md の構成

# claude-code

> Documentation and setup instructions for product-name

サンプル

install.md

# mintlify

> Documentation and setup instructions for mintlify

I want you to install Mintlify CLI for me. Execute all the steps below autonomously.

OBJECTIVE: Install the Mintlify CLI and set up a local documentation preview environment.

DONE WHEN: Local documentation server is running and accessible at http://localhost:3000.

## TODO
- [ ] Verify Node.js v20.17.0+ is installed
- [ ] Install the Mintlify CLI globally
- [ ] Create a new documentation project
- [ ] Start the local development server
- [ ] Verify the preview is accessible at localhost:3000

## Prerequisites
You need to have Node.js v20.17.0 or higher installed. Verify your Node.js version:

```bash
node --version

You must also have Git installed:

git --version

Install the CLI

You need to install the Mintlify CLI globally using npm or pnpm.

Using npm:

npm i -g mint

Using pnpm:

pnpm add -g mint

Verify the installation:

mint --version

Create a new documentation project

You must create a new documentation project using the CLI. This clones the starter kit into your specified directory:

mint new docs

The CLI will prompt you for a project name and theme. You can also specify these directly:

mint new docs --name my-project --theme linden

Navigate into your new project directory:

cd docs

Start the local preview server

You need to start the development server to preview your documentation locally:

mint dev

Your documentation preview is now available at

http://localhost:3000

If port 3000 is already in use, you can specify a custom port:

mint dev --port 3333

Alternatively, run without global installation using npx:

npx mint dev

Verify the preview

Open your browser and navigate to http://localhost:3000 to confirm the documentation site is running.

Update the CLI

If you need to update to the latest version:

mint update

Or reinstall with the latest version:

npm i -g mint@latest

Additional CLI commands

Check for broken links in your documentation:

mint broken-links

Check for accessibility issues:

mint a11y

Validate an OpenAPI specification:

mint openapi-check <openapi-file-or-url>

EXECUTE NOW: Complete the above TODO list to achieve: Local documentation server is running and accessible at http://localhost:3000.

---

## `llms.txt` との統合  

`install.md` は自然に `llms.txt` と連携します。  
`llms.txt` が LLM にソフトウェアを理解させるのに役立ち、`install.md` がインストール方法を伝えます。  
`install.md` で `llms.txt` を参照すれば、トラブルシューティングや設定詳細、必要な追加コンテキストを LLM が取得できます。

---

## 利点

| 対象 | 得られるもの |
|------|--------------|
| **開発者** | 一度インストール手順を書けば、すべての環境に適応。メインドキュメントを汚さずエッジケースをエンコード可能。ウィザード保守不要。 |
| **ユーザー** | 単一コマンドでソフトウェアをインストール、または LLM にファイルを貼り付けて実行。人間が読めるステップを事前に確認できる。 |
| **エージェント** | 予測可能な場所 (`/install.md`)。明確な成功基準付きの構造化フォーマット。モデルへのクリーンな Markdown 入力。 |

---

## オープンソース仕様

- **Spec**: `installmd.org`  
- **GitHub**: `github.com/mintlify/install-md`

実際に使っていただく中でカバーされていないケースがあれば、issue を立てるか PR を送ってください。この標準は現場のフィードバックを受けながら進化します。