CNAM-CLI is a command-line client for EveryoneAPI written in PHP. In order to use CNAM, you must have an EveryoneAPI account with available funds.
- Download and unpack the latest release.
- Run
install.sh
as root or usesudo
- Run
cnam setup
to set your EveryoneAPI credentials
To perform a lookup of a phone number: cnam [phonenumber] [--data-point]
Running cnam <phone_number>
without specifying any data point flags will cause CNAM to return all available data for the provided number.
Providing one or more data point flags will cause CNAM to return ONLY the selected data points. Example: cnam 5551234567 --name --carrier
will cause CNAM to return only the name and carrier for the provided number.
- Use the
--name
flag to query for the name data point. - Use the
--profile
flag to query for the profile data point. - Use the
--cnam
flag to query for the cnam data point. - Use the
--gender
flag to query for the gender data point. - Use the
--image
flag to query for the image data point. - Use the
--address
flag to query for the address data point. - Use the
--location
flag to query for the location data point. (Included free with--address
) - Use the
--provider
flag to query for the provider data point. - Use the
--carrier
flag to query for the carrier data point. - Use the
--carrier_o
flag to query for the carrier_o data point. (Included free with--carrier
) - Use the
--linetype
flag to query for the linetype data point.
CNAM-CLI comes with a UNIX man page cnam
. You can view the man page using the man
command or any graphical man page viewer.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request ^^,
Concept and original codebase: Corey Edwards (@cedwardsmedia)
Optimization and Debugging: Brian Seymour (@eBrian)
CNAM-CLI is licensed under the MIT License. See LICENSE for more.
Disclaimer: CNAM-CLI is not endorsed by, sponsored by, or otherwise associated with OpenCNAM, EveryoneAPI, or Telo USA, Inc.