#
circumflex
is a command line tool for browsing Hacker News in your terminal
less
β use the pager you already know for quick and simple navigation You might also like:
circumflex
does the rest#
The binary name for circumflex
is clx
.
# Homebrew
brew install circumflex
# Nix
nix-shell -p circumflex
# AUR
yay -S circumflex
# Go
go run main.go
[!IMPORTANT] When building from source, make sure that you are using the latest version of
less
.
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:
code
where availableOP
), Parent Posters (PP
) and moderators (mod
)The following pair of shortcuts are recommended for browsing and navigating the comment section.
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.
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.
If you have a Nerd Fonts-patched fonts, you can run clx
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 (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.
add [ID] Add item to list of favorites by ID
comments [ID] Go directly to the comment section by ID
article [ID] Read the linked article associated with an item based on the ID
url [URL] Open a URL directly in Reader Mode
clear 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:
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:
less
for viewing comments and articlesScreenshots use: