Git Product home page Git Product logo

clashy's Introduction

Clash
Clashy

A GUI proxy client for Windows / macOS / Ubuntu Desktop based on Clash and Electron

Features

  • Easy to use interface.
  • Build-in Clash binary.
  • GUI configuration.
  • Remote subscription support.
  • Server speed test.
  • Set as system proxy (Windows & macOS only).
  • Start with system.

Installation

Download latest release from Release Page

If you meet binary singing issue on Apple & Windows operating system.

Check "Sign Issue" for more information.

Screenshots

status proxies
profile settings

Build

  • Clone this project & run yarn install
  • Run node pre-build.js to download clash binary for current platform.
  • Run yarn start to start dev server for webpage.
  • Run yarn start:electron to start electron main process. Or hit run button in VSCode.

Pack

  • Run yarn run pack and wait.

Configuration

  • Where is my configuration files & how can I modify them?

    To check your configuration files for Clash & Clashy, click on the folder icon in status panel. Clash configuration file folder will opened automatically and navigate to parent folder you will see Clashy configuration files named clashy-configs.

  • Can I change clash external controller port & secrets in configuration file?

    You can but you need to modify Clashy's source code to make it work.

Roadmap & TODOs

  • Auto update
  • Post build script to zip binaries
  • Reset system proxy after exit app
  • Logout current clash client
  • Use external clash binary
  • Login interface for external clash binary
  • Clash binary update
  • View Clash logs
  • Subscription auto-update

Contribution

Any pull request is welcome.

FAQ

Is this a copycat of ClashX or Clash for Windows?

Not exactly. I've been using ClashX for several months and I like it. It's easy to use and nicely designed. But I also need a decent Clash client on my Ubuntu Desktop. And the interface must be easy enough for anyone to use because I don't want to teach my wife how to edit proxy rules or how to use remote configuration files. So I decide to make my own Clash GUI client. I did NOT take any code or assets from those two projects but they did give me some ideas about interface design and implementation.

How can I check Clash's logs in Clashy ?

You can't for now. Visit 127.0.0.1:2390/logs for Clash logs.

Is timeouted proxy means the proxy is unavailable?

Not really. Clashy use Clash's /delay API for speed testing. This API requires a parameter which indicates speed test timeout. This parameter is 10 seconds in current build. So there are two kinds of timeout in Clashy:

  • Proxy timeout, which means proxy is unavailable.
  • Clash speed test timeout, which means Clash waited more than 10 seconds but still no response from target server (which is https://www.google.com). This proxy might be available with a huge delay. Or unavailable at all.

Sadly, I can't distinct those two timeout types with current Clash API.

I don't like Electron.

Me either. Checkout Electron memes below!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.