Ideal Postcodes CLI

Introducing idpc, the Ideal Postcodes command-line interface. Manage your account, clean address data, and validate emails and phone numbers from the terminal. Built for humans and agents.

In agent mode, the CLI will non-interactively emit JSON to stdout and signal failure through exit codes.

Details

• Key management: Check balances, usage, lookup logs, and allowed-URL configurations for your API keys
• Address cleansing: idpc cleanse matches messy addresses against authoritative data, taking a single query, a file, or stdin, with CSV output for batches
• Find and resolve: idpc find returns address suggestions for a partial query; pipe a suggestion ID into idpc resolve for the full record
• Email and phone validation: idpc email and idpc phone mirror the cleanse workflow, with --carrier lookups for phone numbers
• Diagnostics: idpc doctor verifies connectivity and reports whether your key is actually usable, explaining limits or restrictions when it is not

Install with npm install -g @ideal-postcodes/cli. Available on npm.