---
title: Installation Guide
description: How to download and install Sub-CLI on your system
---

# Installation Guide

Follow these simple steps to get Sub-CLI up and running on your computer.

## Download the Right Version

Sub-CLI is available for various operating systems and architectures. Visit the [Releases](https://git.owu.one/wholetrans/sub-cli/releases) page to download the appropriate version for your system.

### Understanding Which Version to Download

The release files are named following this pattern:

```
sub-cli-[OS]-[ARCHITECTURE][.exe]
```

Where:
- **OS** is your operating system (windows, darwin, linux)
- **ARCHITECTURE** is your computer's processor type (amd64, arm64)
- The `.exe` extension is only present for Windows versions

### Which Version Do I Need?

Here's a simple guide to help you choose:

| Operating System | Processor Type | Download File |
|------------------|----------------|---------------|
| Windows | Intel/AMD (most PCs) | `sub-cli-windows-amd64.exe` |
| Windows | ARM (Surface Pro X, etc.) | `sub-cli-windows-arm64.exe` |
| macOS | Intel Mac | `sub-cli-darwin-amd64` |
| macOS | Apple Silicon (M series processors) | `sub-cli-darwin-arm64` |
| Linux | Intel/AMD (most PCs/servers) | `sub-cli-linux-amd64` |
| Linux | ARM (Raspberry Pi, ARM-based VPS, etc.) | `sub-cli-linux-arm64` |

If you're unsure about your system architecture, most modern computers use amd64 (also known as x86_64) architecture.

## Installation Steps

::: tip

For temporary use, place the sub-cli binary in the current directory or any location you prefer, without adding it to the PATH.

:::

### Windows

1. Download the appropriate `.exe` file from the Releases page
2. Move the file to a location of your choice (e.g., `C:\Users\[username]\bin\`)
3. (Optional) Add the folder to your PATH environment variable to run Sub-CLI from any location:
   - Right-click on "This PC" and select "Properties"
   - Click on "Advanced system settings"
   - Click on "Environment Variables"
   - Under "System variables", find the "Path" variable, select it and click "Edit"
   - Click "New" and add the path to the folder containing the Sub-CLI executable
   - Click "OK" on all dialog boxes to save the changes

### macOS (Darwin)

1. Download the appropriate file from the Releases page
2. Open Terminal
3. Make the file executable with the command:
   ```bash
   chmod +x path/to/downloaded/sub-cli-darwin-[architecture]
   ```
4. (Optional) Move it to a location in your PATH for easier access:
   ```bash
   sudo mv path/to/downloaded/sub-cli-darwin-[architecture] ~/.local/bin/sub-cli
   ```

### Linux

1. Download the appropriate file from the Releases page
2. Open Terminal
3. Make the file executable with the command:
   ```bash
   chmod +x path/to/downloaded/sub-cli-linux-[architecture]
   ```
4. (Optional) Move it to a location in your PATH for easier access:
   ```bash
   sudo mv path/to/downloaded/sub-cli-linux-[architecture] ~/.local/bin/sub-cli
   ```

## Verifying Installation

To verify that Sub-CLI is installed correctly, open a command prompt or terminal and run:

```bash
sub-cli version
```

You should see the current version number of Sub-CLI displayed.

## Troubleshooting

If you encounter any issues during installation:

- Make sure you've downloaded the correct version for your operating system and architecture
- Ensure the file has executable permissions (on macOS and Linux)
- Verify that the file is in a location accessible by your command prompt or terminal
- If you've added it to PATH, try restarting your command prompt or terminal

For further assistance, please visit our [feedback page](/feedback) to report the issue.