clash-verge-rev/README.md

Clash Nyanpasu

A Clash GUI based on tauri.

Features

• Full clash config supported, Partial clash premium config supported.
• Profiles management and enhancement (by yaml and Javascript). Doc
• Simple UI and supports custom theme color.
• Built-in support Clash.Meta core.
• System proxy setting and guard.

Install

Download from release. Supports Windows x64, Linux x86_64 and macOS 11+

Or you can build it yourself. Supports Windows, Linux and macOS 10.15+

Notes: If you could not start the app on Windows, please check that you have Webview2 installed.

FAQ

1. macOS "Clash Nyanpasu" is damaged and can't be opened

open the terminal and run sudo xattr -r -d com.apple.quarantine /Applications/Clash\ Nyanpasu.app

Development

You should install Rust and Nodejs, see here for more details. Then install Nodejs packages.

pnpm i

Then download the clash binary... Or you can download it from clash premium release and rename it according to tauri config.

# force update to latest version
# pnpm run check --force

pnpm run check

Then run

pnpm dev

# run it in another way if app instance exists
pnpm dev:diff

Or you can build it

pnpm build

Todos

This keng is a little big...

Disclaimer

This is a learning project for Rust practice.

Contributions

Issue and PR welcome!

Acknowledgement

Clash Nyanpasu was based on or inspired by these projects and so on:

• zzzgydi/clash-verge: A Clash GUI based on tauri. Supports Windows, macOS and Linux.
• tauri-apps/tauri: Build smaller, faster, and more secure desktop applications with a web frontend.
• Dreamacro/clash: A rule-based tunnel in Go.
• MetaCubeX/Clash.Meta: A rule-based tunnel in Go.
• Fndroid/clash_for_windows_pkg: A Windows/macOS GUI based on Clash.
• vitejs/vite: Next generation frontend tooling. It's fast!

License

GPL-3.0 License. See License here for details.