---
title: "Quick Start"
description: "Getting started with Fumadocs is simple using the interactive command-line application initialization tool. The generator guides you through setting up a brand-new documentation site from scratch, ..."
last_updated: "2026-10-12T07:55:48.67087+00:00"
canonical_url: "https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/guide/getting-started/quick-start"
---

## Overview

### Introduction

Getting started with Fumadocs is simple using the interactive command-line application initialization tool. The generator guides you through setting up a brand-new documentation site from scratch, allowing you to choose your preferred framework, template, search solution, linter, and package manager.

> [!NOTE]
> Make sure your environment has Node.js installed (version 18.17.0 or higher is required) before running the setup commands.

---

### Generating a New Project

To create a new Fumadocs application from scratch, run the setup tool via your package manager without installing it permanently:

```bash
npx create-fumadocs-app@latest
```

During the interactive setup process, you will be prompted to answer several configuration choices:

1. **Project name**: Enter a name for your project directory (defaults to `my-app`).
2. **Template**: Choose the base framework and structure for your documentation site.
3. **`src/` directory**: (Next.js templates only) Choose whether to place your application code inside a `src/` directory.
4. **Linter**: Choose a linter or formatter tool to keep your codebase clean.
5. **Search solution**: Select how users will search through your documentation content.
6. **Open Graph Image generation**: Choose the tool used to automatically generate social share preview images.
7. **AI Chat**: Choose whether to integrate an AI-powered assistant into your documentation pages.
8. **Package manager installation**: Choose whether to automatically install dependencies using your detected package manager.

---

### Available Configuration Options

### CLI Flags and Supported Values

#### Templates

Supported templates: `+next+fuma-docs-mdx`, `waku`, `react-router`, `react-router-spa`, `tanstack-start`, `tanstack-start-spa`, `+next+fuma-docs-mdx+static`

#### Linters

Supported linters: `eslint`, `oxlint`, `biome`

#### Search Solutions

Supported search solutions: `orama`, `orama-cloud`

#### Open Graph Image Generators

Supported OG image options: `next-og`, `takumi`

#### AI Chat Providers

Supported AI chat providers: `openrouter`, `llmgateway`, `inkeep`

#### Package Managers

Supported package managers: `npm`, `pnpm`, `yarn`, `bun`

---

### Workflow Overview

### Setup Lifecycle

The setup process follows a straightforward interactive lifecycle:

```mermaid
flowchart TD
    A[Run CLI command] --> B[Enter project name]
    B --> C[Select template & framework]
    C --> D[Configure features & search]
    D --> E[Install dependencies]
    E --> F[Initialize Git repository]
    F --> G[Project ready!]
```

> [!TIP]
> If you prefer to bypass all interactive prompts entirely, you can supply arguments and options directly in your terminal, such as providing a project name as the first argument:
> 
> ```bash
> npx create-fumadocs-app@latest my-docs --template +next+fuma-docs-mdx --install --no-git
> ```

## Related

- [Framework Setup](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/guide/getting-started/framework-setup)
- [Content Authoring](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/guide/core-features/content-authoring)


## Sitemap

See the full [sitemap](https://www.doc0.dev/docs/e8872a72-1909-479c-b585-dc74c6e26726/llms.txt) for all pages in this wiki.