https://github.com/ConradIrwin/showterm

The rubygem to upload to http://showterm.io
https://github.com/ConradIrwin/showterm

Last synced: about 2 months ago
JSON representation

The rubygem to upload to http://showterm.io

• Host: GitHub
• URL: https://github.com/ConradIrwin/showterm
• Owner: ConradIrwin
• License: mit
• Created: 2012-10-08T08:22:56.000Z (about 12 years ago)
• Default Branch: master
• Last Pushed: 2019-03-19T04:19:09.000Z (over 5 years ago)
• Last Synced: 2024-10-23T15:42:38.439Z (about 2 months ago)
• Language: Ruby
• Size: 37.1 KB
• Stars: 600
• Watchers: 19
• Forks: 49
• Open Issues: 26
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.MIT

Awesome Lists containing this project

• awesome-repositories - ConradIrwin/showterm - The rubygem to upload to http://showterm.io (Ruby)

README

        
[showterm.io](http://showterm.herokuapp.com/)

=============

It's showtime for your terminal!

Showterm lets your record a terminal session exactly as you experience it, right down to

the syntax highlighting.

Installation instructions (`gem install showterm`) and usage instructions (`showterm program`) are available in the [showterm](https://showterm.herokuapp.com/b6803679cb1c9fbcf667cb7cfe8f605e3ce1fe03). :)

(yes, this is me using showterm inside showterm; it's like inception, but with more

syntax highlighting)

Configuration

=============

If you'd like to run your own showterm server, you can

`export SHOWTERM_SERVER=http://showterm.myorg.local/` to configure your showterm

client to talk to it.

TODO

====

* Allow embedders to chose colourschemes (at least light vs. dark background).

Bugs

====

Showterm doesn't preserve enough context for `rvm` to work correctly. This can cause some ruby programs (e.g. capistrano) to crash when used inside a showterm. To fix this run: `rvm use` before running any ruby programs:

```

[~/repo/www] > showterm

Showterm recording. (Exit shell when done.)

[~/repo/www] >  rvm use

Using /Users/jasghar/.rvm/gems/ruby-1.9.3-p286

[~/repo/www] > cap deploy

...

```

Meta-fu

=======

As usual, bug-reports and pull requests are welcome; everything is MIT licensed (see

LICENSE.MIT).

Credit

======

This would not have been doable without the excellent terminal emulator I borrowed from Christopher Jeffrey's incredible [tty.js](https://github.com/chjj/tty.js).

For terminal recording on a mac, this gem bundles Satoru Takabayashi's awesome [`ttyrec`](http://0xcc.net/ttyrec) program.