https://github.com/cldwalker/irbfiles
ripl/irb the way I like it (enhanced with boson)
https://github.com/cldwalker/irbfiles
Last synced: about 1 year ago
JSON representation
ripl/irb the way I like it (enhanced with boson)
- Host: GitHub
- URL: https://github.com/cldwalker/irbfiles
- Owner: cldwalker
- License: mit
- Created: 2009-01-19T15:02:19.000Z (over 17 years ago)
- Default Branch: master
- Last Pushed: 2021-04-30T05:04:54.000Z (about 5 years ago)
- Last Synced: 2025-03-18T13:32:10.075Z (about 1 year ago)
- Language: Ruby
- Homepage:
- Size: 887 KB
- Stars: 50
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.markdown
- License: LICENSE.txt
Awesome Lists containing this project
README
Description
===========
Contains libraries of ruby commands/snippets, some original and some copied.
These libraries are managed and run by my command framework, [boson](http://github.com/cldwalker/boson).
Despite what the project name implies, all these commands can be used within ripl(irb) or from the
commandline thanks to boson.
Outline of this Repo
====================
Here's a brief outline and description of major directories under boson/:
* config/: Boson config directory
* commands/: Contains all currently used libraries.
* core/: Libraries that either extend core Ruby classes or take an object of a core class as its first argument.
* public/: Public libraries that I encourage everyone to use. Commands should have descriptions. If something
is buggy here feel free to fork and pull.
* plugins/: Plugin libraries that extend Boson's behavior.
* site/: Libraries related to specific websites and their APIs.
* url/: Libraries that generate url strings. To use in conjunction with boson/url\_libraries
plugin in boson/more.
* rails/: Rails-related libraries.
* exp/: Experimental libraries that one day should be public. These libraries are usually half-baked good ideas that
haven't quite realized their full potential. You'll probably to need to run edge versions of
hirb and boson for these to work.
* personal/: Personal libraries that are specific to my computer setup i.e. my system files or operating system setup.
* lib/: A local loaded\_path containing classes used by commands.
* test/: Tests to go along with libraries.
* todo/: Interesting snippets, mostly copied, that haven't been converted to commands.
Using a Library
===============
If you want to just try one or two libraries/files under boson/ without boson, simply require and include them:
$ ripl -f
>> require "boson/commands/public/color"
>> class< boson install http://github.com/cldwalker/irbfiles/raw/master/boson/commands/public/irb_core.rb
Install
=======
If you want to use boson in ripl(irb) as a I do:
* Clone this project: `git clone git://github.com/cldwalker/irbfiles.git`
* Install [boson](http://github.com/cldwalker/boson) and all the library dependencies: `bundle
install --system`. You can leave off `--system` but then you will need to run
`bundle exec` in this directory to use any of the commandline tools like lightning.
* Save your ~/.irbrc to somewhere else temporarily. *Important* since the next step will symlink
over this file.
* `ruby install.rb` to symlink to ~/.boson and ~/.irbrc
To see all the command goodies available to you:
# from bundle exec ripl
>> libraries
# from commandline
bash> boson libraries