Skip to content

Commandline Options

ImmuniWeb edited this page Jul 15, 2021 · 4 revisions

iwtools command line options

usage: iwtools.py [-h] [--api-key API_KEY] [--api-keyfile API_KEYFILE] [-r] [-i IP] [-o OUTPUT] [-f FORMAT]
                  TEST_TYPE TEST_TARGET

--api-key API_KEY

Pass your API key for a higher number of daily tests.

--api-keyfile API_KEYFILE

Use a file with your API keys (it’s more secure than using raw arguments). Find out more.

Sample file content:

websec ssl ABCDE-12345-FGHIJ-67890
darkweb 12345-ABCDE-67890-FGHIJ
mobile ABCDE-FGHIJ-12345-67890

-r / --recheck

Force to refresh the test (API key required).

-i / --ip IP

Force to use a specific IP address of the test's target.

-o / --output OUTPUT

Path to the output file.

-f / --format {colorized_text, pretty_json, raw_json}

Output format.

  • colorized_text — Colorful human-readable text.
  • raw_json — API response in JSON format.
  • pretty_json — API response in pretty-printed JSON format.

websec / mobile / darkweb / ssl

This parameter specifies the test's type.

websec — Website Security Test
mobile — Mobile App Security Test
darkweb — Dark Web Exposure Test
ssl — SSL Security Test

target (positional argument)

This parameter specifies the target of the test: URL of the tested website or mobile app (in application stores).