Skip to content
This repository has been archived by the owner on Aug 4, 2018. It is now read-only.

CLI help

David Fernández Aldana edited this page Aug 25, 2016 · 1 revision

Builtin Help

Main section

usage: wps-dict-cli.py [-h] [-c]
                   {list_providers,list_tools,generate,update_db} ...

positional arguments:
  {list_providers,list_tools,generate,update_db}

optional arguments:
  -h, --help            show this help message and exit
  -c, --csv             Outputs in a CSV format instead of the standard human-
                        readable output (except for errors and help)

Update database section

usage: wps-dict-cli.py update_db [-h]
                             [--include-providers [PROVIDER [PROVIDER ...]] |
                             --exclude-providers [PROVIDER [PROVIDER ...]]]

optional arguments:
  -h, --help            show this help message and exit
  --include-providers [PROVIDER [PROVIDER ...]]
                        Specify the provider(s) to get the info from or "all" to use them all:
                        Available providers: builtin, goy_script, download_wireless_net, wps_bunker
                        Default: "all"
  --exclude-providers [PROVIDER [PROVIDER ...]]
                        Specify the provider(s) to NOT get the info from or "none" to use them all:
                        Available providers: builtin, goy_script, download_wireless_net, wps_bunker
                        Default: "none"

Generate dictionary section

usage: wps-dict-cli.py generate [-h] [-e ESSID] [-s SERIAL]
                            [--include-tools [TOOL [TOOL ...]] |
                            --exclude-tools [TOOL [TOOL ...]]]
                            [--include-providers [PROVIDER [PROVIDER ...]] |
                            --exclude-providers [PROVIDER [PROVIDER ...]]]
                            bssid

positional arguments:
  bssid                 BSSID in MAC address format
                        (see https://pythonhosted.org/netaddr/tutorial_02.html#formatting for supported formats)

optional arguments:
  -h, --help            show this help message and exit
  -e ESSID, --essid ESSID
  -s SERIAL, --serial SERIAL
  --include-tools [TOOL [TOOL ...]]
                        Specify the tools(s) to generate the pins from, "all" to use all tools or, "none" to NOT
                        use any tools or "auto" to use them depending on the providers:
                        Available tools: dlink_pingen, fte_keygen, trendnetwps, belkin_pingen, easybox, computepin
                        Default: "auto" (chooses the tools to include depending on the bssid, essid and serial)
  --exclude-tools [TOOL [TOOL ...]]
                        Specify the tools(s) to generate the pins from, "all" to NOT use any tools, "none" to use
                        all tools or "auto" to use them depending on the providers
                        Available tools: dlink_pingen, fte_keygen, trendnetwps, belkin_pingen, easybox, computepin
                        Default: "auto" (chooses the tools to exclude depending on the bssid, essid and serial)
  --include-providers [PROVIDER [PROVIDER ...]]
                        Specify the provider(s) to get the info from, "all" to use them all or "none" to NOT any providers:
                        Available providers: builtin, goy_script, download_wireless_net, wps_bunker, wps_db
                        Default: "all"
  --exclude-providers [PROVIDER [PROVIDER ...]]
                        Specify the provider(s) to NOT get the info from or, "all" to NOT use any provider or "none" to use them all:
                        Available providers: builtin, goy_script, download_wireless_net, wps_bunker, wps_db
                        Default: "none"

Exit error codes

  • Success:
    • 0: No error.
    • 3: No internet connection warning.
      • update_db option: only the offline providers would be updated.
      • generate option: the online providers would not be queried.
  • Error:
    • 2: Argument error.
Clone this wiki locally