clash-nyanpasu README

The project's README from github.com/libnyanpasu/clash-nyanpasu. As one markdown file: README.md.

Clash Nyanpasu Banner

Clash Nyanpasu

A Clash GUI based on Tauri.

Nyanpasu Release Dev Build Status Nyanpasu Stars GitHub Downloads (all assets, all releases) Nyanpasu License Nyanpasu Twitter Ask DeepWiki

Features

Preview

preview-light

preview-dark

Development

Configure your development environment

You should install Rust and Node.js, 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 prepare:check --force

pnpm prepare: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:

Contributors

Contributors

License

GPL-3.0 License. See License here for details.

clash-nyanpasu (libnyanpasu/clash-nyanpasu)

Searching Database…

What is this?Clash Nyanpasu is a desktop GUI client for Clash-family proxy kernels (Clash Premium, Mihomo, Clash Rust, and Meow), letting you manage proxy profiles and rules through a visual interface.
Is this a library or an app I run?It's a native desktop app built with Tauri, combining a Rust backend with a React frontend, not a CLI tool or library.
How do I get it running from source?Install Rust and Node.js, use pnpm to install the Node packages, download the Clash kernel binary and other dependencies, then run the dev or build scripts.
What do I need installed before building it?You need Rust, Node.js, and the pnpm package manager; the Clash kernel binary itself is fetched as a separate step during setup.
Which operating systems does it run on?It targets Windows, macOS, and Linux, the same platform set as the Clash Verge projects it builds on.
What formats can I use to write proxy profiles?Profiles can be written and enhanced using YAML, JavaScript, or Lua scripts, so you can add conditional logic beyond a plain config file.
Does it support proxy provider management?Yes, in addition to managing your own profiles it supports managing proxy providers.
Why does the UI look different from other Clash GUIs?It uses Google's Material You design system with its animations, giving it a distinct look compared to other Clash front-ends.
What other projects is this based on?It credits and builds on clash-verge, clash-verge-rev, Mihomo, Watfaq's clash-rs, and madeye's Rust-based meow-rs kernel, combining their ideas into one Tauri app.
Size
59.9 MB
Stars
13.2K
Age
2y
Commits · 90 Days