In this page, you can find all the commands available in Doccupine CLI.
Create a new directory for your project and navigate to it in your terminal. Run the following command to create a new Doccupine project:
npx doccupineOnce you run the command, Doccupine will ask you to select a directory to store your MDX files. Choose the directory where you want to create your documentation files. After selecting the directory, Doccupine will ask you to enter the name of the directory for the generated website. Enter the name of the directory where you want to create your website.
This will start the development server on port 3000. Open your browser and navigate to http://localhost:3000 to view your documentation.
| Flag | Description |
|---|---|
--port <port> | Port for the dev server (default: 3000). Auto-increments if taken. |
--verbose | Show all Next.js output including compilation details. |
--reset | Re-prompt for watch/output directories. |
npx doccupine --verboseThis will show Next.js output in the terminal, providing detailed logs useful for debugging during development.
npx doccupine buildThis scaffolds the Next.js app from your MDX files without starting the development server. To produce a production build, run npm install && npm run build in the generated output directory.
npx doccupine config --showThis will show the current configuration for Doccupine.
npx doccupine config --resetThis will reset the current configuration for Doccupine.