Skip to content

mapleafgo/singcast-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

198 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Singcast

Singcast

Dual-Format Proxy Core — Clash & sing-box Config, sing-box Engine

English | 中文

A lightweight proxy core powered by sing-box. Accepts both Clash Meta (Mihomo) YAML and sing-box JSON configurations — automatically translating Clash configs at runtime while running everything through the high-performance sing-box engine.

Features

  • Clash → sing-box Translation — Automatically converts Mihomo YAML to sing-box JSON at startup
  • Native sing-box JSON — Also accepts sing-box configs directly, no translation needed
  • Multi-Protocol — VLESS, VMess, Shadowsocks, Trojan, Hysteria2, TUIC, WireGuard, SOCKS5, HTTP, AnyTLS
  • Auto Routing — GeoIP/GeoSite-based routing with country detection
  • Daemon Mode — Background process with PID file and signal-based reload

CLI

# Start proxy service
singcast run -c config.yaml

# Run as daemon
singcast run -c config.yaml -d

# With rule-set download proxy
singcast run -c config.yaml -p https://gh-proxy.org

# Translate YAML to sing-box JSON
singcast convert -c config.yaml -o output.json

# Validate config
singcast check -c config.yaml

# Show version
singcast version

run Flags

Flag Alias Description
--config -c Config file path (YAML or JSON)
--daemon -d Run as daemon (fork to background)
--api Override external-controller address
--home Home directory (default ~/.singcast)
--rule-set-proxy -p URL prefix for rule-set downloads

Environment variable SINGCAST_RULE_SET_PROXY can also set the rule-set proxy.

Signals

  • SIGHUP — Reload config (Unix only)
  • SIGINT / SIGTERM — Graceful shutdown

Build

Task is required.

# CLI for current platform
task cli

# CLI for all platforms
task cli-all

# FFI shared library (desktop)
task ffi-darwin-arm64
task ffi-linux-amd64
task ffi-windows-amd64

# FFI shared library (mobile)
task ffi-android-arm64
task ffi-ios-arm64

# All targets
task all

Build tags: with_clash_api,with_utls,with_quic,with_gvisor

License

GPL-3.0

About

Dual-Format Proxy Core — Clash & sing-box Config, sing-box Engine

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages