How phucvohoai/nyx works
Nyx is a keyboard-driven terminal text browser. The primary workflow is user search or direct navigation, followed by page retrieval, structured reader extraction, and interactive reading; forms, images, and Tor routing are additional capabilities. The graph includes the documented subsystems, but some wiring is represented only where the excerpts or README establish it; unsampled implementation details are not assumed.
Main entry points: main.rs Terminal app · lib.rs Page requests · parser.rs HTML extraction · search.rs Search parsing
Components 21
Terminal interface
- Terminal app
crates/nyx-tui/src/main.rs - Link navigation
crates/nyx-tui/src/main.rs - Form controls
crates/nyx-tui/src/main.rs - Image reader
crates/nyx-tui/src/main.rs
Browsing core
- Navigation state
crates/nyx-core/src/state.rs - Search workflow
crates/nyx-tui/src/main.rs - Search parsing
crates/nyx-core/src/search.rs - URL normalization
crates/nyx-core/src/search.rs
Networking and privacy
- Page requests
crates/nyx-pal/src/lib.rs - Form submission
crates/nyx-pal/src/lib.rs - Image requests
crates/nyx-pal/src/lib.rs - Tor route checks
crates/nyx-pal/src/lib.rs - Encrypted session vault
crates/nyx-pal/src/lib.rs - Session cookies
crates/nyx-pal/src/lib.rs
Page features
- HTML extraction
crates/nyx-core/src/parser.rs - Reader document
crates/nyx-core/src/parser.rs - Form extraction
crates/nyx-core/src/parser.rs
Other components
- Browser user
- SearXNG service
- Web pages
- Tor SOCKS5 service
Connections 25
- Browser user → Terminal app: uses controls
README.md - Terminal app → Navigation state: updates views
crates/nyx-core/src/state.rs - Terminal app → Search workflow: starts search
README.md - Search workflow → Search parsing: parses results
README.md - Search workflow → SearXNG service: requests results
README.md - Search parsing → Navigation state: provides results
- Terminal app → URL normalization: normalizes address
- Terminal app → Page requests: loads page
crates/nyx-tui/src/main.rs - Page requests → Web pages: requests page
README.md - Page requests → Tor route checks: checks route
crates/nyx-pal/src/lib.rs - Tor route checks → Tor SOCKS5 service: verifies proxy
README.md - Page requests → HTML extraction: supplies HTML
- HTML extraction → Reader document: extracts content
crates/nyx-core/src/parser.rs - Reader document → Terminal app: renders document
README.md - Terminal app → Link navigation: dispatches selection
crates/nyx-tui/src/main.rs - Link navigation → Page requests: loads target
crates/nyx-tui/src/main.rs - HTML extraction → Form extraction: extracts forms
crates/nyx-core/src/parser.rs - Terminal app → Form controls: edits fields
README.md - Form controls → Form submission: submits form
- Form submission → Web pages: sends request
crates/nyx-pal/src/lib.rs - Terminal app → Image reader: opens images
README.md - Image reader → Image requests: downloads image
crates/nyx-tui/src/main.rs - Image requests → Web pages: fetches bytes
crates/nyx-pal/src/lib.rs - Terminal app → Encrypted session vault: unlocks vault
README.md - Page requests → Session cookies: uses sessions
crates/nyx-pal/src/lib.rs