caprover
Deploy and manage applications on CapRover
TLDR
Login to CapRover machine
$ caprover login
Deploy application$ caprover deploy
Deploy with specific options$ caprover deploy -n [machine-name] -a [app-name] -b [branch]
Deploy Docker image$ caprover deploy -i [image-name]
Deploy from tar file$ caprover deploy -t [app.tar]
List logged-in machines$ caprover list
Logout from machine$ caprover logout
SYNOPSIS
caprover command [options]
DESCRIPTION
caprover is the CLI for CapRover, a modern automated app deployment and web server manager. Use it to perform initial server setup and deploy applications via captain-definition files, Dockerfiles, tar files, or Docker images.
PARAMETERS
-n, --caproverName name
Target CapRover machine name-a, --caproverApp app
Application name to deploy-b, --branch branch
Git branch to deploy-t, --tarFile file
Path to tar file for deployment-i, --imageName image
Docker image to deploy-d, --default
Use previously entered values-c, --configFile file
Configuration file path-u, --caproverUrl url
CapRover machine URL-p, --caproverPassword password
CapRover password--appToken token
App-level authentication token
COMMANDS
login
Authenticate with a CapRover machinelogout
Remove authentication for a machinedeploy
Deploy application to CapRoverlist, ls
List all logged-in machinesapi
Call generic API on CapRover machine
CI/CD INTEGRATION
For automation, provide options directly:
$ caprover deploy -n machine -a app -b main
Requires prior login to the machine.CAVEATS
Requires Node.js and npm. Uncommitted and git-ignored files are not included when deploying branches. Install via npm install -g caprover.
