Installation & Setup Guide

★

Method 1: 1-Click Installer (Recommended)

Novice Friendly

No need to manage Python environments manually. Open your terminal (Terminal on macOS or your Linux shell) and paste this single command:

curl -fsSL https://raw.githubusercontent.com/fakhruldeen/LocalPilot/main/install-localpilot.sh | bash

What this does:

Installs LocalPilot in your user space without asking for root (sudo).
Symlinks the executable to ~/.local/bin/localpilot.
Ensures all dependencies are isolated so your system packages remain untouched.

2

Alternative Methods (pipx or pip)

📦 With pipx (Isolated App)

If you have pipx installed, this installs LocalPilot inside its own sandbox automatically:

pipx install localpilot

🐍 With standard pip

For developers and virtual environments:

pip install localpilot

3

Installation Scopes Explained

LocalPilot supports three clean installation scopes so you have complete control over where files reside:

🏠 1. User-Space (Recommended Default)

Installed in your home directory (~/.local/). Does not require administrator privileges, cannot affect other users on the machine, and is completely isolated.

📦 2. Isolated Project Directory

Created inside a dedicated folder or virtual environment. Ideal if you are testing or want to keep LocalPilot contained within a specific project folder.

🏢 3. System-Wide

Available to all users on the operating system. Requires administrator permissions (sudo) and is typically used for shared multi-user workstations.

4

Updating & Clean Removal

🔄 How to Update

To get the newest model compatibility definitions and performance fixes:

localpilot update

🧹 100% Clean Uninstall

If you ever want to remove LocalPilot and reclaim all disk space:

pipx uninstall localpilot
rm -rf ~/.local/share/localpilot

Zero hidden files or lingering background daemons left behind.