< DOCUMENTATION />

# 1. Install LucidShark
$ pip install lucidshark

# 2. Initialize Claude Code integration
$ lucidshark init

# 3. Restart Claude Code, then ask:
You: Autoconfigure LucidShark for this project

# Claude analyzes your codebase and generates lucidshark.yml

# 4. Restart Claude Code again to load the new config
# Now you can ask Claude to check your code quality anytime!

$ pip install lucidshark

$ curl -fsSL https://raw.githubusercontent.com/toniantunovi/lucidshark/main/install.sh | bash

> irm https://raw.githubusercontent.com/toniantunovi/lucidshark/main/install.ps1 | iex

$ lucidshark init

{
  "mcpServers": {
    "lucidshark": {
      "command": "lucidshark",
      "args": ["serve", "--mcp"]
    }
  }
}

$ lucidshark scan --linting        # Code style
$ lucidshark scan --type-checking  # Static analysis
$ lucidshark scan --sca            # Dependency vulnerabilities
$ lucidshark scan --sast           # Code security patterns
$ lucidshark scan --iac            # Infrastructure-as-Code
$ lucidshark scan --testing        # Test suites
$ lucidshark scan --coverage       # Coverage analysis
$ lucidshark scan --duplication    # Code duplication
$ lucidshark scan --all            # All domains

# Lint changed files (default)
$ lucidshark scan --linting

# Full project scan
$ lucidshark scan --all --all-files

# Specific files
$ lucidshark scan --files src/main.py src/utils.py

# Auto-fix linting issues
$ lucidshark scan --linting --fix

# JSON output
$ lucidshark scan --format json

version: 1

project:
  name: my-app
  languages: [python, typescript]

pipeline:
  max_workers: 4

  linting:
    enabled: true
    exclude: ["migrations/**", "generated/**"]
    tools:
      - name: ruff
        config: ruff.toml
      - name: eslint

  type_checking:
    enabled: true
    tools:
      - name: mypy
        strict: true

  security:
    enabled: true
    tools:
      - name: trivy
        domains: [sca, container]
      - name: opengrep
        domains: [sast]

  testing:
    enabled: true
    tools: [pytest]

  coverage:
    enabled: true
    tools: [coverage_py]
    threshold: 80

  duplication:
    enabled: true
    threshold: 10.0
    min_lines: 4

fail_on:
  linting: error
  type_checking: error
  security: high
  testing: any
  coverage: below_threshold

exclude:
  - "**/.git/**"
  - "**/node_modules/**"
  - "**/.venv/**"

version: 1
project:
  name: my-python-app
  languages: [python]
pipeline:
  linting:
    enabled: true
    tools: [ruff]
  type_checking:
    enabled: true
    tools: [mypy]
fail_on:
  linting: error
  type_checking: error

version: 1
project:
  name: my-ts-app
  languages: [typescript, javascript]
pipeline:
  linting:
    enabled: true
    tools: [eslint]
  type_checking:
    enabled: true
    tools: [typescript]
fail_on:
  linting: error
  type_checking: error

version: 1
project:
  name: my-python-app
  languages: [python]
pipeline:
  linting:
    enabled: true
    tools: [ruff]
  type_checking:
    enabled: true
    tools: [mypy]
  testing:
    enabled: true
    tools: [pytest]
  coverage:
    enabled: true
    tools: [coverage_py]
    threshold: 80
fail_on:
  linting: error
  type_checking: error
  testing: any
  coverage: below_threshold

pipeline:
  linting:
    command: "npm run lint -- --format json"
  testing:
    command: "docker compose run --rm app pytest"
    post_command: "npm run cleanup"

# Dependencies
node_modules/
.venv/

# Build artifacts
dist/
build/
*.pyc

# Generated code
generated/
**/*.generated.ts

# Global excludes
exclude:
  - "**/node_modules/**"
  - "**/.venv/**"

pipeline:
  linting:
    # Per-domain excludes
    exclude:
      - "migrations/**"
      - "generated/**"

{
  "instruction": "Fix security vulnerability in auth.py",
  "issue": {
    "type": "security",
    "severity": "high",
    "rule": "opengrep.python.security.hardcoded-password"
  },
  "location": {
    "file": "src/api/auth.py",
    "line": 23,
    "code_snippet": "password = \"admin123\""
  },
  "fix_guidance": {
    "description": "Hardcoded password detected",
    "suggested_fix": "password = os.environ.get('DB_PASSWORD')",
    "steps": ["Import os", "Use environment variable"]
  }
}