Skip to content

coolcoala/koala-clash

 
 

Repository files navigation

Koala Clash

Clash

GUI client for Mihomo

Features

  • Out-of-the-box Tun mode without service mode
  • Multiple color themes
  • Support for most Mihomo configuration options
  • Built-in Mihomo cores (stable and alpha)

Screenshots

Preview

Development

Requirements

  • Node.js >= 20.0.0
  • pnpm >= 9.0.0
  • Git

Tech Stack

Koala Clash is built with Electron + React + TypeScript.

Frontend: React 19, shadcn/UI, Tailwind CSS, Monaco Editor

Backend: Electron, Mihomo Core, sysproxy-go

Quick Start

git clone https://github.com/coolcoala/koala-clash.git
cd koala-clash
pnpm install
pnpm dev

If Electron fails to install:

cd node_modules/electron && node install.js && cd ../..

Project Structure

src/
├── main/               # Electron main process
│   ├── core/           # Mihomo core management
│   ├── config/         # Configuration management
│   ├── resolve/        # Tray, shortcuts, auto-updater, floating window
│   ├── sys/            # System integration (sysproxy, autorun)
│   └── utils/          # Utilities
├── renderer/           # React frontend
│   └── src/
│       ├── components/ # React components
│       ├── pages/      # Page components
│       ├── hooks/      # Hooks and context providers
│       └── utils/      # Frontend utilities
├── preload/            # Preload scripts (IPC bridge)
└── shared/types/       # Shared TypeScript types

Commands

Command Description
pnpm dev Start dev server (renderer hot reloads, main requires restart)
pnpm lint Run ESLint
pnpm format Run Prettier
pnpm typecheck TypeScript type checking
pnpm build:win Build for Windows
pnpm build:mac Build for macOS
pnpm build:linux Build for Linux

Architecture and format can be specified via flags:

pnpm build:win nsis --x64
pnpm build:mac pkg --arm64
pnpm build:linux deb --x64

Build Artifacts

  • Windows: .exe (NSIS installer), .7z (portable)
  • macOS: .pkg
  • Linux: .deb, .rpm, .pkg.tar.xz (pacman)

Credits

Based on Sparkle by xishang0128.

About

A modern GUI client based on Electron, designed to run in Windows, macOS and Linux for tailored proxy experience

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages

  • TypeScript 98.7%
  • Other 1.3%