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
- β‘οΈ Familiar tools β content is piped to the pager
less
You might also like:
- π€Ή Adaptive terminal colors β you bring your own color scheme,
circumflex
does the rest - π Easy customization β quickly enable or disable features
- β€οΈ Add to favorites β save interesting submissions for later
circumflex
is available on Homebrew.
# Install
brew install circumflex
# Run
clx
You can also build circumflex
from source:
# Run
go run main.go
Press Enter to read the comment section.
Comments are pretty-printed and piped to the
pager less
. To present a nice and readable comment section, circumflex
features:
- Rainbow-colored indentation blocks
- Text formatting in bold, italics and
code
where available - Labels for Original Posters (
OP
), Parent Posters (PP
) and moderators (mod
)
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
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. See validator.go for a full list of incompatible sites.
Quotes are indented, italicized and dimmed in order to distinguish them from the rest of the comment.
`Code snippets`, @username
mentions, $variables
and URLs
are highlighted.
References on Hacker News are formatted as numbers inside brackets. circumflex
highlights these numbers
for easier cross-referencing.
Headlines containing the text Ask HN
, Tell HN
, Show HN
and Launch 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.
Visited submissions are marked as read.
Comments that are new since the last visit are highlighted.
A list of submissions (by ID
and last time visited) are stored in ~/.cache/circumflex/history.json
. Disable marking submissions as read by
running clx
with the -d
or --disable-history
flag.
You can delete your browsing history from the command line:
clx clear
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 ID
from the command line:
clx add [id]
Favorites are stored in ~/.config/circumflex/favorites.json
. circumflex
pretty-prints
favorites.json
to make it both human-readable and VCS-friendly.
Run clx help
or man clx
for a list of available commands and settings.
A table of available flags is provided below:
Flag | Description |
---|---|
-c |
Set the comment width |
-l |
Disable syntax highlighting for the headlines |
-o |
Disable syntax highlighting in the comment section. |
-s |
Disable conversion of smileys (:) ) to emojis (π) |
-d |
Disable marking submissions as read |
-t |
Hide the indentation symbol from the comment section (does not affect quotes) |
-n |
Use Nerd Fonts icons as decorators |
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 |
circumflex
uses:
- Bubble Tea for the TUI
- cobra for the CLI
- Algolia's Search API for list of submissions and cheeaun's unofficial Hacker News API for providing comments
less
for viewing comments and articles- go-term-text for text formatting
- go-readability, html-to-markdown and Glamour for formatting and rendering articles in Reader Mode
Screenshots use:
- iTerm2 for the terminal
- Palenight Theme for the color scheme
- JetBrains Mono for the font