Getting Started
Core Features
How-To Guides
Integrations
Troubleshooting
This page covers common issues and questions you may encounter while using the Fumadocs CLI. Whether you are setting up your project, adding components, or exporting files, use this guide to troubleshoot standard behaviors.
When you run the command to initialize your project, the tool creates a configuration file in your directory. If you try to run the initialization command again in a folder that already contains this file, the system will prevent you from overwriting it.
Note
If you need to change your settings, you can manually edit your configuration file instead of running the initialization command again.
The CLI allows you to export your documentation to EPUB format. To ensure this works correctly, follow these requirements:
--framework flag. Supported options include next, tanstack-start, react-router, and waku.Warning
If you omit the --framework flag, the export process will fail because it cannot determine how to correctly package your documentation.
When using the add command to bring new components into your project, or the customise command to adjust layouts, the CLI connects to a registry to fetch files. If you run into issues, consider the following:
--dir path.:preview or :dev if you are testing your own components against local instances or preview environments.You can visualize and generate a structured hierarchy of your files. The CLI converts your folder structure into a format suitable for your documentation site (either as JavaScript/TypeScript or MDX).
.js, .tsx, .jsx).--no-root flag.Tip
If you are not sure if your input is valid JSON, just pass the directory path (e.g., ./) to the command, and it will automatically read the folder structure for you.
Important
Always ensure your environment is set up correctly by running commands from your project's root folder to avoid path-related errors.