Command Line Interface

This document describes the command-line interface of Deply.

Available Commands

Analyze Command

The main command for analyzing your project:

deply analyze

Validate Command

Validate your configuration without analyzing project files:

deply validate

Help Command

Display help information:

deply --help

Command Line Arguments

Analyze Command Options

• --config: Path to the configuration YAML file (default: deply.yaml)
• --report-format: Format of the output report (choices: text, json, github-actions, default: text)
• --output: Output file for the report (if not specified, prints to console)
• --mermaid: Generates a Mermaid diagram of layer dependencies
• --max-violations: Maximum number of allowed violations before failing (default: 0)
• --parallel: Enable parallel processing of code elements

Validate Command Options

• --config: Path to the configuration YAML file (default: deply.yaml)

Examples

Basic Analysis

deply analyze

Custom Configuration File

deply analyze --config=custom_config.yaml

Validate Configuration

deply validate --config=custom_config.yaml

Generate GitHub Actions Report

deply analyze --report-format=github-actions

Generate Mermaid Diagram

deply analyze --mermaid

Allow Some Violations

deply analyze --max-violations=5

Enable Parallel Processing

deply analyze --parallel

Output Formats

Text Format

The default output format shows violations in a human-readable text format:

/path/to/your_project/your_project/app1/views_api.py:74 - Layer 'views' is not allowed to depend on layer 'models'

JSON Format

The JSON format provides structured data that can be easily parsed by other tools:

{
  "violations": [
    {
      "file": "/path/to/your_project/your_project/app1/views_api.py",
      "line": 74,
      "message": "Layer 'views' is not allowed to depend on layer 'models'"
    }
  ]
}

For more information about:

• Mermaid diagrams, see the Mermaid Diagrams documentation
• Rules and violations, see the Rules documentation
• Configuration and usage, see the Configuration Guide and Getting Started guide