Introduction

Commands

In this section you will learn about all the available commands for QuickDeploy with possible combinations that you can use.

One important concept!

QuickDeploy deployments work on a project basis. Per default the project name is the name of the directory. But you can also specify a project name with the --project flag. This is necessary if you for example want to deploy a connected frontend and backend.

quickdeploy configure

This command is used to configure the QuickDeploy CLI. It will ask you for the IP address of your server, the user you want to use for the deployment and the user you want to use for the deployment.

quickdeploy configure

Flags

  • --ssh: Configure only the path to the SSH key.
  • --license: Configure only the license key. (Configure using email address or license key)

environment variables

You can also configure the QuickDeploy CLI with environment variables instead of using the quickdeploy configure command.

QUICKDEPLOY_IP=1.2.3.4
QUICKDEPLOY_USER=root 
QUICKDEPLOY_PRIVATE_KEY="---..."

quickdeploy push

This command is used to deploy a project to your server.

quickdeploy push

Flags

  • --domain: The domain you want the project to be accessible on.
  • --path: The path to the project you want to deploy. Default: .
  • --project: The project name you want to deploy.
  • --container: The container name you want to deploy. Default: project-name
  • --port: The port you want to deploy to. Default: 8080
  • --db: The database type you want to deploy. Default: postgres
  • --db-port: The port you want to deploy the database to. Default: 5432 (postgres), 3306 (mysql), 6379 (redis)
  • --db-user: The user you want to deploy the database to. Default: project-name
  • --db-password: The password you want to deploy the database to. Default: project-name
  • --db-name: The name you want to deploy the database to. Default: project-name
  • --detach: Run deployment in background (don't wait for completion)

Examples

Deploy a frontend or full stack project with a domain.

quickdeploy push --domain example.com

Deploy a backend project.

quickdeploy push

Deploy a separated backend and frontend project.

quickdeploy push --domain example.com --project my-project # frontend
quickdeploy push --project my-project # backend

Quickly deploy a project with a database. Default: <project>, 5432, postgres, <project>, <project>

quickdeploy push --db postgres

Deploy with proper arguments project with a database.

quickdeploy push --db postgres --db-port 5432 --db-user postgres --db-password postgres --db-name postgres

Deploy in background mode (useful for long deployments).

quickdeploy push --domain example.com --detach

When using --detach, the deployment runs in the background and you can monitor progress with:

ssh user@server 'tail -f /tmp/quickdeploy-<project-name>.log'

quickdeploy rm

This command is used to remove a deployed project from your server. It will stop containers, remove images, clean up project files, and update the Caddy configuration.

quickdeploy rm <project>

Arguments

  • <project>: The name of the project to remove (required).

Examples

Remove a deployed project.

quickdeploy rm my-project

Warning!

This operation is destructive and will permanently remove:

  • All containers for the project
  • Docker images for the project
  • Project configuration files
  • Database containers and data (if deployed with the project)
  • Domain entries from Caddy configuration

Make sure to backup any important data before removing a project.

Previous
Installation
Next
Environment Variables