modal app

Manage deployed and running apps.

Usage:

Options:

• --help: Show this message and exit.

Commands:

• list: List Modal apps that are currently deployed/running or recently stopped.
• logs: Show App logs, streaming while active.
• rollback: Redeploy a previous version of an App.
• stop: Stop an app.
• history: Show App deployment history, for a currently deployed app
• dashboard: Open an App’s dashboard page in your web browser.

modal app list 

List Modal apps that are currently deployed/running or recently stopped.

Usage:

Options:

• -e, --env TEXT: Environment to interact with.

If not specified, Modal will use the default environment of your current profile, or the MODAL_ENVIRONMENT variable. Otherwise, raises an error if the workspace has multiple environments.

• --json / --no-json: [default: no-json]
• --help: Show this message and exit.

modal app logs 

Show App logs, streaming while active.

Examples:

Get the logs based on an app ID:

Get the logs for a currently deployed App based on its name:

Usage:

Arguments:

• [APP_IDENTIFIER]: App name or ID

Options:

• -e, --env TEXT: Environment to interact with.

If not specified, Modal will use the default environment of your current profile, or the MODAL_ENVIRONMENT variable. Otherwise, raises an error if the workspace has multiple environments.

• --timestamps: Show timestamps for each log line
• --help: Show this message and exit.

modal app rollback 

Redeploy a previous version of an App.

Note that the App must currently be in a “deployed” state. Rollbacks will appear as a new deployment in the App history, although the App state will be reset to the state at the time of the previous deployment.

Examples:

Rollback an App to its previous version:

Rollback an App to a specific version:

Rollback an App using its App ID instead of its name:

Usage:

Arguments:

• [APP_IDENTIFIER]: App name or ID
• [VERSION]: Target version for rollback.

Options:

• -e, --env TEXT: Environment to interact with.

If not specified, Modal will use the default environment of your current profile, or the MODAL_ENVIRONMENT variable. Otherwise, raises an error if the workspace has multiple environments.

• --help: Show this message and exit.

modal app stop 

Stop an app.

Usage:

Arguments:

• [APP_IDENTIFIER]: App name or ID

Options:

• -e, --env TEXT: Environment to interact with.

If not specified, Modal will use the default environment of your current profile, or the MODAL_ENVIRONMENT variable. Otherwise, raises an error if the workspace has multiple environments.

• --help: Show this message and exit.

modal app history 

Show App deployment history, for a currently deployed app

Examples:

Get the history based on an app ID:

Get the history for a currently deployed App based on its name:

Usage:

Arguments:

• [APP_IDENTIFIER]: App name or ID

Options:

• -e, --env TEXT: Environment to interact with.

If not specified, Modal will use the default environment of your current profile, or the MODAL_ENVIRONMENT variable. Otherwise, raises an error if the workspace has multiple environments.

• --json / --no-json: [default: no-json]
• --help: Show this message and exit.

modal app dashboard 

Open an App’s dashboard page in your web browser.

Examples:

Open dashboard for an app by name:

Use a specified environment:

Usage:

Arguments:

• [APP_IDENTIFIER]: App name or ID

Options:

• -e, --env TEXT: Environment to interact with.

If not specified, Modal will use the default environment of your current profile, or the MODAL_ENVIRONMENT variable. Otherwise, raises an error if the workspace has multiple environments.

• --help: Show this message and exit.