---
title: Quickstart
description: Complete a verified next-ai-ready setup in about 10 minutes.
canonical_url: https://next-ai-ready.vercel.app/en/docs/guides/quickstart
url: https://next-ai-ready.vercel.app/en/docs/guides/quickstart
last_updated: 2026-08-02
updated: 2026-08-02
author: next-ai-ready team
summary: Complete a verified next-ai-ready setup in about 10 minutes.
topics: [quickstart, tutorial, getting-started]
---

# Quickstart

This guide takes you from zero to a verified AI-readable Next.js setup in about 10 minutes.

## 1. Create a project

**Option A — template (fastest):**

```bash
npm create next-ai-ready my-site
cd my-site
npm install
npx next-ai-ready init
```

The scaffold supplies a runnable minimal App Router TypeScript app and starter MDX content. It does not pre-generate AI-ready config or handlers; the explicit `init` step adds that wiring after installation.

**Option B — existing Next.js app:**

```bash
npx create-next-app@latest my-site --typescript --app --tailwind
cd my-site
pnpm add next-ai-ready zod@^4
npx next-ai-ready init
```

## 2. Add content

Create an MDX page with semantic metadata:

```markdown
---
title: Getting Started
summary: Learn how to use our product.
---

# Getting Started

Welcome to our product. Here's how to get started.
```

## 3. Build

```bash
npx next-ai-ready build
```

You should see output like:

```
[next-ai-ready] scanning content
[next-ai-ready] compiling 1 files
[next-ai-ready] loading actions from ./actions/index.mjs
[next-ai-ready] compiled 1 actions
[next-ai-ready] wrote 8 files
[next-ai-ready] build complete — 1 routes, 1 actions, 8 files written
```

## 4. Verify

```bash
npx next-ai-ready doctor --score
```

Aim for 90+. The CLI prints **Top fixes** for any remaining warnings. Then start your dev server and visit:

- `http://localhost:3000/_ai-ready/llms-txt` — your llms.txt
- `http://localhost:3000/_ai-ready/openapi` — your OpenAPI spec
- `http://localhost:3000/_ai-ready/tools` — your tools manifest

## Next steps

- Read about the [Knowledge Plane](/docs/concepts/knowledge-plane) to understand content compilation
- Read about the [Capability Plane](/docs/concepts/capability-plane) to define custom actions
- Check the [API Reference](/docs/api-reference/config) for full configuration options
