arklint 0.3.0

arklint

The architectural rulebook for your codebase. Prevention, not detection.

Arklint enforces architectural rules before bad code ever lands — whether written by AI agents or humans. It's language-agnostic, runs locally with zero cloud dependency, and takes 60 seconds to set up.

This package is a .NET global tool wrapper. On first run it downloads the platform-specific prebuilt binary from GitHub Releases and caches it at ~/.arklint/bin/. No Python required.

Requires .NET 8.0+. Supported platforms: Linux x64, macOS ARM64 (Apple Silicon), Windows x64.

Installation

dotnet tool install -g arklint

Upgrade to a newer version:

dotnet tool update -g arklint

Quick start

# 1. Create a starter config in your project root
arklint init

# 2. Edit .arklint.yml to match your architecture

# 3. Check your codebase
arklint check

# 4. In CI — exit 1 on any violation
arklint check --strict

Key commands

Example .arklint.yml

version: "1"

# Extend an official rule pack
extends:
  - arklint/fastapi

# Add your own project-specific rules
rules:
  - id: no-direct-db-in-routes
    type: boundary
    description: "Routes must not import the database layer directly"
    source: "routes/**"
    blocked_imports:
      - "sqlalchemy"
      - "psycopg2"
    severity: error

  - id: layered-architecture
    type: layer-boundary
    description: "Enforce routes → services → repositories"
    layers:
      - name: routes
        path: "routes/**"
      - name: services
        path: "services/**"
      - name: repositories
        path: "repositories/**"
    allowed_dependencies:
      routes: [services]
      services: [repositories]
      repositories: []
    severity: error

Official rule packs

arklint search fastapi
arklint add arklint/fastapi
arklint add arklint/django
arklint add arklint/nextjs
arklint add arklint/express
arklint add arklint/clean-arch

Use in CI (.NET projects)

# .github/workflows/arklint.yml
- name: Install arklint
  run: dotnet tool install -g arklint

- name: Run arklint
  run: arklint check --diff origin/main --strict

Full documentation

https://arklint.elevane.org · GitHub · PyPI · npm

License

MIT © Kaushik13k