https://github.com/obgnail/clash-api

clash restful API
https://github.com/obgnail/clash-api

clash clashapi golang restful-api

Last synced: 2 months ago
JSON representation

clash restful API

• Host: GitHub
• URL: https://github.com/obgnail/clash-api
• Owner: obgnail
• License: mit
• Created: 2023-05-23T06:51:15.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-04-03T13:19:39.000Z (9 months ago)
• Last Synced: 2024-09-27T09:01:30.398Z (3 months ago)
• Topics: clash, clashapi, golang, restful-api
• Language: Go
• Homepage:
• Size: 105 KB
• Stars: 15
• Watchers: 1
• Forks: 9
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# clash api



    



本项目是 [Clash RESTful API](https://clash.gitbook.io/doc) 的 golang 实现。我丢，搬砖活。

## Introduction

> Clash RESTful API 是一套控制 Clash 的一个途径，能获取 Clash 中的一些信息，同时也能控制 Clash 内部的配置。基于 API，可以打造自己的可视化操作部分，也是实现 Clash GUI 的重要组成部分。—— Clash doc

因为 new bing 需要用到香港节点，我平常也不用此节点，于是整了个自动切换脚本。开源 RESTful API 部分。

## API

```go

// 默认url为http://127.0.0.1:9090，如需修改，请调用此函数

func SetURL(URL string) {}

// 设置密钥(调用业务接口前必须调用此接口)

func SetSecret(sec string) {}

func SetSecretFromEnv(name string) error {}

func SetSecretFromFile(file string) error {}

// 监控请求日志

func GetLogs(level LogLevel) (chan *Log, error) {}

// 每秒推送一次，上下载流量

func GetTraffic(handler func(traffic *Traffic) (stop bool)) error {}

// 节点列表

func GetProxies() (map[string]*Proxies, error) {}

// 具体节点的信息

func GetProxyMessage(name string) (*Proxy, error) {}

// 测试具体节点的延时

func GetProxyDelay(name string, url string, timeout int) (*ProxyDelay, error) {}

// 切换节点

func SwitchProxy(selector, name string) error {}

// 获取配置

func GetConfig() (*Config, error) {}

// 设置配置

func SetConfig(port, socksPort int, redirPort string, allowLan bool, mode, logLevel string) error {}

// 应用配置(不会影响 external-controller 和 secret 的值)

func EnableConfig(path string) error {}

// PAC rules

func GetRules() ([]*Rule, error) {}

```

 

## Example

```go

package main

import (

	"fmt"

	"github.com/obgnail/clash-api/clash"

)

func main() {

	if err := clash.SetSecretFromFile("./secret.txt"); err != nil {

		panic(err)

	}

	proxies, err := clash.GetProxies()

	if err != nil {

		panic(err)

	}

	fmt.Println(proxies)

}

```

## Processing

- [x] 支持 Meta (mihomo) 内核 API

  > 以最新 Meta Alpha 内核及 Metacubexd 的代码实现为准，Meta Wiki 为辅