{"id":37729240,"url":"https://github.com/omachala/heroshot","last_synced_at":"2026-02-09T16:08:27.963Z","repository":{"id":331664847,"uuid":"1021725053","full_name":"omachala/heroshot","owner":"omachala","description":"Screenshot automation framework. Define once, regenerate forever. Visual picker, multi-viewport, light/dark mode, CI-ready.","archived":false,"fork":false,"pushed_at":"2026-02-07T10:31:05.000Z","size":44955,"stargazers_count":16,"open_issues_count":2,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-07T19:55:28.608Z","etag":null,"topics":["automation","cli","developer-tools","documentation","docusaurus","mkdocs","playwright","screenshot","technical-writing","typescript","vitepress"],"latest_commit_sha":null,"homepage":"https://heroshot.sh","language":"TypeScript","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/omachala.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-07-17T21:07:05.000Z","updated_at":"2026-02-07T10:30:31.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/omachala/heroshot","commit_stats":null,"previous_names":["omachala/heroshot"],"tags_count":28,"template":false,"template_full_name":null,"purl":"pkg:github/omachala/heroshot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omachala%2Fheroshot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omachala%2Fheroshot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omachala%2Fheroshot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omachala%2Fheroshot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/omachala","download_url":"https://codeload.github.com/omachala/heroshot/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omachala%2Fheroshot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29271900,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-09T13:47:44.167Z","status":"ssl_error","status_checked_at":"2026-02-09T13:47:43.721Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["automation","cli","developer-tools","documentation","docusaurus","mkdocs","playwright","screenshot","technical-writing","typescript","vitepress"],"created_at":"2026-01-16T13:46:41.363Z","updated_at":"2026-02-09T16:08:27.947Z","avatar_url":"https://github.com/omachala.png","language":"TypeScript","funding_links":[],"categories":["Screenshot","Utils","Useful Tools","Development Tool","Components \u0026 Libraries"],"sub_categories":["Dev Tools"],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://heroshot.sh\"\u003e\n    \u003cpicture\u003e\n      \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://raw.githubusercontent.com/omachala/heroshot/refs/heads/main/docs/public/screenshots/hero-desktop-dark.png\"\u003e\n      \u003cimg src=\"https://raw.githubusercontent.com/omachala/heroshot/refs/heads/main/docs/public/screenshots/hero-desktop-light.png\" alt=\"heroshot\"\u003e\n    \u003c/picture\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\u003cem\u003e👆 This hero shot of \u003ca href=\"https://heroshot.sh\"\u003eheroshot.sh\u003c/a\u003e is \u003ca href=\"https://github.com/omachala/heroshot/blob/main/.github/workflows/update-screenshots.yml#L17\"\u003etaken\u003c/a\u003e by heroshot ⚡️\u003c/em\u003e\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.npmjs.com/package/heroshot\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/heroshot?style=for-the-badge\u0026logo=npm\" alt=\"npm version\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/omachala/heroshot/blob/main/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/npm/l/heroshot?style=for-the-badge\" alt=\"license\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://codecov.io/gh/omachala/heroshot\"\u003e\u003cimg src=\"https://img.shields.io/codecov/c/github/omachala/heroshot?style=for-the-badge\" alt=\"coverage\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://sonarcloud.io/summary/new_code?id=omachala_heroshot\"\u003e\u003cimg src=\"https://img.shields.io/sonar/quality_gate/omachala_heroshot?server=https%3A%2F%2Fsonarcloud.io\u0026style=for-the-badge\u0026logo=sonarcloud\" alt=\"quality gate\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://heroshot.sh\"\u003e\u003cimg src=\"https://img.shields.io/badge/docs-heroshot.sh-blue?style=for-the-badge\" alt=\"docs\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\nYour app changes constantly. New features, design tweaks, bug fixes. Meanwhile, the screenshots in your README and docs quietly become lies.\n\nThe manual fix is tedious: open browser, navigate, log in, screenshot, crop, save, commit. Now do that for every image. Now do it again next month.\n\n**Heroshot fixes this.** Define your screenshots once - point and click, no CSS selectors - and regenerate them with one command whenever you need.\n\n```bash\nnpx heroshot\n```\n\nFirst run opens a browser with a visual picker. Click what you want, name it, done. Screenshots land in `heroshots/`, config saves to `.heroshot/config.json`. Next run regenerates everything headlessly.\n\nhttps://github.com/user-attachments/assets/f35600a6-9220-4bd2-a8c6-a6b4ee8a33d9\n\n## Use in Your Docs\n\n**VitePress** · [Full guide](https://heroshot.sh/docs/integrations/vitepress)\n\n```ts\n// .vitepress/config.ts\nimport { heroshot } from 'heroshot/plugins/vite';\nexport default defineConfig({ vite: { plugins: [heroshot()] } });\n```\n\n```vue\n\u003cscript setup\u003e\nimport { Heroshot } from 'heroshot/vue';\n\u003c/script\u003e\n\n\u003cHeroshot name=\"dashboard\" alt=\"Dashboard\" /\u003e\n```\n\n**Docusaurus** · [Full guide](https://heroshot.sh/docs/integrations/docusaurus)\n\n```js\n// docusaurus.config.js\nplugins: [['heroshot/plugins/docusaurus', {}]];\n```\n\n```tsx\nimport { Heroshot } from 'heroshot/docusaurus';\n\u003cHeroshot name=\"dashboard\" alt=\"Dashboard\" /\u003e;\n```\n\n**MkDocs** · [Full guide](https://heroshot.sh/docs/integrations/mkdocs)\n\n```yaml\n# mkdocs.yml\nplugins:\n  - macros:\n      modules: [heroshot]\n```\n\n```jinja\n{{ heroshot(\"dashboard\", \"Dashboard overview\") }}\n```\n\nOne component/macro, all variants - light/dark mode switches automatically, responsive sizes via srcset.\n\n## One Screenshot - All Variants\n\n\u003ctable align=\"center\"\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003cimg src=\"https://github.com/omachala/heroshot/blob/main/docs/public/screenshots/hero-desktop-light.png?raw=true\" alt=\"Desktop Light\"\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003cimg src=\"https://github.com/omachala/heroshot/blob/main/docs/public/screenshots/hero-desktop-dark.png?raw=true\" alt=\"Desktop Dark\"\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003cimg src=\"https://github.com/omachala/heroshot/blob/main/docs/public/screenshots/hero-tablet-light.png?raw=true\" alt=\"Tablet Light\"\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003cimg src=\"https://github.com/omachala/heroshot/blob/main/docs/public/screenshots/hero-tablet-dark.png?raw=true\" alt=\"Tablet Dark\"\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003e\u003cimg src=\"https://github.com/omachala/heroshot/blob/main/docs/public/screenshots/hero-mobile-light.png?raw=true\" alt=\"Mobile Light\"\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003cimg src=\"https://github.com/omachala/heroshot/blob/main/docs/public/screenshots/hero-mobile-dark.png?raw=true\" alt=\"Mobile Dark\"\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003cp align=\"center\"\u003e\u003cem\u003e6 screenshots from one config entry - always in sync with the live site.\u003c/em\u003e\u003c/p\u003e\n\n## Learn More\n\n|                     |                                                                       |\n| ------------------- | --------------------------------------------------------------------- |\n| **Documentation**   | [heroshot.sh](https://heroshot.sh)                                    |\n| **Getting Started** | [Quick start guide](https://heroshot.sh/docs/getting-started)         |\n| **Configuration**   | [Config options](https://heroshot.sh/docs/config)                     |\n| **CI/CD Setup**     | [Automated updates](https://heroshot.sh/docs/guide/automated-updates) |\n| **CLI Reference**   | [All commands \u0026 flags](https://heroshot.sh/docs/cli)                  |\n\n## Contributing\n\nThis is a community project aiming to solve screenshot automation end-to-end and any feedback is valuable. Open an [issue](https://github.com/omachala/heroshot/issues) for bugs, questions, or feature requests. Pull requests are more than welcome.\n\nIf you like it, give the repo a ⭐\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fomachala%2Fheroshot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fomachala%2Fheroshot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fomachala%2Fheroshot/lists"}