@linterly/cli

A lightweight linter that checks code line counts. Set line limits per file and per directory to detect bloated code early.

Installation

# Global
npm install -g @linterly/cli

# Project-local (recommended)
npm install -D @linterly/cli

Also available via Go:

go install github.com/ousiassllc/linterly/cmd/linterly@latest

Quick Start

# Generate a config file
npx linterly init

# Check the current directory
npx linterly check

# Check a specific path
npx linterly check src/

# Output in JSON format
npx linterly check --format json

# Override config values with CLI flags
npx linterly check --max-lines-per-file 500 --count-mode code_only

# Run without a config file (uses defaults)
npx linterly check --max-lines-per-file 500 --warning-threshold 20

# Add ignore patterns via CLI
npx linterly check --ignore "vendor/**" --ignore "*.pb.go"

# Disable default excludes
npx linterly check --no-default-excludes

Configuration

A config file is optional. Without one, Linterly runs with sensible defaults. You can override any setting via CLI flags.

Place a .linterly.yml in your project root:

rules:
  max_lines_per_file: 300
  max_lines_per_directory: 2000
  warning_threshold: 10

count_mode: all       # all | code_only
language: en          # en | ja

ignore:
  - "vendor/**"
  - "*.pb.go"

default_excludes: true

CLI flags always take precedence over config file values (CLI flags > config file > defaults).

You can also create a .linterlyignore file (gitignore format) for exclusion patterns.

Git Hooks Integration

Husky + lint-staged

{
  "lint-staged": {
    "*.{js,ts,go,py,rb}": ["linterly check"]
  }
}

Lefthook

pre-commit:
  commands:
    linterly:
      glob: "*.go"
      run: linterly check {staged_files}

Supported Platforms

| Platform | Package | |----------|---------| | Linux x64 | @linterly/linux-x64 | | Linux arm64 | @linterly/linux-arm64 | | macOS x64 | @linterly/darwin-x64 | | macOS arm64 | @linterly/darwin-arm64 | | Windows x64 | @linterly/win32-x64 |

Platform-specific packages are installed automatically via optionalDependencies.

Links

• GitHub
• GitHub Releases
• Documentation

License

MIT