File: README.md

package info (click to toggle)
shelr 0.16.3-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid
  • size: 260 kB
  • ctags: 63
  • sloc: ruby: 679; sh: 26; makefile: 2
file content (92 lines) | stat: -rw-r--r-- 2,582 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
# Shelr -- [tool for terminal screencasting][TV].

[![Build Status](https://secure.travis-ci.org/antono/shelr.png?branch=master)](http://travis-ci.org/antono/shelr)

`shelr` allows you to record/replay and publish your terminal on [http://shelr.tv](http://shelr.tv).
[Code for Shelr.tv](https://github.com/shelr/shelr.tv) service is also available on github.


## Installation

### From gem

You'll need ruby and rubygems installed.

    [sudo] gem install shelr

On ubuntu older than precise or debian older than wheezy you should also add following to your `.bashrc` or `.zshrc`

    export PATH=/var/lib/gems/1.8/bin:$PATH

Watch [asciicast](http://shelr.tv/records/4f49ea4ae557800001000004) for details :)

### From packages

- [PPA](https://launchpad.net/~antono/+archive/shelr) for Ubuntu
- [PKGBUILD](https://aur.archlinux.org/packages.php?ID=56945) for Arch Linux
- [EBUILD](http://overlays.gentoo.org/proj/sunrise/browser/app-misc/shelr) for Gentoo Linux
- [deb](http://mentors.debian.net/package/shelr) for Debian (Mentor Wanted)

## Watching other's records in your terminal

    shelr play http://shelr.tv/records/4f4ca2a43cd1090001000002.json

You can watch them online at [http://shelr.tv/][TV]

## Recording your terminal

    shelr record

Recording started. Do what you whant to record...
To finish recording type 'exit' or just Ctrl+D.

## Publishing your record

    shelr push last

When you have some asciicasts at your machine you can pick one:

    shelr list
    <select id of your record>
    shelr push <ID>

There is alias for last record:

If you want private record, provide --private switch:

    shelr push last --private

Such record will be accessible by secret URL with access_key.

## Dependencies

### Linux/Hurd

You need `script` tool from linux-utils.
It's already installed if You use Linux.
Note that old school BSD `script` will not work.

### BSD/OSX

Unfortunally BSD and OSX ship old `script` wich lack timing support.
If You use this systems - install `ttyrec` via ports macprots or homebrew
and setup it as recording backend.

     brew install ttyrec      # OSX
     sudo port install ttyrec # BSD / OSX
     shelr backend ttyrec     # BSD / OSX

To enable sound recordings, you need to install `sox`.

     brew install sox          # OSX
     sudo port install sox     # BSD / OSX
     sudo apt-get install sox  # Ubuntu / Debian

## Copyright

(Э) 2010, 2011, 2012 Antono Vasiljev and
[contributors](https://github.com/shelr/shelr/contributors).

See LICENSE.txt for details.

[TV]: http://shelr.tv/ "Asciicasts from unix ninjas"