Installation Guide

Get started with Sunlint's comprehensive code quality tools. Choose between CLI automation and AI-powered VS Code analysis, or use both for complete coverage.

sunlint CLI
Complete code quality toolchain for automated rule checking
128+ automated rules
ESLint & Git hooks
CI/CD ready
Multi-language
CLI Installation Methods
Multiple installation options for the sunlint command-line tool

Global Installation (Recommended)

Install globally to use sunlint across all projects

npm install -g @sun-asterisk/sunlint

Verify installation:

sunlint --version

Project Installation

Install as a development dependency in your project

npm install --save-dev @sun-asterisk/sunlint eslint @typescript-eslint/parser @typescript-eslint/eslint-plugin typescript

Add to package.json scripts:

{
  "scripts": {
    "lint": "sunlint --all --input=src",
    "lint:changed": "sunlint --all --changed-files", 
    "lint:security": "sunlint --security --input=src"
  }
}

Alternative Installation

Using Yarn or direct GitHub release

Yarn:

yarn global add @sun-asterisk/sunlint

GitHub Release:

wget https://github.com/sun-asterisk/sunlint/releases/latest/download/sunlint-linux
Quick Start Examples
Common usage patterns for the CLI tool

Basic Usage

# Run all rules on src directory
sunlint --all --input=src
# Check specific rules, language rules
sunlint --rules=C019,S005 --input=src
sunlint --specific --languages=dart --input=lib
# Security-focused scan
sunlint --security --input=src

Advanced Usage

# ESLint integration
sunlint --all --eslint-integration --input=src
# Git integration
sunlint --all --changed-files
# CI/CD mode
sunlint --all --pr-mode --fail-on-new-violations
AI Agent Integration

Guide AI Coding Agents (Copilot, Cursor, Claude) to automatically comply with 136 rules.

sunlint init -t github-copilot
Architecture Detection

Automatically detect patterns (Clean, Layered, MVC...), check for dependency violations.

sunlint --architecture --input=src
Impact Analysis

Analyze the impact of code changes, generate detailed impact reports for PR reviews.

sunlint --impact-analysis --changed-files
CI/CD Integration
Ready-to-use configurations for popular CI/CD platforms

GitHub Actions

name: Code Quality Check
on: [push, pull_request]
jobs:
  sunlint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: '18'
      - run: npm install -g @sun-asterisk/sunlint
      - run: sunlint --all --changed-files --fail-on-new-violations

GitLab CI

sunlint:
  stage: test
  image: node:18
  script:
    - npm install -g @sun-asterisk/sunlint
    - sunlint --all --input=src --format=json --output=report.json
  artifacts:
    reports:
      junit: report.json
    expire_in: 1 week
SunLint Report Dashboard
Centralized reporting platform for tracking code quality metrics across projects

View detailed analytics, track improvements over time, and monitor compliance trends for your organization. The dashboard provides comprehensive insights into code quality violations, security issues, and architectural patterns across all your projects.

Key Features

  • Real-time quality score tracking
  • Historical trend analysis
  • Multi-project comparison
  • Customizable violation reports

Dashboard Integration Example (GitHub Actions)

# .github/workflows/sunlint-ci.yml

name: Sunlint Code Quality Check
on: [pull_request]
jobs:
  sunlint:
    runs-on: ubuntu-latest
    # permissions are required for uploading report to Dashboard
    permissions:
      id-token: write
      contents: read
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-node@v3
        with:
          node-version: '21' # support node 18+
      # Install Sunlint globally
      - run: npm install -g @sun-asterisk/sunlint
      # Run Sunlint with the specified options and upload the report to the Dashboard
      # --output-summary=report.json --upload-report are required for Dashboard integration
      - run: sunlint --all --input=src --output-summary=report.json --upload-report
Next Steps
Continue your journey with Sunlint