bensadeh / circumflex

circumflex is a command line tool for browsing Hacker News in your terminal Main features • 🛋 **Everything in one place** — read both the comment section and articles in Reader Mode • 🌈 **Syntax highlighting** — syntax-aware formatting for comments and headlines • ⚡️ **Read it with ** — use the pager you already know for quick and simple navigation **You might also like:** • 🤹 **Native terminal colors** — you bring your own color scheme, does the rest • 💎 **Nerd Fonts** — full support for Nerd Fonts as icons • ❤️ **Add to favorites** — save interesting submissions for later Table of Contents • Installing • Comment section • Reader mode • Syntax highlighting • Nerd Fonts • History • Favorites • Settings • Keymaps • Under the hood *** Installing The binary name for is . Package managers From source > [!IMPORTANT] > When building from source, make sure that you are using the latest version > of . Comment section Overview Press Enter to read the comment section. Comments are pretty-printed and piped to the pager . To present a nice and readable comment section, features: • Rainbow-colored indentation blocks • Text formatting in **bold**, _italics_ and where available • Labels for Original Posters ( ), Parent Posters ( ) and moderators ( ) Navigation The following pair of shortcuts are recommended for browsing and navigating the comment section. • d / u to scroll half a screen • j / k to scroll one line at a time • h / l to hide and show replies • n / N to jump to the next top-level comment Reader mode Press Space to read the submission link in Reader Mode. > [!NOTE] > Some websites do not work well with Reader Mode. If the submission URL points to a domain with known Reader Mode incompatibility, the link cannot be opened in Reader Mode. Syntax highlighting Quotes Quotes are indented, italicized and dimmed in order to distinguish them from the rest of the comment. Hacker News and forum idiosyncrasies \ , mentions, and are highlighted. References References on Hacker News are formatted as numbers inside brackets. highlights these numbers for easier cross-referencing. Categories Headlines containing the text , , and are highlighted. YC-funded startups Twice a year, Y Combinator funds start-ups through its accelerator program. highlights these startups to signalize their affiliation with YC. Nerd Fonts If you have a Nerd Fonts-patched fonts, you can run with the or flag. History Mark submissions as read Visited submissions are marked as read. Highlight new comments Comments that are new since the last visit are highlighted. Disabling history A list of submissions (by and last time visited) are stored in . Disable marking submissions as read by running with the or flag. You can delete your browsing history from the command line: Favorites Press f to add the currently highlighted submission to your list of favorites. Remove submissions from the Favorites page with x . You can add any submission by its from the command line: Favorites are stored in . pretty-prints to make it both human-readable and VCS-friendly. Settings Overview Run or for a list of available commands and settings. Commands Flags Keymaps Press ? / i to show a list of available keymaps: | Key | Description | |:-----------------|:--------------------------------| | Enter | Read comments | | Space | Read article in Reader Mode | | r | Refresh | | Tab | Change category | | o | Open link to article in browser | | c | Open comment section in browser | | f | Add to favorites | | x | Remove from favorites | | q | Quit | Under the hood uses: • Bubble Tea for the TUI • cobra for the CLI • Algolia's Search API for submissions • cheeaun's unofficial Hacker News API for comments • for viewing comments and articles • go-term-text and lipgloss for text formatting • go-readability, html-to-markdown and Glamour for formatting Screenshots use: • iTerm2 for the terminal • Palenight Theme for the color scheme • JetBrains Mono for the font