Skip to content

Migrating to v0.16

The command remains litestar run. Version 0.16 replaces the older execution mode flags with one supervised Granian child process group.

Deprecated Compatibility Options

v0.15 Option v0.16 and v0.17 Behavior
--in-subprocess or --no-subprocess Deprecated no-op. Supervised execution is always used.
--use-litestar-logger or --no-litestar-logger Deprecated no-op. Granian matches Litestar's active formatter automatically. Use --log-config for a complete override.

The deprecated switches emit a warning when passed, remain accepted as no-ops in v0.17, and are scheduled for removal in v0.18.

Retained Litestar Aliases

  • -R and --reload-dir add native --reload-paths values.
  • -I (--reload-include) and -E (--reload-exclude) retain Litestar glob filtering and enable reload automatically.
  • -U and --unix-domain-socket alias native --uds.
  • -F, --fd, and --file-descriptor pass an inherited socket on POSIX.
  • --pdb and --use-pdb retain Litestar debugger-on-exception behavior.

Behavior to Review

  • --workers has a minimum of 1 and no CPU-derived ceiling.
  • Protocol-specific settings are forwarded only for the selected HTTP mode.
  • HTTP/2-only mode (--http 2) disables WebSockets.
  • --ssl-client-verify requires --ssl-ca.
  • Metrics remain explicit and disabled by default (--metrics).
  • The parent hard-shutdown deadline equals --workers-kill-timeout plus five seconds.
  • Standard, custom JSON, structlog, and other compatible Litestar formatters are matched automatically without requiring a plugin logging flag.

Read Compatibility & Behaviour for environment variable precedence and package requirements.