yarmak/nth-dump repository overview

⁠nth-dump

nthLink API client. Retrieves shadowsocks servers and credentials. Can generate SIP-002 compatible URLs and QR codes corresponding to such URLs.

⁠Features

• Plug and Play approach: bring your favorite shadowsocks client!
• Cross-platform (Windows/Mac OS/Linux/Android (via shell)/*BSD)
• Zero configuration
• Simple and straightforward

⁠Installation

⁠Binaries

Pre-built binaries are available here⁠.

⁠Build from source

Alternatively, you may install nth-dump from source. Run the following within the source directory:

make install

⁠Docker

docker run -it --rm yarmak/nth-dump

⁠Usage

Just run binary and it will output credentials.

⁠Synopsis

$ nth-dump -h
Usage of /home/user/go/bin/nth-dump:
  -format string
    	output format: text, raw, json (default "text")
  -noqr
    	do not print QR code with URL
  -nowait
    	do not wait for key press after output (default true)
  -timeout duration
    	operation timeout (default 10s)
  -version
    	show program version and exit