Anydocs Documents
Quick Start

Installation

Follow the shortest path to verify the environment, validate the CLI, initialize a project, and preview it.

Anydocs CLI and MCP are already published to npm. For most users, the goal of installation is not to set up a full development environment, but to quickly confirm the CLI works, create a project, and see the first preview.

Install CLI

  1. Check the Environment
  2. Verify the CLI
  3. Create a Docs Project
  4. Start a Local Preview

Check the Environment

You only need Node.js 18 or later. pnpm becomes important mainly when you are developing Anydocs itself from source, not for normal CLI usage.

node --version

Verify the CLI

Run the published CLI directly through `npx` and confirm the command executes successfully.

npx @anydocs/cli version

Install MCP (AI Assistants)

If you want Claude Code, Codex, or other AI assistants to help with documentation authoring, you need to install the Anydocs MCP server first. Installing it globally means you can use it in any project directory.

codex mcp add anydocs -- npx -y @anydocs/mcp
claude mcp add -s user anydocs -- npx -y @anydocs/mcp

To scope it to the current project only, replace `-s user` with `-s local` in the Claude Code command.

Verify the Installation

After installation, list the registered MCP servers to confirm the status.

codex mcp list
claude mcp list

Create a Docs Project

Generate a local docs project first. If you have already installed the MCP server, you can open the project directory with Claude Code or Codex to let the assistant initialize it; or use the CLI to initialize the project first.

npx @anydocs/cli init ./my-docs-project
npx @anydocs/cli init ./my-docs-project --agent claude-code

Start a Local Preview

Run preview to inspect the published page flow in the default language. If your page is still a draft, it will not appear in the reader preview.

npx @anydocs/cli preview ./my-docs-project
Choose the Next Path: If you want to write manually, continue to First Documentation Project. If you want AI-assisted authoring, continue to the Claude Code or Codex integration pages.