About this project
pwned is a command-line tool that interfaces with Troy Hunt's 'Have I been pwned?' service using the hibp Node.js module. It allows users to check if their accounts or email addresses have been involved in known data breaches, search for pastes, verify password exposure, and retrieve breach information.
## Installation
Install globally via npm:
```shell
npm install pwned -g
```
Or run on-demand with npx:
```shell
npx pwned
```
## Protected Commands
Since July 18, 2019, some API endpoints require an API key. Commands like `ba`, `pa`, and `search` need authentication. Obtain an API key from [haveibeenpwned.com/API/Key](https://haveibeenpwned.com/API/Key) and configure it with `pwned apiKey`. Other commands work without a key.
## Usage
```
pwned <command>
Commands:
pwned apiKey [key] set the API key for authenticated requests
pwned ba <account|email> get all breaches for an account
pwned bd <domain> get all breached email addresses for a domain
pwned breach <name> get a single breached site by breach name
pwned breaches get all breaches in the system
pwned dc get all data classes in the system
pwned lb get the most recently added breach
pwned pa <email> get all pastes for an account
pwned pw <password> securely check a password for public exposure
pwned sd get all subscribed domains for your account
pwned search <account|email> search breaches and pastes for an account
pwned slbe <email> get all stealer log domains for an email address
pwned slbed <email-domain> get all stealer log email aliases for an email domain
pwned slbwd <website-domain> get all stealer log email addresses for a website domain
pwned subStatus get the subscription status of your API key
Options:
-h, --help Show help
-v, --version Show version number
```
## Examples
- Check breaches for an account: `pwned ba email@example.com`
- List all breaches filtered by domain: `pwned breaches -d adobe.com`
- Get a specific breach: `pwned breach MyCompany`
- Get data classes as raw JSON: `pwned dc --raw`
- Check pastes for an email: `pwned pa nobody@nowhere.com`
- Check password exposure: `pwned pw Password1234`
- Search breaches and pastes: `pwned search nobody`
## License
MIT License
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.