rs

Synopsis

rs is a project to implement a non-traditional object-oriented shell in Ruby.

The three main features will be the simple power of Ruby as the shell scripting language, an objectlike interface to files and object piping.

Authors

See doc/AUTHORS.

Licence

See doc/LICENCE.

Communication

• IRC: #rs on irc.freenode.net (That is hash-hash-r-s)
• Mailing list: projects.kittensoft.org/mailman/listinfo/rs-dev_projects.kittensoft.org
• Bug tracker: rubyforge.org/tracker/?group_id=2377

Documentation

projects.kittensoft.org/rs/rdoc/index.html

Features

• Execution of arbitrary Ruby
• Pipes, input redirection
• FileSystemObjects which encapsulate paths and files

A development roadmap is in doc/TODO.roadmap

Download

Developers

Anyone interested in developing rs should read the doc/HOWTO.development document, available on the web (see Documentation) or in the distribution.

• darcs get repos.kittensoft.org/rs
• files.kittensoft.org/rs/rs-dev-latest.tar.gz

Users

• files.kittensoft.org/rs/rs-latest.tar.gz

Installation

It is advised that developers do not install the program locally at this point but rather use bin/rs directly. Users may use the provided setup.rb script:

  sudo ruby setup.rb all

Using rs

See doc/HOWTO.using.

Current issues and bugs

The entire project is in flux. Think of it as an exploratory programming experiment that will stretch all the way until 0.9 at which point the real program will be extracted from the codebase at the time.

• Generally not production-ready.
• Cannot be used as a login shell.
• Inconsistent and incomplete internal model.
• The ‘lexer’ for determining completeness of Ruby statements has been improved but is still somewhat weak.
• Tests, though relatively extensive, mainly ensure that the correct operation is present. Work is needed in testing for failure.

Dependencies

Bundled

• Test::Spec by Christian Neukirchen, chneukirchen.org. Developers only.
• FlexMock by Jim Weirich, onestepback.org/software/flexmock. Developers only.

Unbundled

• None

Special thanks

• Everyone who contributed to the original ruSH code.
• The Ruby hackers. I never appreciated the UNIXness of Ruby enough.

Copyright

Copyright (c) 2005-2006 by the Authors. All rights reserved.