https://github.com/trashhalo/readcli

Tool that lets you read website content on the command line
https://github.com/trashhalo/readcli

bubbletea markdown pin

Last synced: about 1 month ago
JSON representation

Tool that lets you read website content on the command line

• Host: GitHub
• URL: https://github.com/trashhalo/readcli
• Owner: trashhalo
• License: mit
• Created: 2020-10-29T00:26:39.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-10-30T14:21:16.000Z (about 4 years ago)
• Last Synced: 2024-10-11T15:14:20.885Z (2 months ago)
• Topics: bubbletea, markdown, pin
• Language: Go
• Homepage:
• Size: 224 KB
• Stars: 91
• Watchers: 5
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• my-awesome-github-stars - trashhalo/readcli - Tool that lets you read website content on the command line (Go)

README

        
# readcli

Tool that lets you read website content* on the command line. 

## Usage

```shell

readcli https://medium.com/compass-true-north/go-unit-testing-at-compass-3a7cb85ab54a

```

![](./sample.png)

## Install

### homebrew

```

brew install trashhalo/homebrew-brews/readcli

```

### prebuilt packages

Prebuilt packages can be found at the [releases page](https://github.com/trashhalo/readcli/releases)

## Website Content

The algorithm is as follows:

1. Use [go-readability](https://github.com/go-shiori/go-readability) to download a stripped down version of the website.

2. Use [html-to-markdown](https://github.com/JohannesKaufmann/html-to-markdown) to convert the clean html to markdown.

3. Use [glamour](https://github.com/charmbracelet/glamour) to render the markdown content.

This limits the tool to only sites that pass go-readability.

## Sites that work well

* Any medium post

## What about images in markdown content?

Stay tuned. https://github.com/trashhalo/imgcat/issues/11