Installation

Download and install Chat2API on macOS, Windows, and Linux. Supports Apple Silicon, Intel, and modern Linux distributions.

System Requirements

Platform	Requirements
macOS	macOS 10.15 (Catalina) or later, Apple Silicon or Intel
Windows	Windows 10 or later, 64-bit
Linux	Ubuntu 18.04+, Debian 10+, or other modern distributions

Download

Download the latest version from GitHub Releases:

Platform	Download
macOS (Apple Silicon)	`Chat2API-x.x.x-arm64.dmg`
macOS (Intel)	`Chat2API-x.x.x-x64.dmg`
Windows	`Chat2API-x.x.x-x64-setup.exe`
Linux	`Chat2API-x.x.x-x64.AppImage` or `.deb`

Installation Steps

macOS

Download the .dmg file for your architecture (Apple Silicon or Intel)
Open the downloaded file
Drag Chat2API to the Applications folder
Launch Chat2API from Applications

If you see "App is damaged and can't be opened" error, run this command in Terminal:

sudo xattr -rd com.apple.quarantine "/Applications/Chat2API.app"

Windows

Download the .exe installer
Run the installer
Follow the installation wizard
Launch Chat2API from Start Menu or desktop shortcut

Windows may show a SmartScreen warning. Click "More info", then "Run anyway" to proceed.

Linux

AppImage (Recommended)

# Download AppImage
wget https://github.com/xiaoY233/Chat2API/releases/download/v1.0.0/Chat2API-1.0.0-x64.AppImage

# Add execute permission
chmod +x Chat2API-1.0.0-x64.AppImage

# Run
./Chat2API-1.0.0-x64.AppImage

DEB Package (Debian/Ubuntu)

# Download DEB package
wget https://github.com/xiaoY233/Chat2API/releases/download/v1.0.0/Chat2API-1.0.0-x64.deb

# Install
sudo dpkg -i Chat2API-1.0.0-x64.deb

# Fix dependencies if needed
sudo apt-get install -f

Build from Source

Prerequisites

Node.js 18+
npm
Git

Build Steps

# Clone repository
git clone https://github.com/xiaoY233/Chat2API.git
cd Chat2API/Chat2API-Manager

# Install dependencies
npm install

# Start development
npx electron-vite dev 2>&1

Production Build

# Build application
npm run build

# Build for specific platform
npm run build:mac          # macOS (dmg)
npm run build:win          # Windows (nsis)
npm run build:linux        # Linux (AppImage, deb)
npm run build:all          # All platforms

First Launch

After installation, when you first launch Chat2API:

The app will create a data directory at ~/.chat2api/
Default configuration will be generated automatically
You can start adding providers and configuring the proxy

Installation

On this page