Repository files navigation

circumflex is a command line tool for browsing Hacker News in your terminal

• 🛋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 withless — use the pager you already know for quick and simple navigation

You might also like:

• 🤹Native terminal colors — you bring your own color scheme,circumflex does the rest
• 💎Nerd Fonts — full support for Nerd Fonts as icons
• ❤️Add to favorites — save interesting submissions for later

• Installing
• Comment section
• Reader mode

• Syntax highlighting
• Nerd Fonts
• History

• Favorites
• Settings
• Keymaps

• Under the hood

The binary name forcircumflex isclx.

#Homebrewbrew install circumflex#Nixnix-shell -p circumflex#AURyay -S circumflex

#Gogo run main.go

PressEnter to read the comment section.

Comments are pretty-printed and piped to thepagerless. To present a nice and readable comment section,circumflex features:

• Rainbow-colored indentation blocks
• Text formatting inbold,italics andcode where available
• Labels for Original Posters (OP), Parent Posters (PP) and moderators (mod)

The following pair of shortcuts are recommended for browsing and navigating thecomment 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

PressSpace to read the submission link in Reader Mode.

Quotes are indented, italicized and dimmed in order to distinguish them from the rest of the comment.

`Code snippets`,@username mentions,$variables andURLs are highlighted.

References on Hacker News are formatted as numbers inside brackets.circumflex highlights these numbersfor easier cross-referencing.

Headlines containing the textAsk HN,Tell HN,Show HN andLaunch HN are highlighted.

Twice a year, Y Combinator funds start-ups through its accelerator program.circumflex highlights these startups to signalize their affiliation with YC.

If you have a Nerd Fonts-patched fonts, you can runclx with the-n or--nerdfonts flag.

Visited submissions are marked as read.

Comments that are new since the last visit are highlighted.

A list of submissions (byID and last time visited) are stored in~/.cache/circumflex/history.json. Disable marking submissions as read byrunningclx with the-d or--disable-history flag.

You can delete your browsing history from the command line:

clx clear

Pressf to add the currently highlighted submission to your list of favorites. Remove submissions from theFavorites page withx.

You can add any submission by itsID from the command line:

clx add [id]

Favorites are stored in~/.config/circumflex/favorites.json.circumflex pretty-printsfavorites.json to make it both human-readable and VCS-friendly.

Runclx help orman clx for a list of available commands and settings.

add [ID]      Add item to list of favorites by IDcomments [ID] Go directly to the comment section by IDarticle [ID]  Read the linked article associated with an item based on the IDurl [URL]     Open a URL directly in Reader Modeclear         Clear the history of visited IDs

-a, --auto-expand           Automatically expand all replies upon entering                              the comment section    --categories=[string]   Set the categories in the header                              (available: "top,best,ask,show,new")                              (default:   "top,best,ask,show")-c, --comment-width=[int]   Set the comment width                              (default 70)-e, --disable-emojis        Disable conversion of smileys to emojis-d, --disable-history       Disable marking stories as read-t, --hide-indent           Hide the indentation bar to the left of the reply-n, --nerdfonts             Enable Nerd Fonts    --no-less-verify        Disable checking less version on startup-o, --plain-comments        Disable syntax highlighting for comments-p, --plain-headlines       Disable syntax highlighting for headlines-v, --version               Print current version

Press?/i to show a list of available keymaps:

circumflex uses:

• Bubble Tea for the TUI
• cobra for the CLI
• Algolia's Search API for submissions
• cheeaun's unofficial Hacker News API for comments
• less for viewing comments and articles
• go-term-text andlipgloss for text formatting
• go-readability,html-to-markdownandGlamour for formatting

Screenshots use:

• iTerm2 for the terminal
• Palenight Theme for the color scheme
• JetBrains Mono for the font