@worldkit/cli
v1.0.3
Published
Command-line interface for @worldkit data lookup
Maintainers
Readme
💻 @worldkit/cli
Command line toolkit for instant global data searches and lookups right from your terminal.
Search countries, currencies, cities, and validate phone numbers directly in your terminal.
📚 Full Documentation: https://worldkit.in/docs/cli
⚡ Features
- ⚡ Zero Installation Required: Run instantly via
npx @worldkit/cli. - 🔍 Instant Terminal Search: Search across countries, currencies, cities, and languages.
- 📱 Phone Validation Utility: Quick terminal command to validate and format E.164 phone numbers.
- 📊 Formatted Table Output: Clean, colored terminal outputs.
🚀 Quickstart
Run commands without installing:
# 1. Search global entities
npx @worldkit/cli search Japan
# 2. Inspect country details by ISO2 code
npx @worldkit/cli info JP
# 3. List all ISO currencies
npx @worldkit/cli currencies
# 4. Validate phone number
npx @worldkit/cli validate-phone +919876543210 IN📦 Global Installation (Optional)
Install globally to use worldkit command directly:
npm install -g @worldkit/cli
# Now run commands directly:
worldkit search "Tokyo"
worldkit info DE📖 Commands Reference
| Command | Arguments | Description |
| :--- | :--- | :--- |
| search | <query> | Multi-entity fuzzy search (<3ms) |
| info | <code> | Inspect country metadata by ISO2/ISO3 |
| currencies | | List all supported ISO 4217 currencies |
| validate-phone | <phone> [country] | Validate E.164 phone digits |
🔗 Related Packages
Explore the rest of the WorldKit ecosystem:
@worldkit/core- Main JavaScript/TypeScript API facade.@worldkit/search- Search engine module.@worldkit/countries- Country dataset.
📜 License
MIT © WorldKit
