Installation

Dev Reel can be installed globally or used directly via npx. We recommend using npx to always ensure the latest version.

Via npx (recommended)

Use directly without installation. Ideal for CI/CD and occasional use:

bash

npx @promise-inc/dev-reel build

Install globally if you use Dev Reel frequently across multiple projects:

bash

npm install -g @promise-inc/dev-reel

With yarn:

bash

yarn global add @promise-inc/dev-reel

With pnpm:

bash

pnpm add -g @promise-inc/dev-reel

Then use directly:

bash

dev-reel build

Add to your project to ensure consistent version between contributors:

bash

npm install --save-dev @promise-inc/dev-reel

With yarn:

bash

yarn add -D @promise-inc/dev-reel

With pnpm:

bash

pnpm add -D @promise-inc/dev-reel

Add a script to package.json:

json

{
  "scripts": {
    "build:reels": "dev-reel build",
    "dev:reels": "dev-reel build --watch"
  }
}

Check if installation was successful:

bash

dev-reel --version

Or with npx:

bash

npx @promise-inc/dev-reel --version

Dev Reel requires Node.js 16.0.0 or higher. Check your version with 'node --version'.

Now that Dev Reel is installed, check out the Quick Start to create your first animated preview.