diff --git a/demo/README.md b/demo/README.md new file mode 100644 index 0000000..47525d7 --- /dev/null +++ b/demo/README.md @@ -0,0 +1,26 @@ +# Demo with terminalizer + +## Recording + +Provided you have [terminalizer] installed, run the following from the top +directory of this repository. + +```bash +terminalizer record demo/demo.yml --config demo/config.yml +``` + +## Verifying + +Once done, use the [`play`][play] sub-command to verify your recording. You +might want to remove output lines from the YAML, alternatively change the pace. + +## Render + +Finally, run the following command to generate the animated GIF + +```bash +terminalizer render demo/demo.yml --output demo/demo.gif +``` + + [terminalizer]: https://github.com/faressoft/terminalizer + [play]: https://github.com/faressoft/terminalizer?tab=readme-ov-file#play diff --git a/demo/config.yml b/demo/config.yml new file mode 100644 index 0000000..22ceaba --- /dev/null +++ b/demo/config.yml @@ -0,0 +1,107 @@ +# Specify a command to be executed +# like `/bin/bash -l`, `ls`, or any other commands +# the default is bash for Linux +# or powershell.exe for Windows +command: ./demo/demo.sh + +# Specify the current working directory path +# the default is the current working directory path +cwd: null + +# Export additional ENV variables +env: + recording: true + +# Explicitly set the number of columns +# or use `auto` to take the current +# number of columns of your shell +cols: 180 + +# Explicitly set the number of rows +# or use `auto` to take the current +# number of rows of your shell +rows: 40 + +# Amount of times to repeat GIF +# If value is -1, play once +# If value is 0, loop indefinitely +# If value is a positive number, loop n times +repeat: 0 + +# Quality +# 1 - 100 +quality: 95 + +# Delay between frames in ms +# If the value is `auto` use the actual recording delays +frameDelay: auto + +# Maximum delay between frames in ms +# Ignored if the `frameDelay` isn't set to `auto` +# Set to `auto` to prevent limiting the max idle time +maxIdleTime: auto + +# The surrounding frame box +# The `type` can be null, window, floating, or solid` +# To hide the title use the value null +# Don't forget to add a backgroundColor style with a null as type +frameBox: + type: floating + title: GitHub Runner in KrunVM + style: + border: 0px black solid + # boxShadow: none + # margin: 0px + +# Add a watermark image to the rendered gif +# You need to specify an absolute path for +# the image on your machine or a URL, and you can also +# add your own CSS styles +watermark: + imagePath: null + style: + position: absolute + right: 15px + bottom: 15px + width: 100px + opacity: 0.9 + +# Cursor style can be one of +# `block`, `underline`, or `bar` +cursorStyle: block + +# Font family +# You can use any font that is installed on your machine +# in CSS-like syntax +fontFamily: "Monaco, Lucida Console, Ubuntu Mono, Monospace" + +# The size of the font +fontSize: 12 + +# The height of lines +lineHeight: 1 + +# The spacing between letters +letterSpacing: 0 + +# Theme +theme: + background: "transparent" + foreground: "#afafaf" + cursor: "#c7c7c7" + black: "#232628" + red: "#fc4384" + green: "#b3e33b" + yellow: "#ffa727" + blue: "#75dff2" + magenta: "#ae89fe" + cyan: "#708387" + white: "#d5d5d0" + brightBlack: "#626566" + brightRed: "#ff7fac" + brightGreen: "#c8ed71" + brightYellow: "#ebdf86" + brightBlue: "#75dff2" + brightMagenta: "#ae89fe" + brightCyan: "#b1c6ca" + brightWhite: "#f9f9f4"