Installation

Requirements

• Node.js 18+ or Bun 1.0+
• A Git repository

npx / bunx (no install)

Run PropWatch without installing anything:

npx propwatch --base origin/main
# or
bunx propwatch --base origin/main

Global install

npm install -g propwatch
# or
bun install -g propwatch

Then:

propwatch --base origin/main

Project dependency

Install as a dev dependency to pin a version and run via package scripts:

npm install --save-dev propwatch

{
  "scripts": {
    "check:ids": "propwatch --base origin/main"
  }
}

Docker

docker run --rm -v $(pwd):/workspace steve228uk/propwatch:latest \
  --base origin/main

CI/CD

For CI-specific setup see the CI/CD guides.

Platform	Method
GitHub Actions	Official action — no install needed
Bitbucket Pipelines	bunx propwatch or Docker image
GitLab CI	Docker image or npx
CircleCI	Docker image or npx
Azure DevOps	npx or Docker image
Jenkins	Docker image or npx
Buildkite	npx or Docker image

Verify

propwatch --version