Get Started¶

This page gives you a production-safe quick start with Lilya Converter.

1. Install¶

pip install lilya-converter

2. Choose a source key¶

Framework	Source key
FastAPI	`fastapi` (default)
Flask	`flask`
Django	`django`
Litestar	`litestar`
Starlette	`starlette`

3. Inspect your project¶

lilya-converter analyze ./source_project --source SOURCE_KEY --output ./reports/scan.json

FastAPI shorthand (default source):

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

4. Preview conversion (no writes)¶

lilya-converter convert ./source_project ./lilya_project \
  --source SOURCE_KEY \
  --dry-run \
  --diff \
  --report ./reports/convert.json

5. Run conversion¶

lilya-converter convert ./source_project ./lilya_project --source SOURCE_KEY --report ./reports/convert.json

6. Verify target output¶

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

7. Example source selections¶

lilya-converter convert ./fastapi_project ./lilya_project
lilya-converter convert ./flask_project ./lilya_project --source flask
lilya-converter convert ./django_project ./lilya_project --source django
lilya-converter convert ./litestar_project ./lilya_project --source litestar
lilya-converter convert ./starlette_project ./lilya_project --source starlette

Typical workflow¶

Run analyze to inspect patterns detected by the selected adapter.
Run convert --dry-run --diff to preview impact.
Run convert without dry-run.
Run verify and resolve diagnostics.
Commit converted output once checks pass.

For concrete stdout and report examples, see Examples and Outputs.