Introduction

Installation

Download the correct binary for your operating system using the instructions below. You can check the local installation before buying; configuring QuickDeploy and deploying an app require a license.

Verify before you buy

After installing the binary for your platform, run:

quickdeploy --version

This prints the CLI version without asking for a license or connecting to a server. It confirms that the binary runs on your computer, not that your app or server is compatible. Review the server and application requirements before buying.

After purchase: start here

  1. Keep your purchase email or license key available.
  2. Prepare your Ubuntu VPS with Docker, Compose, SSH key access, and a domain for a public app. Use the server setup guide if needed.
  3. Run quickdeploy configure and enter your purchase email or license key, server address, SSH user, and key when prompted.
  4. From your app's project directory, follow the deployment recipe or command examples for your setup.
  5. Open the deployed app over HTTPS and check its key actions. Use quickdeploy push again for subsequent releases.

If your purchase email or key is not recognized, contact support using the email you purchased with. Do not post your license key in public issues.

Linux

Check your CPU architecture with uname -m, then run the matching block in a directory you can write to.

Linux x86_64

For x86_64:

curl --fail --location --output quickdeploy https://quickdeploy.dev/api/download/linux-amd64 &&
  sudo install -m 755 quickdeploy /usr/local/bin/quickdeploy &&
  quickdeploy --version

Linux ARM64

For aarch64 or arm64:

curl --fail --location --output quickdeploy https://quickdeploy.dev/api/download/linux-arm64 &&
  sudo install -m 755 quickdeploy /usr/local/bin/quickdeploy &&
  quickdeploy --version

install copies the binary and sets executable permissions in the same privileged step. The && operators stop the block if downloading or installing fails. Neither block configures QuickDeploy or connects to your VPS.

macOS

  1. Add the tap to your homebrew:
brew tap programonaut/quickdeploy
  1. Install the binary:
brew install quickdeploy
  1. Run quickdeploy --version to verify the installation

  2. To update the binary run:

brew update
brew upgrade quickdeploy

Manual

Choose the binary for your Mac. You can check with uname -m: arm64 is Apple Silicon; x86_64 is Intel (or a terminal running under Rosetta).

Apple Silicon

curl --fail --location --output quickdeploy https://quickdeploy.dev/api/download/darwin-arm64 &&
  sudo install -m 755 quickdeploy /usr/local/bin/quickdeploy &&
  quickdeploy --version

Intel

curl --fail --location --output quickdeploy https://quickdeploy.dev/api/download/darwin-amd64 &&
  sudo install -m 755 quickdeploy /usr/local/bin/quickdeploy &&
  quickdeploy --version

If /usr/local/bin does not exist, create it with sudo mkdir -p /usr/local/bin, then rerun your block. These commands stop on a download or install error and set executable permissions during installation.

Windows (CMD)

  1. Download the binary for Windows
curl --fail --location --output quickdeploy.exe https://quickdeploy.dev/api/download/windows-amd64

Only continue if the download succeeds. This binary is for x86_64 Windows; a native Windows ARM64 binary is not provided here.

  1. Create a bin directory and move the binary there (one-time setup)
mkdir "%USERPROFILE%\bin"
move /Y quickdeploy.exe "%USERPROFILE%\bin\quickdeploy.exe"
  1. Add the directory to your PATH (if not already added)
    You can do this by pressing the Windows key and typing "env" and then clicking on "Edit the system environment variables".
  2. Open a new terminal and verify:
quickdeploy --version

If installation fails

  • Download returns an HTTP error: stop and retry later or contact support. curl --fail reports the error instead of treating the response as a successful download.
  • Permission denied when installing: use the complete sudo install -m 755 command above. It sets permissions while copying the file into /usr/local/bin.
  • Command not found: check that /usr/local/bin (Linux/macOS) or %USERPROFILE%\bin (Windows) is in your PATH, then open a new terminal. On Linux/macOS, /usr/local/bin/quickdeploy --version checks the installed file directly.
  • Exec format error or bad CPU type: download the binary matching your operating system and CPU architecture.

Once the version check succeeds, check whether your app and server fit. Ready to deploy? Get the one-time €15 license, then follow the configuration steps above. Your VPS and domain are paid separately.

Important Notes

On Windows and macOS you might need to allow the binary to be executed and give it a exception from your security settings.

Previous
Requirements