> ## Documentation Index
> Fetch the complete documentation index at: https://nickmintlifycom.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Format specification

> The install.md file format and structure

## Overview

The `install.md` file uses standard Markdown with a specific required structure. Place it at `/install.md` in the root of your project's web presence.

install.md files are **task assignments for autonomous execution**, not simply  passive documentation. Every element of the format serves to trigger immediate action from AI agents.

## Required Structure

A well-formed install.md file contains these sections **in order**:

### 1. Title (H1)

The name of the software as a lowercase, hyphenated identifier:

```markdown theme={null}
# firecrawl
```

```markdown theme={null}
# claude-code
```

```markdown theme={null}
# trigger-dev
```

### 2. Summary (Blockquote)

A brief description of what the software does:

```markdown theme={null}
> Documentation and setup instructions for firecrawl
```

### 3. Conversational Opening

This signals to the AI agent that this is a direct user request to execute immediately:

```markdown theme={null}
I want you to install Firecrawl for me. Execute all the steps below autonomously.
```

The conversational tone ("I want you to...") bypasses paste protection and frames the content as a command rather than documentation.

### 4. OBJECTIVE

A concise statement of what needs to be accomplished:

```markdown theme={null}
OBJECTIVE: Install the Firecrawl SDK and verify it works by scraping a webpage.
```

### 5. DONE WHEN

A specific, measurable success condition. The agent knows it has succeeded when this state is achieved:

```markdown theme={null}
DONE WHEN: You have successfully scraped a URL and received markdown content back from the Firecrawl API.
```

Make this concrete and verifiable:

* "server running at localhost:3000" (not "server is working")
* "test email sent and ID received" (not "email functionality works")
* "CLI returns version number" (not "CLI is installed")

### 6. TODO Section

A checklist of 3-7 high-level tasks using markdown checkboxes:

```markdown theme={null}
## TODO

- [ ] Install the Firecrawl SDK (Python or Node)
- [ ] Set up the API key as an environment variable
- [ ] Create a test script that scrapes a webpage
- [ ] Run the script and verify markdown output is returned
```

This gives the agent a ready-made task list to execute against and helps users track progress.

### 7. Detailed Steps

Sequential instructions with explicit commands. Use task language throughout:

````markdown theme={null}
## Installation

You need to install the Firecrawl SDK. Choose Python or Node based on your project:

**Python:**
```bash
pip install firecrawl-py
```

**Node:**
```bash
npm install @mendable/firecrawl-js
```

## API Key Setup

You must set your Firecrawl API key as an environment variable:

**On macOS/Linux:**
```bash
export FIRECRAWL_API_KEY="fc-YOUR-API-KEY"
```

**On Windows:**
```powershell
$env:FIRECRAWL_API_KEY="fc-YOUR-API-KEY"
```
````

### 8. EXECUTE NOW Closing

A directive that triggers immediate action:

```markdown theme={null}
EXECUTE NOW: Complete the above TODO list to achieve: Successfully scraped a URL and received markdown content back from the Firecrawl API.
```

### 9. Separator and llms.txt Reference

End with a horizontal rule followed by an optional reference to your llms.txt file for additional context:

```markdown theme={null}
---

> If you think the above is not enough to accomplish the task, you can find navigation and other pages relevant to this product by using the llms.txt file at: https://docs.firecrawl.dev/llms.txt
```

This allows the agent to fetch more context if the install.md alone isn't sufficient for troubleshooting or configuration.

## Task Language

Use imperative task language throughout your install.md:

| Use this | Not this |
| - | - |
| "You need to install..." | "You can install..." |
| "You must set..." | "Setting the variable..." |
| "Your task is to create..." | "Create a file..." |

Every section should read as an instruction to execute, not information to consider.

## Include Explicit Commands

Include all shell commands needed for the core workflow. Group platform-specific commands clearly:

**On macOS/Linux:**

```bash theme={null}
export API_KEY="your-key"
```

**On Windows:**

```powershell theme={null}
$env:API_KEY="your-key"
```

The AI agent adapts to the environment but needs actual commands to execute.

## What to Include

* All shell commands needed for the core workflow
* Installation commands for all relevant platforms/package managers
* URLs for downloads and package managers
* Verification commands (--version, health checks, etc.)
* Commands to create and run a minimal working example
* Prerequisites that must be met

## What to Omit

* Troubleshooting sections
* Optional/advanced features (save for after verification)
* GUI-only steps (unless absolutely required before any local functionality)
* IDE/editor configurations
* Alternative installation methods (pick the most reliable one)
* Lengthy explanations (show commands, not concepts)

## Target Length

Aim for 400-800 words. Long enough to include all necessary commands, short enough to stay focused on the core workflow.

## Versioning

If your installation differs significantly across versions, you can host version-specific files:

```
/install.md          # Current/latest version
/v2/install.md       # Version 2 specific
/v1/install.md       # Legacy version
```

Alternatively, include version detection logic in the instructions themselves.

## Format at a Glance

````markdown theme={null}
# product-name

> Documentation and setup instructions for product-name

I want you to install [Product] for me. Execute all the steps below autonomously.

OBJECTIVE: [Concise goal statement]

DONE WHEN: [Specific measurable outcome]

## TODO

- [ ] [Task 1]
- [ ] [Task 2]
- [ ] [Task 3]

## [Step heading]

You need to [task description]:

```bash
[command]
```

## [Step heading]

You must [task description]:

```bash
[command]
```

EXECUTE NOW: Complete the above TODO list to achieve: [restate DONE WHEN]

---

> If you think the above is not enough to accomplish the task, you can find navigation and other pages relevant to this product by using the llms.txt file at: [your-llms-txt-url]
````

## Next steps

> **[See examples](https://nickmintlifycom.mintlify.site/essentials/examples.md)**
>
> Browse real-world install.md files from Trigger.dev, Browserbase, and Resend.