faressoft /terminalizer

🦄 Record your terminal and generate animated gif images or share a web player

★ 16,171⑂ 521👁 123⑃ 70● 182▤ 0
JavaScriptMITCreated 2018-07-22terminalizer.com
-1
日增长
16,171
stars
521
forks
123
watchers
70
prs
182
issues
0
releases

README

Terminalizer







 Record your terminal and generate animated gif images or share a web player link www.terminalizer.com



Built to be jusT cOol 👌🦄 !

 If you think so, support me with a star and a follow 😘

---



---

 Table of Contents

- Terminalizer
- Table of Contents
- Features
- What's Next
- Installation
- Getting Started
  - Compression
- Usage
  - Init
  - Config
  - Record
  - Play
  - Render
  - Share
  - Generate
- Configurations
  - Recording
  - Delays
  - GIF
  - Terminal
  - Theme
  - Watermark
  - Frame Box
    - Null Frame
    - Window Frame
    - Floating Frame
    - Solid Frame
    - Solid Frame Without Title
    - Styling Hint
- FAQ
  - How to support ZSH
- Issues
- License

 Features

- Highly customizable.
- Cross platform (Linux, Windows, MacOS).
- Custom window frames.
- Custom font.
- Custom colors.
- Custom styles with CSS.
- Watermark.
- Edit frames and adjust delays before rendering.
- Skipping frames by a step value to reduce the number of rendered frames.
- Render images with texts on them instead of capturing your screen for better quality.
- The ability to configure:
  - The command to capture (bash, powershell.exe, yourOwnCommand, etc)
  - The current working directory.
  - Explicit values for the number of cols and rows.
  - GIF quality and repeating.
  - Frames delays.
  - The max idle time between frames.
  - Cursor style.
  - Font.
  - Font size.
  - Line height.
  - Letter spacing.
  - Theme.

 What's Next

- The Generate command to generate a web player for a recording file.
- Support apt-get, yum, brew installation.

 Installation

You need to install Node.js first, then install the tool globally using this command:

bash
yarn global add terminalizer




 Still facing an issue? Check the Issues section or open a new issue.

The installation should be very smooth with Node.js v4-v16. For newer versions, if the installation is failed, you may need to install the development tools to build the C++ add-ons. Check node-gyp.

 Getting Started

Start recording your terminal using the record command.

bash
terminalizer record demo


A file called demo.yml will be created in the current directory. You can open it using any editor to edit the configurations and the recorded frames. You can replay your recording using the play command.

bash
terminalizer play demo


Now let's render our recording as an animated gif.

bash
terminalizer render demo


 Compression

GIF compression is not implemented yet. For now we recommend https://gifcompressor.com.

 Usage

 You can use the --help option to get more details about the commands and their options

bash
terminalizer  [options]


 Init

 Create a global config directory

bash
terminalizer init


 Config

 Generate a config file in the current directory

bash
terminalizer config


 Record

 Record your terminal and create a recording file

bash
terminalizer record 


Options


-c, --config        Overwrite the default configurations                                  [s

Top issues

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON