Skip to content

Command Reference

This is the full CLI reference with examples from basic to advanced.

analyze

Analyze a FastAPI source root and report conversion-relevant structure.

lilya-converter analyze SOURCE [--output REPORT.json] [--json]

Basic

lilya-converter analyze ./fastapi_project

Intermediate

lilya-converter analyze ./fastapi_project --output ./reports/scan.json

Advanced

lilya-converter analyze ./fastapi_project --json

Use this when you want machine-readable output in CI pipelines.

convert

Convert a FastAPI source root into a Lilya target root.

lilya-converter convert SOURCE TARGET \
  [--dry-run] \
  [--diff] \
  [--copy-non-python/--no-copy-non-python] \
  [--report REPORT.json]

Basic

lilya-converter convert ./fastapi_project ./lilya_project

lilya-converter convert ./fastapi_project ./lilya_project --dry-run --diff --report ./reports/convert.json

Advanced

lilya-converter convert ./fastapi_project ./lilya_project --no-copy-non-python --report ./reports/convert.json

Single-file workflow

The converter expects a source directory. For one-file conversion, use a minimal root.

mkdir -p ./tmp-single-source/app
cp ./fastapi_project/app/main.py ./tmp-single-source/app/main.py
lilya-converter convert ./tmp-single-source ./tmp-single-target --report ./reports/convert-single.json

scaffold

Generate a minimal Lilya scaffold informed by source analysis.

lilya-converter scaffold SOURCE TARGET [--dry-run]

Basic

lilya-converter scaffold ./fastapi_project ./lilya_scaffold

Advanced

lilya-converter scaffold ./fastapi_project ./lilya_scaffold --dry-run

map rules

List all known conversion rules.

lilya-converter map rules

map applied

Show which rules were actually applied in a conversion report.

lilya-converter map applied ./reports/convert.json

verify

Run structural checks on converted output.

lilya-converter verify TARGET [--report REPORT.json]

Basic

lilya-converter verify ./lilya_project

Intermediate

lilya-converter verify ./lilya_project --report ./reports/verify.json

What it checks

  • Python syntax validation.
  • Remaining FastAPI import/call patterns.
  • Unresolved local imports.

Suggested production routine

  1. analyze
  2. convert --dry-run --diff
  3. convert
  4. verify
  5. map applied