{"id":13998373,"url":"https://github.com/charmbracelet/vhs-action","last_synced_at":"2025-07-30T06:03:19.840Z","repository":{"id":62158573,"uuid":"556839024","full_name":"charmbracelet/vhs-action","owner":"charmbracelet","description":"Keep your GIFs up to date with VHS + GitHub actions 📽️","archived":false,"fork":false,"pushed_at":"2025-05-04T00:05:16.000Z","size":3556,"stargazers_count":203,"open_issues_count":9,"forks_count":10,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-04T01:18:19.577Z","etag":null,"topics":["actions","gifs","github","terminal","vhs"],"latest_commit_sha":null,"homepage":"","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/charmbracelet.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-10-24T15:58:46.000Z","updated_at":"2025-05-03T17:56:56.000Z","dependencies_parsed_at":"2023-01-11T17:23:49.255Z","dependency_job_id":"3bb2a1e1-b080-404c-bcf0-9f88ebf3d7e2","html_url":"https://github.com/charmbracelet/vhs-action","commit_stats":{"total_commits":368,"total_committers":6,"mean_commits":"61.333333333333336","dds":0.4320652173913043,"last_synced_commit":"a6e0b8593418ac1a02e6b4e6c1e955624630522d"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charmbracelet%2Fvhs-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charmbracelet%2Fvhs-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charmbracelet%2Fvhs-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/charmbracelet%2Fvhs-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/charmbracelet","download_url":"https://codeload.github.com/charmbracelet/vhs-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252741362,"owners_count":21797027,"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","gifs","github","terminal","vhs"],"created_at":"2024-08-09T19:01:37.314Z","updated_at":"2025-05-08T23:29:54.707Z","avatar_url":"https://github.com/charmbracelet.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# VHS Action\n\nKeep your GIFs up to date with VHS + GitHub actions 📽️\n\n![vhs-action-banner](https://stuff.charm.sh/vhs/vhs-action-banner.png)\n\n\u003cimg alt=\"Welcome to VHS!\" src=\"vhs.gif\" width=\"600\" /\u003e\n\nThe above GIF is automatically generated on CI with GitHub actions and VHS.\n\n## Getting Started\n\nTo get started with GitHub actions you can [read the documentation](https://docs.github.com/en/actions).\n\nTo add `vhs-action` to your project you will need to:\n\n1. Create `.github/workflows/vhs.yml` in your project directory.\n2. Copy one of the [`examples/`](./examples/) into your `vhs.yml`.\n3. Create your tape files with the instructions to perform (See [VHS][vhs] instructions on `.tape` files)\n4. Trigger your action by creating a pull request or making a commit depending on your `vhs.yml` file.\n\nThat's all! Anytime the action is triggered, GitHub actions and VHS will regenerate the GIF from your `.tape` file on CI.\nThis is useful for keeping demos updated and performing integration testing to catch errors in your PRs.\n\n## Inputs\n\n| Name            | Description                    | Default                                                 |\n| --------------- | ------------------------------ | ------------------------------------------------------- |\n| `path`          | Path of the VHS `.tape` file   | `\"\"` (install VHS without running it)                   |\n| `version`       | Version of VHS to use          | `\"latest\"`                                              |\n| `token`         | GitHub token to use            | `\"${{ github.token }}\"`                                 |\n| `install-fonts` | Whether to install extra fonts | `\"false\"`                                               |\n\nThe action provides `JetBrains Mono` by default. Extra fonts (and their\n[nerd font][nerdfonts] variations) can be installed by setting `install-fonts`\nto `true`.\n\n\u003cdetails\u003e\n\u003csummary\u003eExtra fonts\u003c/summary\u003e\n\n- Bitstream Vera Sans Mono\n- DejaVu\n- Fira Code\n- Hack\n- IBM Plex Mono\n- Inconsolata\n- Liberation\n- Roboto Mono\n- Source Code Pro\n- Ubuntu Mono\n\n\u003c/details\u003e\n\n## Examples\n\n- Auto-commit latest generated GIF file ([example](./examples/auto-commit.yml))\n- Upload GIF to host and comment generated GIF on a pull request ([example](./examples/comment-pr.yml))\n\n## Feedback\n\nWe’d love to hear your thoughts on this project. Feel free to drop us a note!\n\n- [Twitter](https://twitter.com/charmcli)\n- [The Fediverse](https://mastodon.social/@charmcli)\n- [Discord](https://charm.sh/chat)\n\n## License\n\n[MIT](https://github.com/charmbracelet/vhs/raw/main/LICENSE)\n\n---\n\nPart of [Charm](https://charm.sh).\n\n\u003ca href=\"https://charm.sh/\"\u003e\n  \u003cimg\n    alt=\"The Charm logo\"\n    width=\"400\"\n    src=\"https://stuff.charm.sh/charm-badge.jpg\"\n  /\u003e\n\u003c/a\u003e\n\nCharm热爱开源 • Charm loves open source\n\n[vhs]: https://github.com/charmbracelet/vhs\n[nerdfonts]: https://www.nerdfonts.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcharmbracelet%2Fvhs-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcharmbracelet%2Fvhs-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcharmbracelet%2Fvhs-action/lists"}