bkahlert/● REC terminal sessions
Record terminal sessions and convert them to SVG
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| build-dir | Relative path under $GITHUB_WORKSPACE to store (intermediate) build artifacts | no | build/rec/ |
| out-dir | Relative path under $GITHUB_WORKSPACE to copy the created SVG files to | no | docs/ |
| term | Value to use for the TERM environmental variable | no | xterm-256color |
| indicator | Name of the environmental variable set during recording | no | RECORDING |
| columns | Number of columns to use for recording and conversion | no | 132 |
| rows | Number of rows to use for recording and conversion | no | 25 |
| restart-delay | Number of seconds until the animation restart | no | 5 |
| term-profile | Relative path under $GITHUB_WORKSPACE to to the terminal profile to use for conversion; [supported profiles](https://github.com/marionebl/term-schemesupported-formats) | no | auto |
| parallel | Maximum number of conversions that run at once; 0 will run as many conversions as possible | no | auto |
| hide-recording | Whether to hide the recording process | no | false |
| delete-build | Whether to delete intermediary build files on completion | no | false |
| files | Relative paths under $GITHUB_WORKSPACE the rec files to be converted are located. - To convert a single file, specify the file's path (e.g. `rec/foo.rec`). - To convert a file tree, specify the directory's path (e.g. `rec`). - To convert filter certain files, specify the directory's path (e.g. `rec`) and on separate lines the relative paths of the files to convert (e.g. `foo.rec`). | no | rec/ |
| separator | Separator to use for `output.files` | no | , |
| branch | The branch to use for links included in the generated Markdown | yes | auto |
Outputs
| name | description |
|---|---|
| status | Exit status/code of the conversion |
| files | Newline-separated list of the created SVG files |
| file-list | `inputs.separator`-separated list of the created SVG files |
| markdown | Markdown with previews and links to the generated SVG files |