nth-dump

module
v1.5.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 1, 2022 License: MIT

README

nth-dump

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

Screenshot

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")
  -load-profile string
    	load JSON with settings profile from file
  -noqr
    	do not print QR code with URL
  -nowait
    	do not wait for key press after output (default true)
  -profile string
    	secrets and constants profile (android/win/mac/ios) (default "android")
  -save-profile string
    	save JSON profile for chosen configuration and exit
  -timeout duration
    	operation timeout (default 30s)
  -url-format string
    	output URL format: sip002, sip002u, sip002qs (default "sip002")
  -version
    	show program version and exit

Directories

Path Synopsis
cmd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL