Serverpod Cloud CLI
The Serverpod Cloud CLI is a command line interface for the Serverpod Cloud platform. It is used to manage and deploy Serverpod Cloud projects.
Contributing Guidelines
The Serverpod Cloud CLI is developed in a closed-source repository. We are not accepting contributions to this repository at this time. Please create an issue on this repository if you have any suggestions or feedback.
Commands
The Serverpod Cloud CLI has the following commands:
| Command | Description |
|---|---|
| version | Print the version of the Serverpod Cloud CLI. |
| auth | Log in, log out, or create an account in Serverpod Cloud. |
| db | Manage Serverpod Cloud DBs. |
| deploy | Deploy a Serverpod project to the cloud. |
| domain | Manage Serverpod Cloud custom domains. |
| env | Manage Serverpod Cloud environment variables for a project. |
| log | Fetch Serverpod Cloud logs. |
| project | Manage Serverpod Cloud projects. |
| secret | Manage Serverpod Cloud secrets. |
| status | Show status information. |
Online documentation
The CLI documentation can be accessed at:
Libraries
- command_logger/command_logger
- command_runner/cloud_cli_command
- command_runner/cloud_cli_command_runner
- command_runner/commands/auth_command
- command_runner/commands/categories
- command_runner/commands/custom_domain_command
- command_runner/commands/db_command
- command_runner/commands/deploy_command
- command_runner/commands/env_command
- command_runner/commands/launch_command
- command_runner/commands/log_command
- command_runner/commands/project_command
- command_runner/commands/secret_command
- command_runner/commands/status_command
- command_runner/commands/user_command
- command_runner/commands/version_command
- command_runner/helpers/cli_version_checker
- command_runner/helpers/cloud_cli_service_provider
- command_runner/helpers/command_options
- command_runner/helpers/file_uploader_factory
- commands/deploy/deploy
- commands/deploy/prepare_workspace
- commands/launch/launch
- commands/logs/logs
- commands/project/project
- commands/status/status
- commands/status/status_feature
- commands/user/user
- constants
- persistent_storage/models/serverpod_cloud_data
- persistent_storage/resource_manager
- project_zipper/helpers/project_files
- project_zipper/project_zipper
- project_zipper/project_zipper_exceptions
- shared/exceptions/cloud_cli_usage_exception
- shared/exceptions/exit_exceptions
- shared/helpers/common_exceptions_handler
- shared/helpers/exception_user_message
- util/browser_launcher
- util/capitalize
- util/cli_authentication_key_manager
- util/common
- util/ignore
- Implements an Ignore filter compatible with
.gitignore. - util/listener_server
- util/printers/file_tree_printer
- util/printers/table_printer
- 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_file
- util/scloud_config/yaml_schema
- util/scloud_version
- util/scloudignore