README.md

Clash Nyanpasu

A Clash GUI based on tauri.

Nyanpasu 1.6.0

Hey there! Guess what? Clash Nyanpasu 1.6.0 is getting a makeover! (▰˘◡˘▰) We're diving into some serious development work, revamping loads of stuff. Think brand-spanking-new Material You UI design, service mode on all platforms, and supercharged scripting powers!

But wait, there's more! We're not just sprucing things up on the surface. Nope, we're also giving the codebase a good scrub, adding tons of comments and organizing things to make it extra cozy for developers.

Exciting, right? (ᗒᗨᗕ)/ Follow this link to stay in the loop with the latest developments. Nyanpasu can't wait to grow and glow with all of you! ε٩(๑> ₃ <)۶з

Features

• Full clash config supported, Partial clash premium config supported.
• Built-in support Clash.Meta core & ClashRs core.
• Profiles management and enhancement (by yaml and Javascript). Doc
• Material You Design UI and amimation support.
• System proxy setting and guard.

Preview

Links

• Install
• FAQ
• Q&A Convention
• How To Ask Questions

Development

Configure your development environment

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

Clash Nyanpasu uses the pnpm package manager. See here for installation instructions. Then, install Node.js packages.

pnpm i

Download the Clash binary & other dependencies

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

pnpm check

Run dev

pnpm dev

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

Build application

pnpm build

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.
• clash-verge-rev/clash-verge-rev: Another fork of Clash Verge. Some patches are included for bug fixes.
• 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.
• ClashRs: A custom protocol, rule based network proxy software.
• Fndroid/clash_for_windows_pkg: A Windows/macOS GUI based on Clash.
• vitejs/vite: Next generation frontend tooling. It's fast!
• mui/material-ui: Ready-to-use foundational React components, free forever.

Contributors

License

GPL-3.0 License. See License here for details.