Serverpod Cloud CLI
The Serverpod Cloud CLI provides all you need to create, manage, and deploy your Serverpod projects in Serverpod Cloud.
If you're new to developing with Serverpod, check out the create a Serverpod project guide in the Serverpod framework docs!
Getting Started
Run the following to install the CLI:
dart pub global activate serverpod_cloud_cli
Log in to your Serverpod Cloud account using the CLI:
(If you don't have a Serverpod Cloud account yet, visit create an account.)
scloud auth login
Go to your Serverpod server directory (e.g. ./myproject/myproject_server)
and run the launch guide
to get an interactive, guided set up of a new Serverpod Cloud project:
scloud launch
If the project requires any environment variables or secrets, they can be added with the variable and secret commands. Once the project is ready to be deployed, run the following command:
scloud deploy
To follow the progress of the deployment, use the deployment show command:
scloud deployment show
That's it, you have now deployed your Serverpod app! 🚀
For more information on the different commands, see the commands section in the side menu. For instance, to view the service's domains or to add your own custom domains, see the domain command.
Online documentation
The Serverpod Cloud CLI documentation:
https://docs.serverpod.dev/cloud/reference/cli/introduction
Guide to getting started with Serverpod Cloud:
Libraries
- command_logger/command_logger
- command_runner/cloud_cli_command
- command_runner/cloud_cli_command_runner
- command_runner/commands/admin/admin_command
- command_runner/commands/admin/plan/admin_plan_command
- command_runner/commands/admin/plan/plan_admin_ops
- command_runner/commands/admin/product/admin_product_commands
- command_runner/commands/admin/product/product_admin_ops
- command_runner/commands/admin/product/product_admin_ui
- command_runner/commands/admin/projects/admin_projects_commands
- command_runner/commands/admin/projects/project_admin_ops
- command_runner/commands/admin/projects/project_admin_ui
- command_runner/commands/admin/redeploy/admin_redeploy_command
- command_runner/commands/admin/users/admin_users_commands
- command_runner/commands/admin/users/user_admin_ops
- command_runner/commands/admin/users/user_admin_ui
- command_runner/commands/auth/auth_command
- command_runner/commands/auth/auth_login
- command_runner/commands/auth/auth_ops
- command_runner/commands/auth/auth_ui
- command_runner/commands/categories
- command_runner/commands/context/context_command
- command_runner/commands/custom_domain/custom_domain_command
- command_runner/commands/db/db_backup_ops
- command_runner/commands/db/db_command
- command_runner/commands/db/db_ops
- command_runner/commands/deploy/deploy
- command_runner/commands/deploy/deploy_command
- command_runner/commands/deploy/prepare_project_files
- command_runner/commands/deploy/script_runner
- command_runner/commands/deployments/deployments_command
- command_runner/commands/deployments/deployments_ops
- command_runner/commands/deployments/deployments_ui
- command_runner/commands/launch/launch
- command_runner/commands/launch/launch_command
- command_runner/commands/launch/tui/app
- command_runner/commands/launch/tui/config
- command_runner/commands/launch/tui/main_screen
- command_runner/commands/launch/tui/state
- command_runner/commands/launch/tui/state_holder
- command_runner/commands/log/log_command
- command_runner/commands/log/logs_ops
- command_runner/commands/me/me_command
- command_runner/commands/me/me_ops
- command_runner/commands/me/me_ui
- command_runner/commands/password/password_command
- command_runner/commands/password/password_ops
- command_runner/commands/password/password_ui
- command_runner/commands/project/project_command
- command_runner/commands/project/project_ops
- command_runner/commands/project/project_ui
- command_runner/commands/settings/settings_command
- command_runner/commands/status/runtime_status
- command_runner/commands/status/status_command
- command_runner/commands/status/status_ops
- command_runner/commands/user/user_command
- command_runner/commands/user/user_ops
- command_runner/commands/user/user_ui
- command_runner/commands/variable/variable_command
- command_runner/commands/variable/variable_ops
- command_runner/commands/variable/variable_ui
- command_runner/commands/version/version_command
- command_runner/completion/completion_script_carapace
- This file is auto-generated.
- command_runner/completion/completion_script_completely
- This file is auto-generated.
- command_runner/helpers/build_token_provider
- command_runner/helpers/cli_run_context_resolver
- command_runner/helpers/cli_updater
- command_runner/helpers/cli_version_checker
- command_runner/helpers/cloud_cli_service_provider
- command_runner/helpers/command_options
- command_runner/helpers/email_validator
- command_runner/helpers/file_uploader_factory
- command_runner/ui/command_ui
- command_runner/ui/common_exceptions_handling_ui
- command_runner/ui/ui
- commands/billing/billing_commands
- constants
- persistent_storage/local_data_storage_exception
- persistent_storage/models/scloud_settings_data
- persistent_storage/models/serverpod_cloud_auth_data
- persistent_storage/models/serverpod_cloud_user_data
- persistent_storage/resource_manager
- persistent_storage/scloud_settings
- project_zipper/helpers/project_files
- project_zipper/project_zipper
- project_zipper/project_zipper_exceptions
- shared/base_command
- shared/error_reporting/sentry_error_reporter
- shared/exceptions/cloud_cli_usage_exception
- shared/exceptions/exit_exceptions
- shared/helpers/common_exceptions_handler
- shared/helpers/console_urls
- shared/helpers/exception_user_message
- shared/user_interaction/user_confirmations
- util/activation_checker
- util/browser_launcher
- util/capitalize
- util/cli_authentication_key_manager
- util/common
- util/dart_sdk_selector
- util/dart_version_util
- util/deploy_multi_instance_serverpod_warning
- util/duration_formatter
- util/git_metadata
- util/ignore
- Implements an Ignore filter compatible with
.gitignore. - util/inline_tui/inline_tui
- A small library of reusable inline terminal user interface (TUI) components.
- util/inline_tui/src/ansi_style
- util/inline_tui/src/bottom_region_renderer
- util/inline_tui/src/inline_terminal
- util/inline_tui/src/scrolling_process
- util/inline_tui/src/scrolling_section
- util/inline_tui/src/scrolling_sink
- util/inline_tui/src/select_list
- util/inline_tui/src/select_list_model
- util/inline_tui/src/select_list_style
- util/inline_tui/src/select_list_view
- util/inline_tui/src/tui_key
- util/inline_tui/src/windows_console
- util/listener_server
- util/output/command_output
- util/output/interactive_widgets
- util/output/output
- Command output facility that builds declarative UIs using widgets and supports different output formats (text, json, yaml).
- util/output/output_context
- util/output/output_format
- util/output/output_formatter
- util/output/output_widget
- util/output/text_table_widget
- util/output/widgets
- util/package_graph/package_graph
- util/package_graph/src/package_graph
- util/package_graph/src/package_graph_parser
- util/package_graph/src/pubspec_lock_filter
- util/printers/file_tree_printer
- util/printers/table_printer
- util/project_files_writer
- util/project_id_validator
- util/pubspec_validator
- util/scloud_config/file_finder
- util/scloud_config/json_to_yaml
- util/scloud_config/scloud_config
- util/scloud_config/scloud_config_broker
- util/scloud_config/scloud_config_io
- util/scloud_config/scloud_config_model
- util/scloud_config/yaml_schema
- util/scloud_version
- util/scloudignore
- util/scrolling_command_output
- util/stream_util
- util/tool_versions_io
- util/upload_description_metadata