---
title: "Scaffolder options"
description: "Every prompt and flag of create-nimbus-docs, and what it writes."
---

> Documentation Index
> Fetch the complete documentation index at: https://nimbus-docs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Scaffolder options

`create-nimbus-docs` sets up a project with layouts, components, content schemas, search, a sitemap, share cards, and a Markdown version of every page. For a guided first run, follow the [Quickstart](/quickstart); this page lists every option.

## Requirements

- **Node** 22.12 or later
- **A package manager** — npm, pnpm, yarn, or bun
- **Git** — for last-updated dates, which come from commit history

## Scaffold

```sh
npm create @cloudflare/nimbus-docs@latest
yarn create @cloudflare/nimbus-docs
pnpm create @cloudflare/nimbus-docs@latest
bun create @cloudflare/nimbus-docs@latest
```

The scaffolder asks:

1. **Directory**

   Where to create the project; press Enter for `my-docs`. Pass it as the first argument, such as `my-docs`, or `.` for the current folder. The folder must be new, empty, or hold only `.git`, such as a freshly cloned repository.
2. **What the site includes**

   **Docs**, hand-written pages (the default); **Docs and an API reference**, with the docs at `/` and the reference, generated from an OpenAPI spec, at `/api`; or **API reference**, a site that is only the reference, at `/`. Flags: `--api` adds the reference, `--template api` makes it the whole site.
3. **OpenAPI spec**

   Asked when the site has an API reference: the path to your OpenAPI 3.x spec (`.yaml`, `.yml` or `.json`), or Enter for a sample to replace later. Flag: `--api <path>`.
4. **Starter content**

   **Getting started guide + example pages**, or **Empty**, just the shell for your own content. A site that is only an API reference skips it and refuses the flag. Flag: `--content starter|empty`.
5. **Package manager**

   npm, pnpm, yarn, or bun; the default is the one that runs the scaffolder. It installs dependencies with your choice unless you pass `--skip-install`. Flag: `--package-manager <pm>`.
6. **Git**

   Whether to initialize a repository and make a first commit. Inside an existing repository it does neither. Flag: `--git` or `--no-git`.
7. **Output mode**

   **Static** prerenders every content collection route and deploys anywhere. **Server** renders docs pages on request. You can override individual collections later. Flag: `--deploy` chooses static, `--adapter` chooses server.
8. **Deploy target or adapter**

   Static output asks for a deploy target: Cloudflare or another static host (flag: `--deploy cloudflare|other`). Server output offers Cloudflare; the `--adapter` flag also accepts `vercel`, `netlify`, and `node`.

Pass `--yes` to accept every default, or `--help` to list every flag.

Without a terminal, such as in CI or an agent, pass `--yes` or a flag for every question; otherwise the scaffolder exits and lists the flags it still needs. Unknown or conflicting flags stop it before it writes anything.

If installing dependencies fails, the scaffolder keeps the project, prints the commands that finish the setup, and exits with status 1. To scaffold from a local folder instead of downloading the template, such as when working on templates offline, pass `--template-dir <path>`.

With npm, put `--` before the arguments, or npm keeps the flags for itself:

```sh
npm create @cloudflare/nimbus-docs@latest -- my-docs --yes
npm create @cloudflare/nimbus-docs@latest -- my-docs --api ./openapi.yaml   # docs + API reference
npm create @cloudflare/nimbus-docs@latest -- my-docs --template api         # only an API reference
```

Put the directory before `--api`: a value after the flag is read as the spec.


## What lands in your repo

See [Project structure](/project-structure) for every file the scaffolder writes and what each one is for.

To run, build and publish the site, see the [Quickstart](/quickstart) and [Deployment](/deploy/cloudflare).

Source: https://nimbus-docs.com/reference/scaffolder-options/index.mdx