tui Command
Last updated January 14, 20263 min read
The tui command launches an interactive terminal user interface for browsing and inspecting webhooks. This is the default command when you run hooklistener without any arguments.
Default Command
Running hooklistener without arguments is equivalent to running hooklistener tui.
Usage
hooklistener tui [OPTIONS]Or simply:
hooklistenerOptions
| Option | Description |
|---|---|
--endpoint <ID> | Start with a specific endpoint selected |
--help | Show help information |
Features
- •Real-time updates: See new webhooks as they arrive without refreshing
- •Request inspection: View full request details including headers, body, and query parameters
- •Delivery status: Track webhook delivery attempts and responses
- •Endpoint switching: Navigate between your endpoints easily
- •Keyboard navigation: Fast, vim-like navigation for power users
Keyboard Shortcuts
| Key | Action |
|---|---|
j / ↓ | Move down |
k / ↑ | Move up |
Enter | Select / expand |
Esc | Go back / close panel |
Tab | Switch between panels |
r | Refresh current view |
/ | Search requests |
q | Quit the TUI |
Examples
Launch the TUI
Simply run hooklistener to start the interactive interface:
hooklistenerStart with a Specific Endpoint
Jump directly to viewing a specific endpoint's requests:
hooklistener tui --endpoint ep_abc123Tips
- Terminal size: The TUI works best in a terminal at least 80 columns wide. Resize your terminal if the layout looks cramped.
- Colors: Ensure your terminal supports 256 colors for the best experience. Most modern terminals do by default.
- SSH sessions: The TUI works over SSH, but you may need to set
TERM=xterm-256colorfor proper rendering.