DocsGetting StartedInstallation
Back to Docs
Getting Started

Installation

Install YeePilot quickly, verify your setup, and start your first secure agent session.

Last updated: March 1, 2026

Quick Install

Install YeePilot with the official installer:

bash
curl -fsSL https://yee.to/install.sh | bash

This installs the correct binary for your platform and adds it to your PATH.

Supported Platforms

YeePilot ships native binaries for:

  • Linux (amd64, arm64)
  • macOS (amd64, arm64)
  • Windows (amd64, arm64)

Verify Installation

bash
yeepilot version

You should see version/build metadata.

First Setup

Run the setup wizard:

bash
yeepilot setup

The wizard configures:

  • AI provider and model
  • API credentials
  • language/preferences
  • platform authentication linkage

If you only need to manage platform login later:

bash
yeepilot setup --auth

Start Using YeePilot

Interactive TUI session:

bash
yeepilot
yeepilot run

Short alias (when installed with the official installer, which creates yee -> yeepilot):

bash
yee

One-shot execution:

bash
yeepilot exec "show the largest files in this repository"
yee exec "show the largest files in this repository"

Manual Update and Uninstall

Update to latest release:

bash
yeepilot update

Check availability without installing:

bash
yeepilot update --check

Rollback to previous binary:

bash
yeepilot update --rollback

Uninstall options:

bash
yeepilot uninstall --all
yeepilot uninstall --keep-config
yeepilot uninstall --binary-only