faressoft / terminalizer

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 and a 😘 --- --- 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 . • Custom . • Custom . • Custom with . • 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 command to generate a web player for a recording file. • Support , , installation. Installation You need to install Node.js first, then install the tool globally using this command: > 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 add-ons. Check node-gyp. Getting Started Start recording your terminal using the command. A file called 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 command. Now let's render our recording as an animated gif. Compression GIF compression is not implemented yet. For now we recommend https://gifcompressor.com. Usage > You can use the option to get more details about the commands and their options Init > Create a global config directory Config > Generate a config file in the current directory Record > Record your terminal and create a recording file Options Examples Play > Play a recording file on your terminal Options Render > Render a recording file as an animated gif image Options Share > Upload a recording file and get a link for an online player Generate > Generate a web player for a recording file Configurations The default file is stored under the root directory of the project. Execute the below command to copy it to your current directory. > Use any editor to edit the copied , then use the option to override the default one. > RECOMMENDED, use the command to create a global config file to be used instead of the default one. For Linux and MacOS, the created directory is located under the home directory . For Windows, it is located under the . Recording • : Specify a command to be executed like , , or any other command. The default is for or for . • : Specify the current working directory path. The default is the current working directory path. • : Export additional ENV variables, to be read by your scripts when starting the recording. • : Explicitly set the number of columns or use to take the current number of columns of your shell. • : Explicitly set the number of rows or use to take the current number of rows of your shell. Delays • : The delay between frames in ms. If the value is use the actual recording delays. • : Maximum delay between frames in ms. Ignored if the isn't set to . Set to to prevent limiting the max idle time. GIF • : The quality of the generated GIF image (1 - 100). • : Amount of times to repeat GIF: • If value is , play once. • If value is , loop indefinitely. • If value is a positive number, loop times. Terminal • : Cursor style can be one of , , or . • : You can use any font that is installed on your machine like or (CSS-like list). • : The size of the font in pixels. • : The height of lines in pixels. • : The spacing between letters in pixels. Theme You can set the colors of your terminal using one of the CSS formats: • Hex: . • RGB: . • HSL: . • Name: , , . > You can use the value too. The default colors that are assigned to the terminal colors are: • background: • foreground: • cursor: • black: • red: • green: • yellow: • blue: • magenta: • cyan: • white: • brightBlack: • brightRed: • brightGreen: • brightYellow: • brightBlue: • brightMagenta: • brightCyan: • brightWhite: Watermark You can add a watermark logo to your generated GIF images. • : An absolute path for the image on your machine or a URL. • : Apply CSS styles (camelCase) to the watermark image, like resizing it. Frame Box Terminalizer comes with predefined frames that you can use to make your GIF images look cool. • : Can be , , , or . • : To display a title for the frame or . • : To apply custom CSS styles or to override the current ones. Null Frame No frame, just your recording. > Don't forget to add a under . Window Frame Floating Frame Solid Frame Solid Frame Without Title Styling Hint You can disable the default shadows and margins. FAQ How to support ZSH The default command that gets recorded for Linux is . You need to change the default command to . • Generate a config file in the current directory • Open the generated config file in your preferred editor. • Change the to : • You may need to change the font, check the font that is used in your terminal: • Use the option to override the config file: Issues > error while loading shared libraries: libXss.so.1: cannot open shared object file: No such file or directory Solution: > error while loading shared libraries: libgconf-2.…