Installation

Install as Dev Dependency

FS Guard should be installed as a development dependency since it's used for validation during development and in CI:

bash
# npm
npm install --save-dev @promise-inc/fs-guard
# yarn
yarn add --dev @promise-inc/fs-guard
# pnpm
pnpm add -D @promise-inc/fs-guard

Global Installation

You can also install FS Guard globally to use it across multiple projects:

bash
# npm
npm install -g @promise-inc/fs-guard
# Then use it in any project
fs-guard --preset react-ts

No Installation (npx)

Run FS Guard without installing using npx. This is useful for quick validation:

bash
npx @promise-inc/fs-guard --preset nestjs
For CI environments, installing as a dev dependency is recommended for faster builds and version locking.