Installation & Setup

This guide covers installation on various platforms and environments.

System Requirements

Platform-Specific Instructions

macOS

# Using Homebrew
brew install our-product

# Or using npm
npm install -g our-product

Linux

# Ubuntu/Debian
sudo apt-get install our-product

# Or using npm
npm install -g our-product

Windows

# Using Chocolatey
choco install our-product

# Or using npm
npm install -g our-product

Docker Setup

FROM node:18-alpine

WORKDIR /app

COPY package.json package-lock.json ./
RUN npm ci

COPY . .

CMD ["npm", "start"]

Verification

After installation, verify everything is working:

our-product --version
our-product doctor

You should see the version number and a health check report.

Troubleshooting

Installation fails with permission error

Try installing globally with --unsafe-perm:

npm install -g --unsafe-perm our-product

Port already in use

Change the default port:

our-product --port 3001