​
Installation

LocalCloud can be installed on macOS, Linux, and Windows (via WSL2). The installation process takes less than 2 minutes.

​
Prerequisites

LocalCloud requires Docker to manage services. We’ll help you install it if needed.

​
System Requirements

  • macOS 12 (Monterey) or later
  • 8GB RAM minimum (16GB recommended)
  • 20GB free disk space
  • Docker Desktop

​
Quick Install

The fastest way to install LocalCloud: 
# Install using Homebrew
brew install localcloud-sh/tap/localcloud
This script will:
  1. Detect your operating system
  2. Use Homebrew if available (macOS)
  3. Download the appropriate binary
  4. Install it to /usr/local/bin
  5. Create the lc alias
  6. Verify the installation
The installer requires sudo access to install to /usr/local/bin. You’ll be prompted for your password.

​
Manual Installation

​
macOS

# Install LocalCloud
brew install localcloud-sh/tap/localcloud

# Verify installation
lc --version

​
Linux

# Install LocalCloud
brew install localcloud-sh/tap/localcloud

# Verify installation
lc --version

​
Windows (WSL2)

1

Install WSL2

Open PowerShell as Administrator and run:
wsl --install
2

Install Docker Desktop

Download and install Docker Desktop for WindowsEnable WSL2 integration in Docker Desktop settings.
3

Install LocalCloud in WSL

Open WSL terminal and run:
curl -fsSL https://localcloud.sh/install | bash

​
Docker Installation

LocalCloud requires Docker to run services. If you don’t have Docker installed:

​
macOS

Docker Desktop

Official Docker application for macOS

​
Linux

# Install Docker Engine
curl -fsSL https://get.docker.com | sudo bash

# Add your user to docker group
sudo usermod -aG docker $USER

# Start Docker service
sudo systemctl start docker
sudo systemctl enable docker

# Log out and back in for group changes to take effect

​
Verify Docker

# Check Docker is running
docker ps

# Check Docker version
docker --version

​
Post-Installation

​
Verify Installation

# Check LocalCloud version
lc --version

# Run system check
lc doctor
The doctor command will verify:
  • LocalCloud installation
  • Docker availability
  • System resources
  • Network connectivity

​
Shell Completion

Enable tab completion for your shell: 
# Add to ~/.bashrc
echo 'source <(lc completion bash)' >> ~/.bashrc
source ~/.bashrc

​
Troubleshooting

​
Updating LocalCloud

To update to the latest version: 
# Using Homebrew (macOS/Linux)
brew upgrade localcloud

# Using the installer script
curl -fsSL https://localcloud.sh/install | bash

# Or download the latest release directly from:
# https://localcloud.sh/releases

​
Uninstalling

To remove LocalCloud: 
# Using Homebrew
brew uninstall localcloud

# Manual removal
sudo rm /usr/local/bin/localcloud /usr/local/bin/lc

# Remove configuration (optional)
rm -rf ~/.localcloud

# Remove project data (be careful!)
# rm -rf /path/to/your/projects/.localcloud

​
Next Steps

Now that LocalCloud is installed, you’re ready to create your first project!

Quick Start

Create your first LocalCloud project in 5 minutes