usage.md

Running a scan

Use the scan command with the -n (or --number) option.

phoneinfoga scan -n "[phone]"
phoneinfoga scan -n "[phone]"
phoneinfoga scan -n "33679368229"

Special chars such as ( ) - + will be escaped so typing US-based numbers stay easy :

phoneinfoga scan -n "[phone]"

!!! note "Note that the country code is essential. You don't know which country code to use ? Find it here"

Available scanners

PhoneInfoga embed a bunch of scanners that will provide information about the given phone number. Some of them will request external services, and so might require authentication. By default, unconfigured scanners won't run. The information gathered can then be used for a deeper manual analysis.

See page related to scanners.

Launching the web server

PhoneInfoga integrates a REST API along with a web client that you can deploy anywhere. The API has been written in Go and web client in Vue.js. The application is stateless, so it doesn't require any persistent storage.

See API documentation.

phoneinfoga serve # uses default port 5000
phoneinfoga serve -p 8080 # use port 8080

Equivalent commands via docker:

docker run --rm -it -p 5000:5000 sundowndev/phoneinfoga serve # same as `phoneinfoga serve`
docker run --rm -it -p 8080:8080 sundowndev/phoneinfoga serve -p 8080 # same as `phoneinfoga serve -p 8080`

You should then be able to visit the web client from your browser at http://localhost:<port>.

Running the REST API only

You can choose to only run the REST API without the web client:

phoneinfoga serve --no-client

Equivalent docker command:

docker run --rm -it -p 5000:5000 sundowndev/phoneinfoga serve --no-client