Skip to main content

Installation

This guide will walk you through the process of installing Prodcat.

Prerequisites​

Before you can install Prodcat, you need to have the following software installed on your system:

  • Node.js: Prodcat requires a recent version of Node.js. We recommend using the latest LTS version. You can check your Node.js version by running node -v in your terminal.
note

If you don't have Node.js installed, you can download it from the official website. We recommend using a version manager like nvm to manage multiple Node.js versions on your system.

  • Docusaurus Project: Prodcat is designed to work with a Docusaurus project. If you don't have one set up, please follow the Docusaurus installation guide.

Installation Methods​

There are two ways to install Prodcat:

tip

Using npx is the recommended approach because it ensures you are always using the latest version of Prodcat without having to manage global dependencies.

The recommended way to use Prodcat is with npx, which allows you to run the CLI without installing it globally.

npx prodcat init my-prodcat-site

Global installation with npm​

You can also install Prodcat globally using npm.

npm install -g prodcat

This will make the prodcat command available in your terminal.