TermGIFforge 👾

Turn your terminal recordings into captivating GIFs effortlessly. Ideal for tutorials, documentation, and sharing terminal workflows.

Use this API to present creative ways of your software commands.

Table of Contents

• TermGIFforge 👾
  • Table of Contents
  • Instructions
  • How to run
    • Locally w/ docker 🐳
  • Troubleshooting
  • Contributing
  • Support
  • References

Instructions

TermGIFforge uses the VHS to generate the GIFs, here you'll find the command references to generate your own GIFs. Try:

• http://terminalgifapi.com/api/v1/gif?commands=["Type \"echo 'The Magic Happens Here'\"","Enter","Sleep 2s"]
• http://terminalgifapi.com/api/v1/gif?commands=[ "Set FontSize 50", "Set TypingSpeed 75ms", "Type \"echo \"", "Set TypingSpeed 500ms", "Type \"'YEY\"", "Set TypingSpeed 75ms", "Type \"!!!'\"", "Sleep 100ms", "Enter", "Sleep 2s"]
• http://terminalgifapi.com/api/v1/gif?commands=["Type \"echo 'Welcome to VHS!'\"","Enter","Type \"ls\"","Sleep 100ms","Enter","Sleep 2s"]

How to run

Locally w/ docker 🐳

Then, from browser or Bruno, open:

• http://localhost:9001/api/v1/gif?commands=["Type \"echo Hi\"","Enter","Sleep 2s"]

Troubleshooting

• How to encode the URL to use in the HTML tag?
  • Simply enter your URL to the browser and it'll parse it to you.
• How to force image (cache) update in README.rst on GitHub?
  • run curl -X PURGE {url of cached badge image} and refresh the page (reference).

Contributing

Contributions are welcome! Feel free to open issues or fork the repo and submit pull requests to enhance the project.

Support

References

• https://github.com/charmbracelet/vhs