> ## Documentation Index
> Fetch the complete documentation index at: https://soul-lang.com/llms.txt
> Use this file to discover all available pages before exploring further.

# How to Install

> Install Soul programming language on your system

## Quick Install

The fastest way to install Soul is using our installation scripts.

### macOS / Linux

Open your terminal and run:

```bash theme={null}
sh <(curl -fsSL https://soul-lang.com/install.sh)
```

Or with wget:

```bash theme={null}
sh <(wget -qO- https://soul-lang.com/install.sh)
```

### Windows

Open PowerShell as Administrator and run:

```powershell theme={null}
iwr -useb https://soul-lang.com/install.ps1 | iex
```

## Manual Installation

If you prefer to install manually, follow these steps:

### 1. Download the Latest Release

Check the latest version at: [https://github.com/gantz-ai/soul-release/blob/main/latest.txt](https://github.com/gantz-ai/soul-release/blob/main/latest.txt)

Download the appropriate archive for your platform:

<CardGroup cols={2}>
  <Card title="macOS (Apple Silicon)" icon="apple">
    ```
    mac/soul-VERSION-darwin-arm64.tar.gz
    ```
  </Card>

  <Card title="macOS (Intel)" icon="apple">
    ```
    mac/soul-VERSION-darwin-amd64.tar.gz
    ```
  </Card>

  <Card title="Linux" icon="linux">
    ```
    linux/soul-VERSION-linux-amd64.tar.gz
    ```
  </Card>

  <Card title="Windows" icon="windows">
    ```
    windows/soul-VERSION-windows-amd64.zip
    ```
  </Card>
</CardGroup>

### 2. Extract the Archive

<Tabs>
  <Tab title="macOS/Linux">
    ```bash theme={null}
    tar -xzf soul-VERSION-PLATFORM.tar.gz
    ```
  </Tab>

  <Tab title="Windows">
    Extract the ZIP file using Windows Explorer or:

    ```powershell theme={null}
    Expand-Archive soul-VERSION-windows-amd64.zip
    ```
  </Tab>
</Tabs>

### 3. Install the Binary

<Tabs>
  <Tab title="macOS/Linux">
    ```bash theme={null}
    # Rename to soul
    mv soul-VERSION soul

    # Make executable
    chmod +x soul

    # Move to PATH
    sudo mv soul /usr/local/bin/
    ```
  </Tab>

  <Tab title="Windows">
    1. Rename `soul-VERSION.exe` to `soul.exe`
    2. Move to a directory in your PATH, or:
    3. Add the directory containing `soul.exe` to your PATH environment variable
  </Tab>
</Tabs>

## Verify Installation

After installation, verify Soul is working:

```bash theme={null}
soul version
```

You should see output like:

```
Soul 1.0.0
```

## Installation Locations

<Tabs>
  <Tab title="macOS/Linux">
    Soul is installed to `/usr/local/bin/soul`

    If you need to uninstall:

    ```bash theme={null}
    sudo rm /usr/local/bin/soul
    ```
  </Tab>

  <Tab title="Windows">
    Soul is installed to `%USERPROFILE%\.soul\bin\soul.exe`

    This directory is automatically added to your PATH.
  </Tab>
</Tabs>

## Updating Soul

Soul includes a built-in update command:

```bash theme={null}
# Check for updates and install if available
soul update

# Check for updates without installing
soul update --dry-run
```

## Troubleshooting

<AccordionGroup>
  <Accordion title="Permission denied on macOS/Linux">
    If you get a permission error during installation, make sure to use `sudo`:

    ```bash theme={null}
    sudo mv soul /usr/local/bin/
    ```
  </Accordion>

  <Accordion title="Command not found">
    If `soul` command is not found after installation:

    **macOS/Linux**: Add to your shell profile:

    ```bash theme={null}
    export PATH="$PATH:/usr/local/bin"
    ```

    **Windows**: Restart your terminal or run:

    ```powershell theme={null}
    refreshenv
    ```
  </Accordion>

  <Accordion title="macOS security warning">
    If macOS blocks the executable, run:

    ```bash theme={null}
    xattr -d com.apple.quarantine /usr/local/bin/soul
    ```
  </Accordion>
</AccordionGroup>

## Next Steps

<CardGroup>
  <Card title="Getting Started" icon="rocket" href="/getting-started">
    Learn the basics of Soul programming
  </Card>

  <Card title="Language Guide" icon="book" href="/language-guide">
    Explore Soul language features
  </Card>

  <Card title="Examples" icon="code" href="/examples">
    See Soul in action with examples
  </Card>
</CardGroup>