README.md

ClashYamlParser

提供类似Clash for Windows中parser功能的服务器应用程序。| A server application provides clash parser feature likes Clash for Windows. (切换到中文文档)

Feature

• parsers

  • prepend-rlues
  • append-rules
  • prepend-proxies
  • append-proxies
  • prepend-proxy-groups
  • append-proxy-groups
  • mix-proxy-providers
  • mix-rule-providers
  • mix-object
  • command

• misc

  • Subscription-Userinfo (shows usage and expire in Clash for Windows)
  • server log
  • SSL connection (HTTPS)

Dependencies and Compatibility

• .NET 8.0 Runtime is required.
• Only tested under Windows 11 and Windows Server 2012. Theoretically, it has full platform compatibility.
• Only tested with Clash for Windows and Clash for Android. Theoretically compatible with all branch versions of clash.

How to use

All path mentioned following are relative to the root folder of the ClashYamlParser.exe.

• Download the latest release file.
• Setup domain.txt with the domain you want to bind, the format refer to Microsoft Learn, one line per domain.
• Copy your clash parsers config from Clash for Windows, and create the file parser.yaml with it.
• (If SSL connection needed) Bind the cert with the port using netsh tool.
• Run ClashYamlParser.exe with Administrator permission.
• Subcribe the profile via URL. Example: http(s)://example.com:port/clash/?url=your origin clash profile url.
• (Optional)Add black list: Add blacklist.txt under excutepath, list your blacklist source one each line.(Only http(s)link is supported, and all domain names in the list file that comply with domain name rules will be added to the blacklist.)

How to contribute

Issues and pull requests are both welcome, pull requests prefered.

Third party code list

• YamlDotNet(15.3.0)

  Licensed under MIT license.

• ChatGPT4

  Partial code generated by ChatGPT4.