Installation

archlint can be used as a CLI tool or as an ESLint plugin.

CLI Tool (Recommended)

The easiest way to use archlint is via npx. This ensures you're always using the latest version without adding it to your package.json.

npx @archlinter/cli scan

Global Installation

If you want to install archlint globally for use across all projects:

npm

npm install -g @archlinter/cli

pnpm

pnpm add -g @archlinter/cli

yarn

yarn global add @archlinter/cli

bun

bun add -g @archlinter/cli

deno

deno install -g npm:@archlinter/cli

After global installation, you can run archlint directly:

archlint scan

Local Installation

Alternatively, you can install it as a dev dependency in your project:

npm

npm install -D @archlinter/cli

pnpm

pnpm add -D @archlinter/cli

yarn

yarn add -D @archlinter/cli

bun

bun add -D @archlinter/cli

deno

deno install npm:@archlinter/cli

From Source (Rust)

If you prefer to use the native binary directly, you can install it via Cargo:

cargo install archlint

ESLint Plugin

To get real-time architectural feedback in your IDE, install the ESLint plugin:

npm

npm install -D @archlinter/eslint-plugin

pnpm

pnpm add -D @archlinter/eslint-plugin

yarn

yarn add -D @archlinter/eslint-plugin

bun

bun add -D @archlinter/eslint-plugin

deno

deno install npm:@archlinter/eslint-plugin

See the ESLint Integration section for configuration details.

MCP Server

If you're using AI coding assistants like Claude or Cursor, you can install our MCP server:

npx @archlinter/mcp-server

See the MCP Server section for more information.

GitHub Action

To prevent architectural regressions in your Pull Requests, use our official GitHub Action:

- name: archlint
  uses: archlinter/action@v1
  with:
    baseline: origin/${{ github.base_ref }}
    fail-on: medium
    github-token: ${{ github.token }}

See the GitHub Actions section for more information.