term2gif 0.1.0

A simple and lightweight static GIF generator.

termgif

A simple and lightweight static GIF generator!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

"Creating clean, visually appealing demo screenshots for command-line tutorials can often be a tedious hassle—working with asciinema and ffmpeg involves a convoluted workflow. In reality, however, simply feeding it an API will resolve all such issues."

termgif is a lightweight tool for static-build GIF generation. On Windows it records your terminal command execution (producing a cast JSON), then renders the captured output into an animated GIF.

The goal is simple: make command-line demos more visual and lightweight.

Main flow:

1. Record: run the target command and capture terminal output (record_win.py)
2. Convert: render the cast JSON into GIF frames (convert_cast_to_gif / convert.py)
3. Generate: write the GIF to the specified output path

🔝back to top

Built With

• 
• 
• 
• 

🔝back to top

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• Hatch (if exists)

  # print all dependencies
  hatch dep show
  # print dependencies on group dep
  hatch dep show dev
  

Installation

1. Clone the repo

   git clone https://github.com/FishgameStudio/termgif.git
   

2. Install PIP packages

   pip install .
   

3. Change git remote url to avoid accidental pushes to base project

   git remote remove origin
   git remote -v # confirm the changes
   

🔝back to top

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation or Examples

🔝back to top

Roadmap

• v0.1.0: Basic recording for Windows
• v0.2.0:
  • Support for macOS and Linux
  • Support for recording live inputting text on console (stdin)
  • Support recording live console (with echo and color)

See the open issues for a full list of proposed features (and known issues).

🔝back to top

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

🔝back to top

Top contributors:

License

Distributed under the project_license. See LICENSE for more information.

🔝back to top

Contact

Nicola Grey - [e-mail]

Project Link: https://github.com/FishgameStudio/termgif

🔝back to top

Acknowledgments

• Best-README-Template
• Pillow
• pyte
• winpty
• pywinpty

🔝back to top