shbrw v1.3.0

Usage

Looking for one-time usage? Check the commands below!

npx shbrw --url=https://binaryblazer.me
# or
pnpm dlx shbrw --url=https://binaryblazer.me
# or
bunx shbrw --url=https://binaryblazer.me

!TIP Make sure to replace the https://binaryblazer.me (the value of the the url flag) with your desired URL.

Installation

To install the package, use npm:

npm install -g shbrw
# or
yarn global add shbrw
# or
pnpm add -g shbrw
# or
bun install -g shbrw

CLI Usage

To open a headless and frameless browser window, use the following command:

shbrw --url=<websiteUrl> [--size=WxH] [--optimized] [--noJS]

Then, right-click on the page and select "Take Screenshot" from the context menu.

CLI Options

• --url: The URL of the website to open.
• --size: The size of the window in the format WxH (default: 1280x720).
• --optimized: Run the website in optimized mode.
• --noJS: Disable JavaScript on the website.

API Usage

You can also use the API to take screenshots programmatically.

Example

import { takeScreenshot } from 'shbrw';

const url = 'https://example.com';
const options = {
    width: 1920,
    height: 1080,
    x: 0,
    y: 0,
    noJS: false
};

takeScreenshot(url, options)
    .then(buffer => {
        // Do something with the screenshot buffer
    })
    .catch(error => {
        console.error('Error taking screenshot:', error);
    });

API Options

• url: The URL of the website to take a screenshot of.
• options: An object containing the following properties:
  • width: The width of the screenshot (default: 1280).
  • height: The height of the screenshot (default: 720).
  • x: The x-coordinate of the screenshot (default: 0).
  • y: The y-coordinate of the screenshot (default: 0).
  • noJS: Disable JavaScript on the website (default: false).