> For the complete documentation index, see [llms.txt](https://orbitron.gitbook.io/orbitron-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://orbitron.gitbook.io/orbitron-docs/user-guide/installation.md).

# Installation

Orbitron Context can be installed easily via an automated installation script or by manually downloading the appropriate binary for your operating system and architecture. This section provides installation instructions for macOS, Linux, and Windows users.

You can also find the latest builds on the [Orbitron Download Page](https://orbitron.megaone.com/download).

<figure><img src="/files/JewI30S2fR9vqXH0MAV0" alt=""><figcaption></figcaption></figure>

## 🚀 Quick Install (Recommended)

The automated installation script is the fastest and easiest way to get started:

### 🖥 macOS / 🐧 Linux

```bash
curl -fsSL https://orbitron.megaone.com/api/install.sh | bash
```

### 🪟 Windows (PowerShell)

```powershell
irm https://orbitron.megaone.com/api/install.ps1 | iex
```

### ✨ What the Auto-Installer Does

The automated installation script handles the following automatically:

1. **Detection** - Automatically detects your operating system and architecture
2. **Download** - Downloads the latest Orbitron binary
3. **Installation** - Installs to `~/.local/bin/orbitron` with version management
4. **PATH Configuration** - Automatically configures your shell PATH
5. **Auto-Update Setup** - Interactive prompt to enable auto-updates (optional)
6. **Legacy Migration** - Offers migration if an old installation is detected (requires user approval)

After installation completes, restart your terminal and verify:

```bash
orbitron --help
```

> **Note:** If you have a previous version installed, the installer will automatically detect it and offer an interactive migration. See the [Migration Guide](/orbitron-docs/user-guide/installation/migration-guide.md) for details.

## 📦 Manual Download (Not Recommended)

You can also download the binary directly and run it from anywhere.

> **Optional Setup**: After downloading, you can run `./orbitron install` to enable auto-update support and automatic PATH configuration. This step is optional but recommended.

### 🖥 macOS

#### Apple Silicon (M1, M2, M3, M4)

```bash
curl -L -o orbitron https://d160u887c48md2.cloudfront.net/latest/orbitron-macos-arm64
chmod +x orbitron

# Optional: Enable auto-update support
./orbitron install
```

#### Intel (x86\_64)

```bash
curl -L -o orbitron https://d160u887c48md2.cloudfront.net/latest/orbitron-macos-x86_64
chmod +x orbitron

# Optional: Enable auto-update support
./orbitron install
```

### 🐧 Linux

#### AMD64 (x86\_64)

```bash
curl -L -o orbitron https://d160u887c48md2.cloudfront.net/latest/orbitron-linux-x86_64
chmod +x orbitron

# Optional: Enable auto-update support
./orbitron install
```

#### ARM64 (e.g., Raspberry Pi, ARM-based server)

```bash
curl -L -o orbitron https://d160u887c48md2.cloudfront.net/latest/orbitron-linux-arm64
chmod +x orbitron

# Optional: Enable auto-update support
./orbitron install
```

### 🪟 Windows

```powershell
Invoke-WebRequest -Uri "https://d160u887c48md2.cloudfront.net/latest/orbitron-windows-x86_64.exe" -OutFile "orbitron.exe"

# Optional: Enable auto-update support
.\orbitron.exe install
```

### ✅ Verify Installation

After downloading, verify the installation by running:

```bash
# Unix/Linux/macOS
./orbitron --help

# Windows
.\orbitron.exe --help
```

***

## 🔄 Auto-Update

> **Supported Versions:** v0.1.13 and later

Orbitron includes a built-in auto-update system that keeps your installation up-to-date automatically.

### Key Features

* **Default:** Auto-update prompts during installation; defaults to disabled if not selected
* **Check Frequency:** Checks every 6 hours when enabled
* **Update Method:** Downloads in the background and automatically switches to the upgraded version on next execution

### Enable/Disable Auto-Update

```bash
# Enable auto-update
orbitron config set autoUpdate true

# Disable auto-update
orbitron config set autoUpdate false

# Check current setting
orbitron config get autoUpdate
```

For more details, see the [Auto-Update Guide](/orbitron-docs/user-guide/installation/auto-update.md).

***

## 🎯 Platform Support Summary

| Platform | Architecture | Binary Name                   | Auto-Update |
| -------- | ------------ | ----------------------------- | ----------- |
| macOS    | ARM64        | `orbitron-macos-arm64`        | ✅           |
| macOS    | x86\_64      | `orbitron-macos-x86_64`       | ✅           |
| Linux    | ARM64        | `orbitron-linux-arm64`        | ✅           |
| Linux    | x86\_64      | `orbitron-linux-x86_64`       | ✅           |
| Windows  | x86\_64      | `orbitron-windows-x86_64.exe` | ✅           |

***

## ✅ Next Steps

Once installed, you can begin using Orbitron with:

```bash
orbitron --help
```

To get started quickly:

```bash
# Login to Orbitron
orbitron login

# Use Orbitron in your project
cd /path/to/your/project
orbitron
```