caprover

caprover command [options] [arguments]

--help
    Displays help information for the caprover CLI or a specific command.

-h
    Short form for --help.

--version
    Shows the current version of the caprover CLI client.

-v
    Short form for --version.

--caproverUrl
    Specifies the URL of the CapRover instance to connect to, overriding the saved configuration.

--password
    Provides the CapRover server password directly. Use with extreme caution as it may expose credentials in shell history.

--debug
    Enables verbose debug logging for troubleshooting purposes.

CapRover is an open-source Platform-as-a-Service (PaaS) that simplifies web application deployment. The caprover command-line interface (CLI) is its primary tool, allowing developers and administrators to interact with a CapRover server directly from their local machine. It facilitates a wide array of tasks, including logging into CapRover instances, deploying new applications, managing existing apps (creation, deletion, configuration updates), setting up custom domains, and overseeing user access. The CLI significantly streamlines CI/CD workflows, enabling automated deployments and infrastructure management. It acts as a client communicating with the CapRover API, providing a convenient and powerful way to control your deployments without needing direct server access or complex manual configurations. It abstracts away much of the underlying Docker, Nginx, and Let's Encrypt complexities, offering a user-friendly interface for your self-hosted cloud.

The caprover CLI requires a running CapRover server instance to function.
Network connectivity to the target CapRover server is essential for all operations.
Be cautious when using the --password option as it can expose credentials in your shell history.
Some commands require administrator privileges on the CapRover server.

The caprover CLI operates through various subcommands to perform specific tasks:
caprover login: Authenticates the CLI with a CapRover instance.
caprover deploy: Deploys an application, either from the current directory (source code) or a specified Docker image/tarball.
caprover app create <appName>: Creates a new application on the CapRover server.
caprover app delete <appName>: Removes an existing application.
caprover app config <appName> --key <key> --value <value>: Sets or updates environment variables or other configuration settings for an application.
caprover app list: Displays a list of all applications deployed on the server.
caprover server update: Initiates an update for the CapRover server software itself.

The caprover CLI stores its configuration and login tokens in ~/.caprover/config.json. This file contains the server URL, authentication tokens, and potentially other settings. It should be protected as it contains sensitive information.

CapRover was initiated as an open-source project by Mahmoud F. with the goal of providing a simple, self-hostable Platform-as-a-Service (PaaS) similar to Heroku, but on your own server. Developed to abstract the complexities of Docker, Nginx, and Let's Encrypt, it quickly gained traction for its ease of use in deploying web applications. The caprover CLI has been a core component from early on, evolving alongside the platform to offer comprehensive control over app deployment, management, and server configuration, continuously improving the developer experience.

docker(1), git(1), nginx(8), certbot(1)