Installation

Global install

Install Contractual globally to run contractual from any terminal. This is the fastest way to get started.

npm

npm install -g @contractual/cli

pnpm

pnpm add -g @contractual/cli

yarn

yarn global add @contractual/cli

bun

bun add -g @contractual/cli

Project install (recommended for teams)

Install as a dev dependency so every contributor uses the same version. Add contractual to package.json scripts or run it via the package manager exec command.

npm

npm install --save-dev @contractual/cli

pnpm

pnpm add -D @contractual/cli

yarn

yarn add --dev @contractual/cli

bun

bun add -d @contractual/cli

When installed locally, run commands with the package manager exec:

npm

npx contractual breaking

pnpm

pnpm contractual breaking

yarn

yarn contractual breaking

bun

bunx contractual breaking

Verify the installation

contractual --version

Expected output:

contractual/0.1.0 darwin-arm64 node-v22.0.0

If the command is not found after a global install, make sure the package manager global bin directory is on PATH. Running npm config get prefix (or the equivalent for the package manager) shows where global binaries are installed.

Requirements

• Node.js 18 or later
• Git (required for snapshot diffing)

Next: Quickstart Zero to first working contractual breaking in 5 minutes.