https://github.com/cortezcristian/terminal-recorder
Terminal recorder: Record your termial session into HTML
https://github.com/cortezcristian/terminal-recorder
Last synced: 4 months ago
JSON representation
Terminal recorder: Record your termial session into HTML
- Host: GitHub
- URL: https://github.com/cortezcristian/terminal-recorder
- Owner: cortezcristian
- License: mit
- Created: 2014-12-18T06:18:04.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2020-04-21T13:52:10.000Z (over 5 years ago)
- Last Synced: 2024-11-18T17:59:53.079Z (12 months ago)
- Language: JavaScript
- Homepage: http://cortezcristian.com/terminal-recorder
- Size: 2.2 MB
- Stars: 106
- Watchers: 6
- Forks: 9
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nodejs-precise - terminal-recorder - recorder .svg?style=social&label=Star&maxAge=2592000?style=flat-square)]() | Record your terminal usage and export it to interactive HTML. | (Packages / Command-line apps)
- awesome-cli-apps-in-a-csv - terminal-recorder - Terminal recorder allows you to record your bash session, and export it to HTML so then you can share it with your friends. (<a name="screen-recorder"></a>Screen recorder)
README
terminal-recorder [](https://david-dm.org/cortezcristian/terminal-recorder)
============
[](https://nodei.co/npm/terminal-recorder/)
Terminal recorder allows you to record your bash session, and export it to html so then you can share it with your friends.
- [GitHub Page](https://cortezcristian.github.io/terminal-recorder/)
- [Latest Demo (with TimeLine)](http://cortezcristian.github.io/terminal-recorder/terminal-recorder-html/)
- [Basic Demo](http://cortezcristian.com/terminal-recorder/)
## Installation
[](https://nodei.co/npm/terminal-recorder/)
```bash
$ [sudo] npm install -g terminal-recorder
```
## Usage
```bash
$ terminal-recorder --help
Usage: terminal-recorder [options]
Options:
-h, --help output usage information
-V, --version output the version number
-o, --outpath [path] Add the specified [path] to place the folder
that will contain the recorded html files
# Start recording
$ terminal-recorder
# recording...
[type your stuff and then hit Ctrl+c]
# Notice a new folder was created
$ tree terminal-recorder-html/ -L 1
terminal-recorder-html/
├── bower_components
├── bower.json
├── css
├── index.html
└── js
# Just open the index.html with your favourite browser
$ firefox terminal-recorder-html/index.html &
# See the magic ;)
```
Final output looks like this
## Features
* Records all keystrokes sent to stdin
* Saves stdout in a log file `logs.txt`
* Export actions to html
* Timeline indicator
* Rollback actions
## Comming soon
* More templates
* Define starting cmd (Other than bash)
* Add param for picking cancelling key (Ctrl+c, Ctrl+d)
* Specify terminal size
## Experimenting
Open a terminal:
```bash
$ tail -f logs.txt
```
Open a second terminal:
```bash
$ terminal-recorder
```
Start typing in the second console, and look how the first one is mimicking your moves.
## Known issues
* Record all keys, including passwords. So be careful with that.
## Cool Stuff
Cool things that you can do:
```bash
$ filget awesomeness # Impress your friends
$ nethack # Play nethack
$ vim # Teach your friends with vim
$ htop # Show server state
$ tmux # Open the terminal multiplexor
$ cmatrix # feel like neo :)
```
## Credits
[@cortezcristian](https://twitter.com/cortezcristian)