hit-that

Hit an HTML page and render it in your terminal

Usage no npm install needed!

<script type="module">
  import hitThat from 'https://cdn.skypack.dev/hit-that';
</script>

README

hit-that

Render beautiful pixel perfect representations of websites in your terminal

Installation

npm install -g hit-that

API

Hit That comes with a simple API where it exports just a function hitThat(url, options?). The first argument is the url you intend to render. The second argument is an optional configuration object.

  • width=1024 is the viewport width in pixels that we'll use for the screenshot
  • height=768 is the viewport height in pixels that we'll use for the screenshot
  • cols=80 is the amount of columns we'll allocate to the terminal representation
  • dest=process.stdout is the destination stream you want to pipe the results to.
var hitThat = require('hit-that');

hitThat('http://ponyfoo.com');

CLI

There's a command-line interface as well.

ht ponyfoo.com
Usage:

ht <url> --width [width] --height [height] --cols [cols]

Options:

  --width   Viewport width in pixels
  --height  Viewport height in pixels
  --cols    Terminal columns to use
  --help    Render this information
  --version Render version information

Example

Pony Foo rendered as an image in terminal

Pony Foo rendered as an image in terminal

Use it as a CLI banner!

Google.com banner

You'll get the best results when reducing the viewport width

Reduced viewport width at emberjs.com

(That site better be responsive!)

License

MIT