[ { "path": ".gitattributes", "content": "**/*.gif filter=lfs diff=lfs merge=lfs -text\n**/*.mp4 filter=lfs diff=lfs merge=lfs -text\n**/*.webm filter=lfs diff=lfs merge=lfs -text\n**/*.png filter=lfs diff=lfs merge=lfs -text\n*.tape linguist-language=elixir\nthemes*.json linguist-generated\nTHEMES.md linguist-generated\n" }, { "path": ".github/CODEOWNERS", "content": "* @charmbracelet/everyone\n" }, { "path": ".github/ISSUE_TEMPLATE/bug_report.md", "content": "---\nname: Bug report\nabout: Create a report to help us improve\ntitle: ''\nlabels: ''\nassignees: ''\n\n---\n\n**Describe the bug**\nA clear and concise description of what the bug is.\n\n**Setup**\nPlease complete the following information along with version numbers, if applicable.\n - OS [e.g. Ubuntu, macOS]\n - Shell [e.g. zsh, fish]\n - Terminal Emulator [e.g. kitty, iterm]\n - Terminal Multiplexer [e.g. tmux]\n\n**To Reproduce**\nSteps to reproduce the behavior:\n1. Go to '...'\n2. Click on '....'\n3. Scroll down to '....'\n4. See error\n\n**Source Code**\nPlease include source code if needed to reproduce the behavior. \n\n**Expected behavior**\nA clear and concise description of what you expected to happen.\n\n**Screenshots**\nAdd screenshots to help explain your problem.\n\n**Additional context**\nAdd any other context about the problem here.\n" }, { "path": ".github/ISSUE_TEMPLATE/config.yml", "content": "blank_issues_enabled: true\ncontact_links:\n- name: Discord\n url: https://charm.sh/discord\n about: Chat on our Discord.\n" }, { "path": ".github/ISSUE_TEMPLATE/feature_request.md", "content": "---\nname: Feature request\nabout: Suggest an idea for this project\ntitle: ''\nlabels: enhancement\nassignees: ''\n\n---\n\n**Is your feature request related to a problem? Please describe.**\nA clear and concise description of what the problem is. Ex. I'm always frustrated when [...]\n\n**Describe the solution you'd like**\nA clear and concise description of what you want to happen.\n\n**Describe alternatives you've considered**\nA clear and concise description of any alternative solutions or features you've considered.\n\n**Additional context**\nAdd any other context or screenshots about the feature request here.\n" }, { "path": ".github/dependabot.yml", "content": "version: 2\n\nupdates:\n - package-ecosystem: \"gomod\"\n directory: \"/\"\n schedule:\n interval: \"weekly\"\n day: \"monday\"\n time: \"05:00\"\n timezone: \"America/New_York\"\n labels:\n - \"dependencies\"\n commit-message:\n prefix: \"chore\"\n include: \"scope\"\n groups:\n all:\n patterns:\n - \"*\"\n ignore:\n - dependency-name: github.com/charmbracelet/bubbletea/v2\n versions:\n - v2.0.0-beta1\n\n - package-ecosystem: \"github-actions\"\n directory: \"/\"\n schedule:\n interval: \"weekly\"\n day: \"monday\"\n time: \"05:00\"\n timezone: \"America/New_York\"\n labels:\n - \"dependencies\"\n commit-message:\n prefix: \"chore\"\n include: \"scope\"\n groups:\n all:\n patterns:\n - \"*\"\n\n - package-ecosystem: \"docker\"\n directory: \"/\"\n schedule:\n interval: \"weekly\"\n day: \"monday\"\n time: \"05:00\"\n timezone: \"America/New_York\"\n labels:\n - \"dependencies\"\n commit-message:\n prefix: \"chore\"\n include: \"scope\"\n groups:\n all:\n patterns:\n - \"*\"\n" }, { "path": ".github/workflows/build.yml", "content": "name: build\n\non: [push, pull_request]\n\njobs:\n build:\n uses: charmbracelet/meta/.github/workflows/build.yml@main\n\n snapshot:\n uses: charmbracelet/meta/.github/workflows/snapshot.yml@main\n secrets:\n goreleaser_key: ${{ secrets.GORELEASER_KEY }}\n" }, { "path": ".github/workflows/dependabot-sync.yml", "content": "name: dependabot-sync\non:\n schedule:\n - cron: \"0 0 * * 0\" # every Sunday at midnight\n workflow_dispatch: # allows manual triggering\n\npermissions:\n contents: write\n pull-requests: write\n\njobs:\n dependabot-sync:\n uses: charmbracelet/meta/.github/workflows/dependabot-sync.yml@main\n with:\n repo_name: ${{ github.event.repository.name }}\n secrets:\n gh_token: ${{ secrets.PERSONAL_ACCESS_TOKEN }}\n" }, { "path": ".github/workflows/goreleaser.yml", "content": "# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json\n\nname: goreleaser\n\non:\n push:\n tags:\n - v*.*.*\n\nconcurrency:\n group: goreleaser\n cancel-in-progress: true\n\njobs:\n goreleaser:\n uses: charmbracelet/meta/.github/workflows/goreleaser.yml@main\n secrets:\n docker_username: ${{ secrets.DOCKERHUB_USERNAME }}\n docker_token: ${{ secrets.DOCKERHUB_TOKEN }}\n gh_pat: ${{ secrets.PERSONAL_ACCESS_TOKEN }}\n goreleaser_key: ${{ secrets.GORELEASER_KEY }}\n aur_key: ${{ secrets.AUR_KEY }}\n fury_token: ${{ secrets.FURY_TOKEN }}\n nfpm_gpg_key: ${{ secrets.NFPM_GPG_KEY }}\n nfpm_passphrase: ${{ secrets.NFPM_PASSPHRASE }}\n macos_sign_p12: ${{ secrets.MACOS_SIGN_P12 }}\n macos_sign_password: ${{ secrets.MACOS_SIGN_PASSWORD }}\n macos_notary_issuer_id: ${{ secrets.MACOS_NOTARY_ISSUER_ID }}\n macos_notary_key_id: ${{ secrets.MACOS_NOTARY_KEY_ID }}\n macos_notary_key: ${{ secrets.MACOS_NOTARY_KEY }}\n" }, { "path": ".github/workflows/lint-sync.yml", "content": "name: lint-sync\non:\n schedule:\n # every Sunday at midnight\n - cron: \"0 0 * * 0\"\n workflow_dispatch: # allows manual triggering\n\npermissions:\n contents: write\n pull-requests: write\n\njobs:\n lint:\n uses: charmbracelet/meta/.github/workflows/lint-sync.yml@main\n" }, { "path": ".github/workflows/lint.yml", "content": "name: lint\non:\n push:\n pull_request:\n\njobs:\n lint:\n uses: charmbracelet/meta/.github/workflows/lint.yml@main\n with:\n golangci_path: .golangci.yml\n" }, { "path": ".github/workflows/nightly.yml", "content": "name: nightly\n\non:\n push:\n branches:\n - main\n\njobs:\n nightly:\n uses: charmbracelet/meta/.github/workflows/nightly.yml@main\n secrets:\n docker_username: ${{ secrets.DOCKERHUB_USERNAME }}\n docker_token: ${{ secrets.DOCKERHUB_TOKEN }}\n goreleaser_key: ${{ secrets.GORELEASER_KEY }}\n macos_sign_p12: ${{ secrets.MACOS_SIGN_P12 }}\n macos_sign_password: ${{ secrets.MACOS_SIGN_PASSWORD }}\n macos_notary_issuer_id: ${{ secrets.MACOS_NOTARY_ISSUER_ID }}\n macos_notary_key_id: ${{ secrets.MACOS_NOTARY_KEY_ID }}\n macos_notary_key: ${{ secrets.MACOS_NOTARY_KEY }}\n" }, { "path": ".gitignore", "content": ".DS_Store\n.ssh/\ncaptures/\ntmp/\nframes/\nmanpages\ncompletions\ndist\nvhs\n.idea/\n.vscode/\n" }, { "path": ".golangci.yml", "content": "version: \"2\"\nrun:\n tests: false\nlinters:\n enable:\n - bodyclose\n - exhaustive\n - goconst\n - godot\n - gomoddirectives\n - goprintffuncname\n - gosec\n - misspell\n - nakedret\n - nestif\n - nilerr\n - noctx\n - nolintlint\n - prealloc\n - revive\n - rowserrcheck\n - sqlclosecheck\n - tparallel\n - unconvert\n - unparam\n - whitespace\n - wrapcheck\n exclusions:\n rules:\n - text: '(slog|log)\\.\\w+'\n linters:\n - noctx\n - text: \"var-naming\"\n linters:\n - revive\n - text: \"G705\"\n linters:\n - gosec\n - text: \"G115\"\n linters:\n - gosec\n - text: \"os/exec.Command must not be called\"\n linters:\n - noctx\n generated: lax\n presets:\n - common-false-positives\n settings:\n exhaustive:\n default-signifies-exhaustive: true\nissues:\n max-issues-per-linter: 0\n max-same-issues: 0\nformatters:\n enable:\n - gofumpt\n - goimports\n exclusions:\n generated: lax\n" }, { "path": ".goreleaser.yml", "content": "version: 2\n\nincludes:\n - from_url:\n url: charmbracelet/meta/main/goreleaser-vhs.yaml\n\nvariables:\n main: \".\"\n description: \"A tool for recording terminal GIFs\"\n github_url: \"https://github.com/charmbracelet/vhs\"\n maintainer: \"Maas Lalani \"\n brew_commit_author_name: \"Maas Lalani\"\n brew_commit_author_email: \"maas@charm.sh\"\n" }, { "path": "Dockerfile", "content": "FROM tsl0922/ttyd:alpine as ttyd\nFROM alpine:latest as fontcollector\n\n# Install Fonts\nRUN apk add --no-cache \\\n --repository=http://dl-cdn.alpinelinux.org/alpine/edge/main \\\n --repository=http://dl-cdn.alpinelinux.org/alpine/edge/community \\\n --repository=http://dl-cdn.alpinelinux.org/alpine/edge/testing \\\n font-adobe-source-code-pro font-source-code-pro-nerd \\\n font-dejavu font-dejavu-sans-mono-nerd \\\n font-fira-code font-fira-code-nerd \\\n font-hack font-hack-nerd \\\n font-ibm-plex-mono-nerd \\\n font-inconsolata font-inconsolata-nerd \\\n font-jetbrains-mono font-jetbrains-mono-nerd \\\n font-liberation font-liberation-mono-nerd \\\n font-noto \\\n font-roboto-mono \\\n # font-ubuntu font-ubuntu-mono-nerd \\ # Alpine no longer has this font\n font-noto-emoji\n\nFROM debian:stable-slim\n\nRUN apt-get update\n\n# Add fonts\nCOPY --from=fontcollector /usr/share/fonts/ /usr/share/fonts\n\n# Install latest ttyd\nCOPY --from=ttyd /usr/bin/ttyd /usr/bin/ttyd\n\n# Expose port\nEXPOSE 1976\n\n# Create volume\nVOLUME /vhs\nWORKDIR /vhs\n\n# Install Dependencies\nRUN apt-get -y install ffmpeg chromium bash\n\n# Create user\nRUN useradd -u 1976 -U -s /bin/false vhs\n# Mimic alpine default color option\nRUN echo 'alias ls=\"ls --color\"' >> ~/.bashrc\n# Install\nCOPY vhs /usr/bin/\n\nENV VHS_PORT=\"1976\"\nENV VHS_HOST=\"0.0.0.0\"\nENV VHS_GID=\"1976\"\nENV VHS_UID=\"1976\"\nENV VHS_KEY_PATH=\"/vhs/vhs\"\nENV VHS_AUTHORIZED_KEYS_PATH=\"\"\nENV VHS_NO_SANDBOX=\"true\"\n\nENTRYPOINT [\"/usr/bin/vhs\"]\n" }, { "path": "LICENSE", "content": "MIT License\n\nCopyright (c) 2022-2023 Charmbracelet, Inc\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n" }, { "path": "Makefile", "content": "themes.json:\n\t# this is the url used by https://windowsterminalthemes.dev/\n\t# See https://github.com/atomcorp/themes/blob/master/app/src/App.tsx#L18\n\t@./scripts/download_theme.sh \\\n\t\thttps://2zrysvpla9.execute-api.eu-west-2.amazonaws.com/prod/themes \\\n\t\tthemes\n\nTHEMES.md:\n\t@go run . themes --markdown 2> THEMES.md\n\nall: themes.json THEMES.md\n\t@echo \"Running all\"\n\nrefresh:\n\t@rm -rf themes.json themes.json THEMES.md\n\t@$(MAKE) all\n\n" }, { "path": "README.md", "content": "# VHS\n\n

\n \n \n
\n \"Latest\n \"Go\n \"Build\n

\n\nWrite terminal GIFs as code for integration testing and demoing your CLI tools.\n\n\"Welcome\n\nThe above example was generated with VHS ([view source](./examples/neofetch/neofetch.tape)).\n\n## Tutorial\n\nTo get started, [install VHS](#installation) and create a new `.tape` file.\n\n```sh\nvhs new demo.tape\n```\n\nOpen the `.tape` file with your favorite `$EDITOR`.\n\n```sh\nvim demo.tape\n```\n\nTape files consist of a series of [commands](#vhs-command-reference). The commands are\ninstructions for VHS to perform on its virtual terminal. For a list of all\npossible commands see [the command reference](#vhs-command-reference).\n\n```elixir\n# Where should we write the GIF?\nOutput demo.gif\n\n# Set up a 1200x600 terminal with 46px font.\nSet FontSize 46\nSet Width 1200\nSet Height 600\n\n# Type a command in the terminal.\nType \"echo 'Welcome to VHS!'\"\n\n# Pause for dramatic effect...\nSleep 500ms\n\n# Run the command by pressing enter.\nEnter\n\n# Admire the output for a bit.\nSleep 5s\n```\n\nOnce you've finished, save the file and feed it into VHS.\n\n```sh\nvhs demo.tape\n```\n\nAll done! You should see a new file called `demo.gif` (or whatever you named\nthe `Output`) in the directory.\n\n\n \n \n \"A\n\n\nFor more examples see the [`examples/`](https://github.com/charmbracelet/vhs/tree/main/examples) directory.\n\n## Installation\n\n> [!NOTE]\n> VHS requires [`ttyd`](https://github.com/tsl0922/ttyd) and [`ffmpeg`](https://ffmpeg.org) to be installed and available on your `PATH`.\n\nUse a package manager:\n\n```sh\n# macOS or Linux\nbrew install vhs\n\n# Arch Linux (btw)\npacman -S vhs\n\n# Nix\nnix-env -iA nixpkgs.vhs\n\n# Windows using scoop\nscoop install vhs\n```\n\nOr, use Docker to run VHS directly, dependencies included:\n\n```sh\ndocker run --rm -v $PWD:/vhs ghcr.io/charmbracelet/vhs .tape\n```\n\nOr, download it:\n\n- [Packages][releases] are available in Debian and RPM formats\n- [Binaries][releases] are available for Linux, macOS, and Windows\n\nOr, just install it with `go`:\n\n```sh\ngo install github.com/charmbracelet/vhs@latest\n```\n\n
\nWindows, Debian, Ubuntu, Fedora, RHEL, Void Instructions\n\n- Debian / Ubuntu\n\n```sh\n# Debian/Ubuntu\nsudo mkdir -p /etc/apt/keyrings\ncurl -fsSL https://repo.charm.sh/apt/gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/charm.gpg\necho \"deb [signed-by=/etc/apt/keyrings/charm.gpg] https://repo.charm.sh/apt/ * *\" | sudo tee /etc/apt/sources.list.d/charm.list\n# Install ttyd from https://github.com/tsl0922/ttyd/releases\nsudo apt update && sudo apt install vhs ffmpeg\n```\n\n- Fedora / RHEL\n\n```sh\necho '[charm]\nname=Charm\nbaseurl=https://repo.charm.sh/yum/\nenabled=1\ngpgcheck=1\ngpgkey=https://repo.charm.sh/yum/gpg.key' | sudo tee /etc/yum.repos.d/charm.repo\n# Install ttyd from https://github.com/tsl0922/ttyd/releases\nsudo yum install vhs ffmpeg\n```\n\n- Void\n\n```sh\nsudo xbps-install vhs\n```\n\n- Windows\n\n```sh\nwinget install charmbracelet.vhs\n# or scoop\nscoop install vhs\n```\n\n
\n\n[releases]: https://github.com/charmbracelet/vhs/releases\n\n## Record Tapes\n\nVHS has the ability to generate tape files from your terminal actions!\n\nTo record to a tape file, run:\n\n```bash\nvhs record > cassette.tape\n```\n\nPerform any actions you want and then `exit` the terminal session to stop\nrecording. You may want to manually edit the generated `.tape` file to add\nsettings or modify actions. Then, you can generate the GIF:\n\n```bash\nvhs cassette.tape\n```\n\n## Publish Tapes\n\nVHS allows you to publish your GIFs to our servers for easy sharing with your\nfriends and colleagues. Specify which file you want to share, then use the\n`publish` sub-command to host it on `vhs.charm.sh`. The output will provide you\nwith links to share your GIF via browser, HTML, and Markdown.\n\n```bash\nvhs publish demo.gif\n```\n\n## The VHS Server\n\nVHS has an SSH server built in! When you self-host VHS you can access it as\nthough it were installed locally. VHS will have access to commands and\napplications on the host, so you don't need to install them on your machine.\n\nTo start the server run:\n\n```sh\nvhs serve\n```\n\n
\nConfiguration Options\n\n- `VHS_PORT`: The port to listen on (`1976`)\n- `VHS_HOST`: The host to listen on (`localhost`)\n- `VHS_GID`: The Group ID to run the server as (current user's GID)\n- `VHS_UID`: The User ID to run the server as (current user's UID)\n- `VHS_KEY_PATH`: The path to the SSH key to use (`.ssh/vhs_ed25519`)\n- `VHS_AUTHORIZED_KEYS_PATH`: The path to the authorized keys file (empty, publicly accessible)\n\n
\n\nThen, simply access VHS from a different machine via `ssh`:\n\n```sh\nssh vhs.example.com < demo.tape > demo.gif\n```\n\n## VHS Command Reference\n\n> [!NOTE]\n> You can view all VHS documentation on the command line with `vhs manual`.\n\nThere are a few basic types of VHS commands:\n\n- [`Output `](#output): specify file output\n- [`Require `](#require): specify required programs for tape file\n- [`Set Value`](#settings): set recording settings\n- [`Type \"\"`](#type): emulate typing\n- [`Left`](#arrow-keys) [`Right`](#arrow-keys) [`Up`](#arrow-keys) [`Down`](#arrow-keys): arrow keys\n- [`Backspace`](#backspace) [`Enter`](#enter) [`Tab`](#tab) [`Space`](#space): special keys\n- [`ScrollUp`](#scroll-up--down) [`ScrollDown`](#scroll-up--down): scroll terminal viewport\n- [`Ctrl[+Alt][+Shift]+`](#ctrl): press control + key and/or modifier\n- [`Sleep