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 app

Manage deployed and running apps.

Usage:

modal app [OPTIONS] COMMAND [ARGS]...

Options:

  • --help: Show this message and exit.

Commands:

  • deploy: [Moved] Deploy a Modal stub as an…
  • list: List all running or recently running Modal…
  • logs: Output logs for a running app.
  • run: [Moved] Run a Modal function.
  • shell: [Moved] Start a shell session in a Modal…
  • stop: Stop an app.

[Moved] Deploy a Modal stub as an application.

Usage:

modal app deploy [OPTIONS]

Options:

  • --help: Show this message and exit.

List all running or recently running Modal apps for the current account

Usage:

modal app list [OPTIONS]

Options:

  • --help: Show this message and exit.

Output logs for a running app.

Usage:

modal app logs [OPTIONS] APP_ID

Arguments:

  • APP_ID: [required]

Options:

  • --help: Show this message and exit.

[Moved] Run a Modal function.

Usage:

modal app run [OPTIONS]

Options:

  • --help: Show this message and exit.

[Moved] Start a shell session in a Modal container

Usage:

modal app shell [OPTIONS]

Options:

  • --help: Show this message and exit.

Stop an app.

Usage:

modal app stop [OPTIONS] APP_ID

Arguments:

  • APP_ID: [required]

Options:

  • --help: Show this message and exit.