{"id":24995310,"url":"https://github.com/binary-blazer/shbrw","last_synced_at":"2025-04-22T11:45:46.345Z","repository":{"id":275661576,"uuid":"926738696","full_name":"binary-blazer/shbrw","owner":"binary-blazer","description":"A headless CLI browser made for screenshots","archived":false,"fork":false,"pushed_at":"2025-03-10T17:38:52.000Z","size":224,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-29T14:43:43.642Z","etag":null,"topics":["browser","cli","frameless","headless","scb","screencapture","screenshot"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/shbrw","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/binary-blazer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-02-03T19:22:05.000Z","updated_at":"2025-03-10T17:38:17.000Z","dependencies_parsed_at":"2025-02-03T22:39:27.077Z","dependency_job_id":null,"html_url":"https://github.com/binary-blazer/shbrw","commit_stats":null,"previous_names":["binary-blazer/shbrw"],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/binary-blazer%2Fshbrw","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/binary-blazer%2Fshbrw/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/binary-blazer%2Fshbrw/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/binary-blazer%2Fshbrw/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/binary-blazer","download_url":"https://codeload.github.com/binary-blazer/shbrw/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250237629,"owners_count":21397399,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["browser","cli","frameless","headless","scb","screencapture","screenshot"],"created_at":"2025-02-04T15:35:04.118Z","updated_at":"2025-04-22T11:45:46.303Z","avatar_url":"https://github.com/binary-blazer.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\r\n  \u003cpicture\u003e\r\n      \u003cimg src=\"https://github.com/binary-blazer/shb/blob/master/assets/logo_rounded.png\" width=\"15%\"\u003e\r\n  \u003c/picture\u003e\r\n  \u003ch1\u003eScreenshot Browser (shbrw)\u003c/h1\u003e\r\n  \u003cp\u003eScreenshot Browser (shbrw) is a frameless CLI browser designed for taking screenshots of websites. It provides both a CLI and an API for capturing screenshots.\u003c/p\u003e\r\n\r\n  \u003cp align=\"center\"\u003e\r\n  \u003ca aria-label=\"NPM version\" href=\"https://www.npmjs.com/package/shbrw\"\u003e\r\n    \u003cimg alt=\"\" src=\"https://img.shields.io/npm/v/shbrw.svg?style=for-the-badge\u0026labelColor=0e0a07\"\u003e\r\n  \u003c/a\u003e\r\n  \u003ca aria-label=\"Size\" href=\"https://www.npmjs.com/package/shbrw\"\u003e\r\n    \u003cimg alt=\"\" src=\"https://img.shields.io/npm/unpacked-size/shbrw?style=for-the-badge\u0026labelColor=0e0a07\"\u003e\r\n  \u003c/a\u003e\r\n  \u003ca aria-label=\"NPM Downloads\" href=\"https://www.npmjs.com/package/shbrw\"\u003e\r\n    \u003cimg alt=\"\" src=\"https://img.shields.io/npm/dt/shbrw.svg?style=for-the-badge\u0026labelColor=0e0a07\"\u003e\r\n  \u003c/a\u003e\r\n    \u003ca aria-label=\"License\" href=\"https://www.npmjs.com/package/shbrw\"\u003e\r\n    \u003cimg alt=\"\" src=\"https://img.shields.io/npm/l/shbrw?style=for-the-badge\u0026labelColor=0e0a07\"\u003e\r\n    \u003c/a\u003e\r\n\u003c/p\u003e\r\n\u003c/div\u003e\r\n\r\n## Usage\r\n\r\nLooking for one-time usage? Check the commands below!\r\n\r\n```bash\r\nnpx shbrw --url=https://binaryblazer.me\r\n# or\r\npnpm dlx shbrw --url=https://binaryblazer.me\r\n# or\r\nbunx shbrw --url=https://binaryblazer.me\r\n```\r\n\r\n\u003e [!TIP]\r\n\u003e Make sure to replace the **``https://binaryblazer.me``** (the value of the the url flag) with your desired URL.\r\n\r\n## Installation\r\n\r\nTo install the package, use npm:\r\n\r\n```bash\r\nnpm install -g shbrw\r\n# or\r\nyarn global add shbrw\r\n# or\r\npnpm add -g shbrw\r\n# or\r\nbun install -g shbrw\r\n```\r\n\r\n## CLI Usage\r\n\r\nTo open a headless and frameless browser window, use the following command:\r\n\r\n```bash\r\nshbrw --url=\u003cwebsiteUrl\u003e [--size=WxH] [--optimized] [--noJS]\r\n```\r\n\r\nThen, right-click on the page and select \"Take Screenshot\" from the context menu.\r\n\r\n\u003cimg src=\"https://github.com/binary-blazer/shb/blob/master/images/contextmenu.png\" alt=\"Context menu\" width=\"300\"\u003e\r\n\r\n### CLI Options\r\n\r\n- `--url`: The URL of the website to open.\r\n- `--size`: The size of the window in the format `WxH` (default: `1280x720`).\r\n- `--optimized`: Run the website in optimized mode.\r\n- `--noJS`: Disable JavaScript on the website.\r\n\r\n## API Usage\r\n\r\nYou can also use the API to take screenshots programmatically.\r\n\r\n### Example\r\n\r\n```js\r\nimport { takeScreenshot } from 'shbrw';\r\n\r\nconst url = 'https://example.com';\r\nconst options = {\r\n    width: 1920,\r\n    height: 1080,\r\n    x: 0,\r\n    y: 0,\r\n    noJS: false\r\n};\r\n\r\ntakeScreenshot(url, options)\r\n    .then(buffer =\u003e {\r\n        // Do something with the screenshot buffer\r\n    })\r\n    .catch(error =\u003e {\r\n        console.error('Error taking screenshot:', error);\r\n    });\r\n```\r\n\r\n### API Options\r\n\r\n- `url`: The URL of the website to take a screenshot of.\r\n- `options`: An object containing the following properties:\r\n  - `width`: The width of the screenshot (default: `1280`).\r\n  - `height`: The height of the screenshot (default: `720`).\r\n  - `x`: The x-coordinate of the screenshot (default: `0`).\r\n  - `y`: The y-coordinate of the screenshot (default: `0`).\r\n  - `noJS`: Disable JavaScript on the website (default: `false`).\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbinary-blazer%2Fshbrw","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbinary-blazer%2Fshbrw","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbinary-blazer%2Fshbrw/lists"}