{"id":20217612,"url":"https://github.com/pforret/screenshots","last_synced_at":"2026-04-29T21:37:34.378Z","repository":{"id":166002296,"uuid":"641405796","full_name":"pforret/screenshots","owner":"pforret","description":"Let GitHub automatically make 📸 screenshots of all your websites","archived":false,"fork":false,"pushed_at":"2023-05-16T13:43:48.000Z","size":17059,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-13T22:21:24.677Z","etag":null,"topics":["actions","bashew","playwright","screenshot"],"latest_commit_sha":null,"homepage":"","language":"Shell","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/pforret.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-05-16T12:01:15.000Z","updated_at":"2023-05-17T07:20:26.000Z","dependencies_parsed_at":null,"dependency_job_id":"506cdbb1-ce02-468a-a133-264891713cc1","html_url":"https://github.com/pforret/screenshots","commit_stats":null,"previous_names":[],"tags_count":6,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pforret%2Fscreenshots","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pforret%2Fscreenshots/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pforret%2Fscreenshots/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pforret%2Fscreenshots/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pforret","download_url":"https://codeload.github.com/pforret/screenshots/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241654769,"owners_count":19997929,"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":["actions","bashew","playwright","screenshot"],"created_at":"2024-11-14T06:34:49.682Z","updated_at":"2025-11-29T21:11:34.124Z","avatar_url":"https://github.com/pforret.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"![GH Language](https://img.shields.io/github/languages/top/pforret/screenshots)\n![GH stars](https://img.shields.io/github/stars/pforret/screenshots)\n![GH tag](https://img.shields.io/github/v/tag/pforret/screenshots)\n![GH License](https://img.shields.io/github/license/pforret/screenshots)\n[![Take screenshots](https://github.com/pforret/screenshots/actions/workflows/screenshots.yml/badge.svg)](https://github.com/pforret/screenshots/actions/workflows/screenshots.yml)\n\n# pforret/screenshots\n\n![](assets/screenshots.jpg)\n\nLet GitHub automatically make screenshots of all your websites\n\n## Usage \n\nCreate new repo with this one as template\n\n![img.png](assets/use_template.png)\n\n\n### Method 1 (CLI)\n```bash\n# clone the new repo to your local machine\ngit clone git@github.com:\u003cyour username\u003e/\u003cyour repo\u003e.git\ncd \u003cyour repo\u003e\n\n# remove all images from the images folder\nrm images/*.png\n\n# replace the URLS in sites.txt by your own URLs\necho \"https://www.yoursite.com\" \u003e sites.txt\necho \"https://www.yourothersite.com\" \u003e\u003e sites.txt\n...\n\n# check in the repo with changes\ngit -a -m \"new sites\"\n\n# wait until Github Actions have run and created all your screenshots\n\n# now get the updated image files\ngit pull\n```\n\n### Method 2 (GitHub UI)\n\nOr just edit the `sites.txt` file on github.com\n\n![img.png](assets/edit_on_github.png)\n\n\n## Run locally\n\nYou can also run the screenshot process locally on your machine. You will need to install shot-scraper. \n\n```bash\n# clone the new repo to your local machine\ngit clone git@github.com:\u003cyour username\u003e/\u003cyour repo\u003e.git\ncd \u003cyour repo\u003e\n\n# install shot-scraper\npip install shot-scraper\n\n# remove all images from the images folder\nrm images/*.png\n\n# replace the URLS in sites.txt by your own URLs\necho \"https://www.yoursite.com\" \u003e sites.txt\necho \"https://www.yourothersite.com\" \u003e\u003e sites.txt\n...\n\n# check in the repo with changes\ngit -a -m \"new sites\"\n\n# wait until Github Actions have run and created all your screenshots\n\n# now get the updated image files\ngit pull\n```\n\n## Script screenshots.sh\n\n```bash\nProgram : screenshots.sh  by peter@forret.com\nVersion : v1.0.0 (2023-05-16 15:16)\nPurpose : take the screensots with shotscraper\nUsage   : screenshots.sh [-h] [-q] [-v] [-f] [-l \u003clog_dir\u003e] [-t \u003ctmp_dir\u003e] [-o \u003cout_dir\u003e] [-d \u003cdelay\u003e] [-w \u003cwidth\u003e] [-h \u003cheight\u003e] [-x \u003cexport\u003e] \u003caction\u003e \u003cinput?\u003e\nFlags, options and parameters:\n    -h|--help        : [flag] show usage [default: off]\n    -q|--quiet       : [flag] no output [default: off]\n    -v|--verbose     : [flag] also show debug messages [default: off]\n    -f|--force       : [flag] do not ask for confirmation (always yes) [default: off]\n    -l|--log_dir \u003c?\u003e : [option] folder for log files   [default: log]\n    -t|--tmp_dir \u003c?\u003e : [option] folder for temp files  [default: tmp]\n    -o|--out_dir \u003c?\u003e : [option] output folder for screenshots  [default: images]\n    -d|--delay \u003c?\u003e   : [option] seconds to wait for the git action to finish  [default: 80]\n    -w|--width \u003c?\u003e   : [option] screenshot width  [default: 1920]\n    -h|--height \u003c?\u003e  : [option] screenshot height  [default: 1080]\n    -x|--export \u003c?\u003e  : [option] export list of screenshots in Markdown format  [default: index.md]\n    \u003caction\u003e         : [choice] action to perform  [options: multi,gha:deploy,gha:update,check,env,update]\n    \u003cinput\u003e          : [parameter] input file/text (optional)\n \n``` \n\n## Based on\n\n* [github.com/features/actions](https://github.com/features/actions): Github Actions\n* [simonw/shot-scraper](https://github.com/simonw/shot-scraper): Playwright based CLI screenshotting - which is based on\n* [microsoft/playwright-python](https://github.com/microsoft/playwright-python): Playwright testing and automation library\n* [pforret/bashew](https://github.com/pforret/bashew): bash micro-framework","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpforret%2Fscreenshots","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpforret%2Fscreenshots","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpforret%2Fscreenshots/lists"}