https://github.com/builtwith/builtwith-tui
Text User Interface to BuiltWith API Endpoints
https://github.com/builtwith/builtwith-tui
Last synced: 2 months ago
JSON representation
Text User Interface to BuiltWith API Endpoints
- Host: GitHub
- URL: https://github.com/builtwith/builtwith-tui
- Owner: builtwith
- Created: 2026-02-14T21:47:46.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2026-04-03T09:07:23.000Z (3 months ago)
- Last Synced: 2026-04-03T15:08:59.236Z (3 months ago)
- Language: JavaScript
- Size: 21.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🟢 BuiltWith TUI
A terminal-based user interface for exploring the [BuiltWith API](https://api.builtwith.com). Runs in any terminal — Windows CMD, PowerShell, or Bash.
 
[▶ Watch Demo](https://github.com/user-attachments/assets/332c7bdc-4fb0-450f-87bc-beff993b296e)
---
## ✨ Features
- 🖥️ **Full TUI experience** — navigate endpoints, enter parameters, and view results without leaving the terminal
- 🌐 **All 17 REST API endpoints** — Domain, Lists, Relationships, Free, Company to URL, Tags, Recommendations, Redirects, Keywords, Trends, Product, Trust, Vector Search, 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
```bash
npm install -g @builtwith/tui
builtwith-tui
```
Or run without installing:
```bash
npx @builtwith/tui
```
Or clone and run from source:
```bash
git clone https://github.com/builtwith/builtwith-tui.git
cd builtwith-tui
npm install
npm start
```
## 🚀 Quick Start
1. Launch the app with `npm start`
2. Press **F1** to enter your BuiltWith API key (get one at [builtwith.com](https://api.builtwith.com))
3. Use **↑ ↓** to browse endpoints in the sidebar
4. Press **Enter** to select an endpoint and fill in parameters
5. 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 | 📋 **Lists API** | Sites using a specific technology |
| 3 | 🔗 **Relationships API** | Related sites via shared identifiers |
| 4 | 🆓 **Free API** | Summary counts for technology groups |
| 5 | 🏢 **Company to URL** | Discover domains from company names |
| 6 | 🏷️ **Tags API** | Domains related to IPs and attributes |
| 7 | 💡 **Recommendations** | Technology recommendations for a domain |
| 8 | ↪️ **Redirects API** | Redirect history for a domain |
| 9 | 🔑 **Keywords API** | Keywords associated with a domain |
| 10 | 📈 **Trends API** | Technology adoption trends |
| 11 | 🛒 **Product API** | Find websites selling specific products |
| 12 | 🛡️ **Trust API** | Trust and fraud signals for a domain |
| 13 | 🔎 **Vector Search** | Semantic search across technologies and categories |
| 14 | 👤 **WhoAmI** | Check API key identity and plan details |
| 15 | 📊 **Usage** | View API usage statistics |
| 16 | 🔐 **Agent Auth Start** | Start Device-Code Authorization flow (no API key required) |
| 17 | 🔐 **Agent Auth Token** | Poll for authorization result and access token (no API key required) |
## 📡 WebSocket Live Feed
Press **F9** to open the WebSocket panel. Available commands:
- `subscribe ` — start receiving live detections for a technology
- `unsubscribe ` — stop receiving detections
- `list` — show current subscriptions
- `clear` — clear the message log
## 🔧 Requirements
- **Node.js** 18 or later
- A [BuiltWith API key](https://api.builtwith.com) (free tier available)
## 📄 License
ISC