Skip to main content

​
Installation

​
Homebrew (macOS/Linux)

brew tap theognis1002/lightfold
brew install lightfold

​
Manual Installation

Download Pre-built Binary: Visit the releases page and download the binary for your platform. Build from Source: 
git clone https://github.com/theognis1002/lightfold-cli.git
cd lightfold-cli
make build
sudo make install

​
First Deployment

1

Navigate to your project

cd your-project
2

Run deploy

lightfold deploy
Lightfold will:
  • Auto-detect your framework
  • Prompt you to select a cloud provider
  • Create infrastructure
  • Configure the server
  • Deploy your app
3

Access your app

Your app will be live at the IP address shown in the output.

​
Provider Setup

Lightfold supports multiple cloud providers. You’ll need an API token for automated provisioning.
  1. Create a DigitalOcean account
  2. Generate an API token in API settings
  3. Run: lightfold config set-token digitalocean
  1. Create a Vultr account
  2. Generate an API key in API settings
  3. Run: lightfold config set-token vultr
  1. Create a Hetzner Cloud account
  2. Generate an API token in API tokens
  3. Run: lightfold config set-token hetzner
  1. Create a Linode account
  2. Generate an API token in API Tokens
  3. Run: lightfold config set-token linode
  1. Create a Fly.io account
  2. Install flyctl: curl -L https://fly.io/install.sh | sh
  3. Generate token: fly auth token
  4. Run: lightfold config set-token flyio
Already have a server? Use BYOS mode:
lightfold create --provider byos --ip YOUR_IP --user YOUR_USER --ssh-key ~/.ssh/id_rsa

​
Next Steps

Commands

Learn about all available commands

Deployment Guide

Understand the deployment flow

Configuration

Customize your deployments

Supported Frameworks

See all supported frameworks