{"id":13630640,"url":"https://github.com/christopherwk210/site-scan","last_synced_at":"2025-04-19T17:34:10.401Z","repository":{"id":57148688,"uuid":"106016044","full_name":"christopherwk210/site-scan","owner":"christopherwk210","description":"CLI for capturing website screenshots, powered by puppeteer.","archived":false,"fork":false,"pushed_at":"2018-10-15T13:56:33.000Z","size":968,"stargazers_count":135,"open_issues_count":5,"forks_count":9,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-03-29T10:51:17.793Z","etag":null,"topics":["cli","node","puppeteer","screenshot"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/christopherwk210.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-06T14:46:41.000Z","updated_at":"2025-01-14T09:44:22.000Z","dependencies_parsed_at":"2022-08-31T23:50:23.333Z","dependency_job_id":null,"html_url":"https://github.com/christopherwk210/site-scan","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christopherwk210%2Fsite-scan","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christopherwk210%2Fsite-scan/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christopherwk210%2Fsite-scan/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/christopherwk210%2Fsite-scan/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/christopherwk210","download_url":"https://codeload.github.com/christopherwk210/site-scan/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249750200,"owners_count":21320095,"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":["cli","node","puppeteer","screenshot"],"created_at":"2024-08-01T22:01:51.754Z","updated_at":"2025-04-19T17:34:10.376Z","avatar_url":"https://github.com/christopherwk210.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"\u003ch1 align=\"center\"\u003esite-scan\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./assets/demo.gif\" alt=\"site-scan easily takes screenshots of websites\"\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003eCLI for capturing website screenshots, powered by \u003ca href=\"https://github.com/GoogleChrome/puppeteer\"\u003epuppeteer\u003c/a\u003e.\u003c/p\u003e\n\n# Installation\n\nTo install globally:\n```\n$ npm install site-scan -g\n```\n\n# Usage\n\nYou can use `sitescan` or just `ss`:\n```\n$ sitescan [options] [url(s)]\n$ ss [options] [url(s)]\n```\n\n# Options\n`-h` or `--help` Display help\n\n`-p` or `--path` Path to save screenshots to (Defaults to CWD)\n\n`-x` or `--width` Custom viewport width (Default: 1920)\n\n`-y` or `--height` Custom viewport height (Default 1080)\n\n`-f` or `--full` Capture full page screenshot (Default: false)\n\n`-t` or `--transparent` Hides default background to allow transparency (Default: false)\n\n`-j` or `--jpeg` Capture JPEG screenshot (Default: PNG)\n\n`-q` or `--quality` Quality of JPEG screenshot (0-100, Default: 100)\n\n`-s` or `--sleep` Time (ms) to wait after load before screenshot (Default: 0)\n\n`-n` or `--name` Custom file name. Multiple screenshots will append a number to this name. (Default: website hostname)\n\n`-r` or `--scale` Custom browser scaling to use (Default: 1)\n\n`-l` or `--list` Loads url(s) from a local file instead of the CLI (must be separated by a space character) (Default: undefined)\n\n# Examples\n\nTake a full page screenshot of a website\n```\n$ ss youtube.com --full\n```\n\nTake a screenshot of multiple websites as JPEGs\n```\n$ ss youtube.com google.com -j\n```\n\nUse a custom resolution\n```\n$ ss github.com -x 640 -y 480\n```\n\nUse a text file of space-separated URLs to load from\n```\n$ ss -l ./path/to/websites_list.txt\n```\n\n# Development\n```\n$ git clone https://github.com/christopherwk210/site-scan\n$ cd site-scan\n$ npm i\n$ node ./lib/site-scan.js\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchristopherwk210%2Fsite-scan","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchristopherwk210%2Fsite-scan","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchristopherwk210%2Fsite-scan/lists"}