Shell Command

The Realm Command

Realms provides a command line tool called, obviously enough, realm. The tool provides a number of convenient commands for interfacing with the Realm system.

To see all the things that the realm command can do, use the --help option.

    $ realm --help
    usage: realm <command> [options] [arguments]

    commands:
      in/insert   insert directory into ledger
      out/remove  remove directory from ledger
      ledger      list the ledger entries
      clean       clean ledger of invalid entries
      path        output ledger bin PATH
      sync        synchronize index to lookup list
      versions    list project versions
      help        provide help information

The --help option can be used to get more information on each of these commands, e.g. realm in --help.

In and Out

As a developer the first handful of commands will be of most use. For instance, lets say you are working on a project that uses Ruby Facets and you want to have the project close at hand. So you have cloned the git repository.

    git clone git://github.com/rubyworks/facets.git facets

All you need to do to bring it online is to cd into project, ensure it has a VERSION file and then realm the library in. Facets has a VERSION file so all you'd need to do is:

    cd facets
    realm in

This will add the current project's location to your library ledger (stored in ~/$XDG_CONFIG_HOME/realm/ledger.list).