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
Ubuntu 20.04+, Debian 11+, Fedora 35+
8GB RAM minimum (16GB recommended)
20GB free disk space
Docker Engine
Windows 10/11 with WSL2
8GB RAM minimum (16GB recommended)
20GB free disk space
Docker Desktop for Windows
Quick Install
The fastest way to install LocalCloud:
# Install using Homebrew
brew install localcloud-sh/tap/localcloud
# Universal install script
curl -fsSL https://localcloud.sh/install | bash
This script will:
Detect your operating system
Use Homebrew if available (macOS)
Download the appropriate binary
Install it to /usr/local/bin
Create the lc alias
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
Apple Silicon (M1/M2/M3) :# Download and extract
curl -L https://localcloud.sh/releases/darwin-arm64 | tar xz
# Install
sudo install -m 755 localcloud-darwin-arm64 /usr/local/bin/localcloud
sudo ln -sf /usr/local/bin/localcloud /usr/local/bin/lc
# Verify installation
lc --version
Intel Mac :# Download and extract
curl -L https://localcloud.sh/releases/darwin-amd64 | tar xz
# Install
sudo install -m 755 localcloud-darwin-amd64 /usr/local/bin/localcloud
sudo ln -sf /usr/local/bin/localcloud /usr/local/bin/lc
# Verify installation
lc --version
Linux
Homebrew (if installed)
Direct Download
# Install LocalCloud
brew install localcloud-sh/tap/localcloud
# Verify installation
lc --version
AMD64 :# Download and extract
curl -L https://localcloud.sh/releases/linux-amd64 | tar xz
# Install
sudo install -m 755 localcloud-linux-amd64 /usr/local/bin/localcloud
sudo ln -sf /usr/local/bin/localcloud /usr/local/bin/lc
# Verify installation
lc --version
ARM64 :# Download and extract
curl -L https://localcloud.sh/releases/linux-arm64 | tar xz
# Install
sudo install -m 755 localcloud-linux-arm64 /usr/local/bin/localcloud
sudo ln -sf /usr/local/bin/localcloud /usr/local/bin/lc
# Verify installation
lc --version
Windows (WSL2)
Install WSL2
Open PowerShell as Administrator and run:
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
# Add to ~/.zshrc
echo 'source <(lc completion zsh)' >> ~/.zshrc
source ~/.zshrc
# Add to config
lc completion fish > ~/.config/fish/completions/lc.fish
Troubleshooting
Permission denied when installing
The installer needs sudo access to write to /usr/local/bin. You can install to a user directory instead: # Install to home directory
curl -fsSL https://localcloud.sh/install | bash -s -- --prefix= $HOME /.local
# Add to PATH
echo 'export PATH="$HOME/.local/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc
LocalCloud requires Docker. Install it using:
The lc command might not be in your PATH. Try: # Use full command
localcloud --version
# Or add alias manually
echo 'alias lc="localcloud"' >> ~/.bashrc
source ~/.bashrc
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