Installation

How to install FrankenDeploy on your system

Homebrew (macOS, Linux)

The easiest way to install and keep FrankenDeploy up to date:

brew install yoanbernabeu/tap/frankendeploy

Later, brew upgrade frankendeploy follows the releases.

Install Script

curl -fsSL https://raw.githubusercontent.com/yoanbernabeu/frankendeploy/main/scripts/install.sh | sh

This script automatically detects your OS and architecture and installs the latest version.

Using Go

If you have Go 1.24+ installed:

go install github.com/yoanbernabeu/frankendeploy/cmd/frankendeploy@latest

Manual Download

Download the binary for your platform from the GitHub Releases page. Archive names include the version number, e.g. frankendeploy_0.10.0_linux_amd64.tar.gz.

Linux (amd64)

VERSION=0.16.0  # See https://github.com/yoanbernabeu/frankendeploy/releases/latest
curl -LO https://github.com/yoanbernabeu/frankendeploy/releases/download/v${VERSION}/frankendeploy_${VERSION}_linux_amd64.tar.gz
tar -xzf frankendeploy_${VERSION}_linux_amd64.tar.gz
sudo mv frankendeploy /usr/local/bin/

macOS (Apple Silicon)

VERSION=0.16.0  # See https://github.com/yoanbernabeu/frankendeploy/releases/latest
curl -LO https://github.com/yoanbernabeu/frankendeploy/releases/download/v${VERSION}/frankendeploy_${VERSION}_darwin_arm64.tar.gz
tar -xzf frankendeploy_${VERSION}_darwin_arm64.tar.gz
sudo mv frankendeploy /usr/local/bin/

Windows

Download frankendeploy_<version>_windows_amd64.zip and add it to your PATH.

Verify Installation

frankendeploy --version

Requirements

For Local Development

  • Docker - Required for running containers locally
  • Docker Compose - Usually included with Docker Desktop

For Deployment

  • SSH access to your VPS
  • SSH key for authentication

Next Steps