Getting Started

Prerequisites

• Node.js 24+ (or Deno)
• A JavaScript or TypeScript workspace

Quick Start

The easiest way to get started is with init, which installs Moniq and creates a starter configuration.

npm

npx @udohjeremiah/moniq init

pnpm

pnpm dlx @udohjeremiah/moniq init

yarn

yarn dlx @udohjeremiah/moniq init

bun

bun x @udohjeremiah/moniq init

deno

deno run -A npm:@udohjeremiah/moniq init

Manual Installation

Install Moniq in your workspace root.

npm

npm install -D @udohjeremiah/moniq

pnpm

pnpm add -D -w @udohjeremiah/moniq

yarn

yarn add -D @udohjeremiah/moniq

bun

bun add -D @udohjeremiah/moniq

deno

deno add -D npm:@udohjeremiah/moniq

Create a moniq.config.{ts,js,mjs,cjs,mts,cts} file in the workspace root.

import { defineConfig } from "@udohjeremiah/moniq";

export default defineConfig({
  scripts: {
    build: { command: "tsdown" },
    lint: { command: "eslint ." },
  },
});

Run Moniq

Run Moniq from the workspace root.

npm

npx moniq check

pnpm

pnpm moniq check

yarn

yarn moniq check

bun

bun run moniq check

deno

deno run -A npm:@udohjeremiah/moniq check

If every policy passes, Moniq exits successfully.

Otherwise, it reports every policy violation found in your workspace.

Next Steps

• Learn how to write policies in the Configuration guide.
• Explore all available CLI commands.
• Set up Moniq in CI.