Skip to content

Installation

@masumdev/tscheck can be installed globally as a command-line tool or locally inside your TypeScript project or monorepo.


Global Installation (CLI)

Install @masumdev/tscheck globally to audit any project from your terminal:

Terminal window
bun add -g @masumdev/tscheck

After installing globally, run:

Terminal window
tscheck --help

Local Project Installation

To use tscheck in your project scripts and CI pipelines:

Terminal window
bun add -D @masumdev/tscheck

Adding to package.json

{
"scripts": {
"audit": "tscheck",
"audit:ci": "tscheck --fail-on-warning"
}
}

Run with npx or bunx (No Install)

You can run tscheck on-demand without installing:

Terminal window
npx @masumdev/tscheck
# or
bunx @masumdev/tscheck