Plotly Cloud CLI

Reference documentation for Plotly Cloud CLI v0.4.2

Overview

CLI for publishing and managing Dash apps on Plotly Cloud.

Installation

pip install "dash[cloud]"

Usage:

plotly [--verbose] <command> [<args>]

Commands and Options

• app - App commands
• user - User commands

Global Options

• --api-key - API key for authentication (alternative to plotly user login). Can also be set via the PLOTLY_API_KEY environment variable
• --verbose, -v - Enable verbose output with detailed error information
• --help, -h - Show this help message and exit

app

Commands for app

app run

Start a local development server for your Dash application with debugging tools.

Usage:

plotly app run [options]

Arguments:

• app - The Dash application to run in ‘module:variable’ format (e.g., ‘app:app’)

Options:

• --host - Host IP address to bind to (default: 127.0.0.1)
• --port - Port number to listen on (default: 8050)
• --proxy - Proxy configuration for the application
• --debug - Enable debug mode with detailed error messages
• --dev-tools-ui - Enable development tools UI
• --dev-tools-props-check - Enable component prop validation
• --dev-tools-serve-dev-bundles - Enable serving development bundles
• --dev-tools-hot-reload - Enable hot reloading for development
• --dev-tools-hot-reload-interval - Polling interval for hot reload (default: 3.0)
• --dev-tools-hot-reload-watch-interval - File watch polling interval (default: 0.5)
• --dev-tools-hot-reload-max-retry - Max failed hot reload requests (default: 8)
• --dev-tools-silence-routes-logging - Silence Werkzeug route logging
• --dev-tools-disable-version-check - Disable Dash version upgrade check
• --dev-tools-prune-errors - Prune tracebacks to user code only
• --open - Automatically open browser with server URL

app publish

Package and publish your Dash application to Plotly Cloud.

Usage:

plotly app publish [options]

Options:

• --project-path - Path to project directory to publish (default: current directory) (default: .)
• --config - Path to configuration file (default: plotly-cloud.toml)
• --name - Application name (will prompt if not provided first time app is published)
• --entrypoint-module - Entrypoint module for the application in ‘module:variable’ format (e.g., ‘app:app’)
• --team-id - Team ID to assign the app to (uses user’s default team if not specified)
• --team - Team name to assign the app to (alternative to –team-id)
• --output - Output path for zip file of the published app (default: temporary file)
• --keep-zip - Keep the zip file of the published app after upload
• --poll-status - Poll publishing status until completion (default: True) (default: True)
• --poll-interval - Polling interval in seconds (default: 1.0)
• --poll-timeout - Polling timeout in seconds (default: 180)
• --skip-size-check - Skip the standard 200MB project size validation (note: a hard 700MB maximum still applies)

app list

Display all applications published to Plotly Cloud.

Usage:

plotly app list [options]

Options:

• --team - Filter apps by team name
• --team-id - Filter apps by team ID

app status

Retrieve the current status and details of your published app.

Usage:

plotly app status [options]

Options:

• --project-path - Path to project directory (default: .)
• --config - Path to configuration file (default: plotly-cloud.toml)

app logs

Retrieve build or runtime logs for your published application.

Usage:

plotly app logs [options]

Options:

• --project-path - Path to project directory (default: .)
• --config - Path to configuration file (default: plotly-cloud.toml)
• --type - Type of logs to retrieve (default: build) (default: build)
• --revision - Revision ID (default: latest revision)

user

Commands for user

user login

Authenticate with Plotly Cloud to publish and manage applications.

Usage:

plotly user login [options]

Options:

• --browser - Open browser for authentication (default behavior)
• --no-browser - Don’t open browser automatically - show URL instead

user logout

Clear your authentication credentials and log out from Plotly Cloud.

Usage:

plotly user logout [options]

user teams

Display all teams that you are a member of.

Usage:

plotly user teams [options]

user whoami

Display the username if currently logged in with a valid token.

Usage:

plotly user whoami [options]