@builtwith/tui
v0.7.0
Published
Terminal UI for the BuiltWith API
Readme
🟢 BuiltWith TUI
Domain API v25
Domain lookups now use API v25. Technology records include numeric confidence scores from 0 to 1. Full JSON responses include Meta.company_reg, an array of company registration records with string type and number fields; registration numbers preserve leading zeros. The array is empty when unavailable or metadata is excluded. See the API reference.
A terminal-based user interface for exploring the BuiltWith API. Runs in any terminal — Windows CMD, PowerShell, or Bash.
✨ Features
- 🖥️ Full TUI experience — navigate endpoints, enter parameters, and view results without leaving the terminal
- 🌐 All 23 REST API endpoints — Domain, Change, Lists, Relationships, Free, Company to URL, Tags, Recommendations, Redirects, Keywords, Trends, Product, Trust, VAT, VAT Types, MCP Registry (v1 & v2), Vector Search, Ask API, WhoAmI, Usage, and Agent Device-Code Authorization
- 📡 WebSocket Live Feed — real-time technology detection stream with subscribe/unsubscribe commands
- 🎨 Color-formatted JSON — syntax-highlighted API responses for easy reading
- 🔑 API key management — save your key locally so you don't have to re-enter it
- 📜 Call history — re-run previous API calls with a single keystroke
📦 Installation
npm install -g @builtwith/tui
bwtuiOr run without installing:
npx @builtwith/tuiOr clone and run from source:
git clone https://github.com/builtwith/builtwith-tui.git
cd builtwith-tui
npm install
npm start🚀 Quick Start
- Launch with
bwtui(ornpx @builtwith/tui) - Press F1 to enter your BuiltWith API key (get one at builtwith.com)
- Use ↑ ↓ to browse endpoints in the sidebar
- Press Enter to select an endpoint and fill in parameters
- View the formatted JSON response in the main panel
⌨️ Keyboard Shortcuts
| Key | Action |
|-----|--------|
| ↑ ↓ | Navigate endpoint list |
| Enter | Select endpoint / confirm input |
| Tab | Switch between sidebar and detail panel |
| F1 | Set API key |
| F5 | View call history |
| F9 | Open WebSocket Live Feed |
| q / Ctrl+C | Quit |
| Escape | Close overlays |
🌐 Supported API Endpoints
| # | Endpoint | Description | |---|----------|-------------| | 1 | 🔍 Domain API | Technology and metadata for any domain | | 2 | 🔄 Change API | Technology additions and removals | | 3 | 📋 Lists API | Sites using a specific technology | | 4 | 🔗 Relationships API | Related sites via shared identifiers | | 5 | 🆓 Free API | Summary counts for technology groups | | 6 | 🏢 Company to URL | Discover domains from company names | | 7 | 🏷️ Tags API | Domains related to IPs and attributes | | 8 | 💡 Recommendations | Technology recommendations for a domain | | 9 | ↪️ Redirects API | Redirect history for a domain | | 10 | 🔑 Keywords API | Keywords associated with a domain | | 11 | 📈 Trends API | Technology adoption trends | | 12 | 🛒 Product API | Find websites selling specific products | | 13 | 🛡️ Trust API | Trust and fraud signals for a domain | | 14 | 🧾 VAT API | VAT, GST, and other company registration numbers for websites | | 15 | 🧾 VAT Types API | Reference list of registration types (no API key required) | | 16 | 🔌 MCP Registry API | Search/browse the BuiltWith MCP registry (v1) of discovered remote MCP servers (no API credits) | | 17 | 🔌 MCP Registry API (v2) | Search/browse the BuiltWith MCP registry (v2), with per-endpoint auth flags and first/last detected dates (no API credits) | | 18 | 🔎 Vector Search | Semantic search across technologies and categories | | 19 | 💬 Ask API | Natural language website list lookup (e.g. "Magento websites in Spain") | | 20 | 👤 WhoAmI | Check API key identity and plan details | | 21 | 📊 Usage | View API usage statistics | | 22 | 🔐 Agent Auth Start | Start Device-Code Authorization flow (no API key required) | | 23 | 🔐 Agent Auth Token | Poll for authorization result and access token (no API key required) |
💬 Ask API — Natural Language Lookups
The Ask API lets you query the BuiltWith database in plain English:
Magento websites in SpainReact e-commerce sites with high revenueShopify stores selling pet products
Parameters:
| Parameter | Description |
|---|---|
| QUERY | Your natural language question (required) |
| COMMIT | Set to true for a full report (up to 1,000 results) |
| NEXTOFFSET | Paste the NextOffset from a previous response to get the next page |
| META | Set to yes to include metadata |
Without COMMIT, every request returns a quick sample — great for previewing before running a full report.
📡 WebSocket Live Feed
Press F9 to open the WebSocket panel. Available commands:
subscribe <technology>— start receiving live detections for a technologyunsubscribe <technology>— stop receiving detectionslist— show current subscriptionsclear— clear the message log
🔧 Requirements
- Node.js 18 or later
- A BuiltWith API key (free tier available)
📄 License
ISC
