Modal logo
GuideReference

CLI Reference

modal app modal config modal deploy modal env modal profile modal run modal secret modal serve modal shell modal token modal volume

API Reference

Introduction modal.App modal.Client modal.Cron modal.Dict modal.Error modal.Function modal.Image modal.Mount modal.Period modal.Proxy modal.Queue modal.Retries modal.Secret modal.SharedVolume modal.Stub modal.asgi_app modal.call_graph modal.create_package_mounts modal.gpu modal.method modal.runner modal.web_endpoint modal.wsgi_app modal.exception modal.config

modal serve

Run a web endpoint(s) associated with a Modal stub and hot-reload code.

Examples:

modal serve hello_world.py

Usage:

modal serve [OPTIONS] STUB_REF

Arguments:

  • STUB_REF: Path to a Python file with a stub. [required]

Options:

  • --timeout FLOAT
  • --help: Show this message and exit.