caret

[ACTIVE] a command line tool for browsing Lobsters in your terminal
git clone git://git.figbert.com/caret.git
Log | Files | Refs | README | LICENSE

README.md (1159B)

      1 # crt
      2 `caret` is a command line tool for browsing Lobsters in your terminal.
      3 It is heavily inspired by the excellent [`circumflex`][clx].
      4 
      5 ---
      6 
      7 ## Installing
      8 The binary name for `caret` is `crt`.
      9 
     10 ### Package Managers
     11 Coming soon!
     12 
     13 ### From Source
     14 ```console
     15 go install git.figbert.com/caret@latest
     16 ```
     17 
     18 ## Keymap
     19 | Key              | Description                     |
     20 |:-----------------|:--------------------------------|
     21 | <kbd>Enter</kbd> | Read comments                   |
     22 | <kbd>Space</kbd> | Read article in Reader Mode     |
     23 | <kbd>o</kbd>     | Open link to article in browser |
     24 | <kbd>c</kbd>     | Open comment section in browser |
     25 | <kbd>q</kbd>     | Quit                            |
     26 
     27 ## Under the Hood
     28 `caret` uses:
     29 
     30 - The excellent TUI libraries by the folks at [Charm](https://charm.sh)
     31 - [`less`][less] for viewing comments and articles
     32 - [go-readability](https://github.com/go-shiori/go-readability)
     33 - [html-to-markdown][html2md]
     34 - [go-humanize](https://github.com/dustin/go-humanize)
     35 
     36 [clx]: https://github.com/bensadeh/circumflex
     37 [less]: http://greenwoodsoftware.com/less/
     38 [html2md]: https://github.com/JohannesKaufmann/html-to-markdown