next/ai-ready
中文

guides

Quickstart

Get up and running with next-ai-ready in 5 minutes.

This guide takes you from zero to a fully AI-ready Next.js site in under 5 minutes.

1. Create a project

Option A — template (fastest):

bash
npm create next-ai-ready@alpha my-site
cd my-site
pnpm install

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:

text
[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