flowscope-cli 0.2.0

Command-line interface for FlowScope SQL lineage analyzer
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

# flowscope-cli

Command-line interface for the FlowScope SQL lineage analyzer.

## Features

- **Multi-File Analysis**: Analyze single or multiple SQL files, or pipe input from stdin.
- **Dialect Support**: Supports all FlowScope dialects (PostgreSQL, Snowflake, BigQuery, Generic, etc.).
- **Schema Awareness**: Load DDL files to enable precise column-level lineage and validation.
- **Multiple Output Formats**:
  - `table`: Human-readable text summary (default).
  - `json`: Structured JSON output for programmatic integration.
  - `mermaid`: Generate Mermaid diagrams for visualization.
  - `sql`: DuckDB SQL export (DDL + INSERT statements).
  - `csv`: ZIP archive with CSV exports for scripts, tables, mappings, and issues.
  - `xlsx`: Excel workbook with summary and lineage sheets.
  - `html`: Self-contained HTML report.
  - `duckdb`: DuckDB database file (native builds only).
- **View Modes**:
  - `table`: Table-level lineage (default).
  - `column`: Detailed column-level data flow.
  - `script`: File-level dependencies.
  - `hybrid`: Combined view of scripts and tables.

## Installation

```bash
cargo install --path crates/flowscope-cli
```

## Usage

```bash
# Analyze a single file
flowscope query.sql

# Analyze multiple files with a specific dialect
flowscope -d snowflake etl/*.sql

# Analyze from stdin
cat query.sql | flowscope

# Generate a Mermaid diagram
flowscope -f mermaid -v column query.sql > lineage.mmd
```

## Options

```text
Usage: flowscope [OPTIONS] [FILES]...

Arguments:
  [FILES]...  SQL files to analyze (reads from stdin if none provided)

Options:
  -d, --dialect <DIALECT>  SQL dialect [default: generic]
                           [possible values: generic, ansi, bigquery, clickhouse, databricks, duckdb, hive, mssql, mysql, postgres, redshift, snowflake, sqlite]
  -f, --format <FORMAT>    Output format [default: table]
                           [possible values: table, json, mermaid, html, sql, csv, xlsx, duckdb]
  -s, --schema <FILE>      Schema DDL file for table/column resolution
  -o, --output <FILE>      Output file (defaults to stdout)
      --project-name <PROJECT_NAME>
                           Project name used for default export filenames [default: lineage]
      --export-schema <SCHEMA>
                           Schema name to prefix DuckDB SQL export
  -v, --view <VIEW>        Graph detail level for mermaid output [default: table]
                           [possible values: script, table, column, hybrid]
  -q, --quiet              Suppress warnings on stderr
      --compact            Compact JSON output (no pretty-printing)
  -h, --help               Print help
  -V, --version            Print version
```

## Examples

### JSON Output

```bash
flowscope -f json -d postgres query.sql
```

### Mermaid Diagram with Schema

Load a schema DDL file to resolve wildcards and validate columns, then generate a column-level diagram:

```bash
flowscope -s schema.sql -f mermaid -v column query.sql
```

### CSV Archive Export

```bash
flowscope -f csv -o lineage.csv.zip query.sql
```