savagematt / hermit

Run command line scripts bundled within your clojure project

hermit

Clojure wrapper around command line programmes bundled within your project

Works from within the repl and within uberjars

Installation

Add the following to the :dependencies section of your project.clj file:

    [savagematt/hermit "0.9"]

Usage

This example will run from within any project that imports hermit:

    (rsh! "hermit/helloworld/hello_world.sh" "Dave")

hello_world.sh is bundled with hermit.

The full contents of the parent directory of the script will be copied to a temp directory before execution and all .sh files will be chmod +x.

The script with be run within the context of the temp directory

If your script has dependencies in other packages, you can do this:

    (with-deps-in-package ["hermit/helloworld/hello_world.sh"]
      (println (rsh! "hermit/otherpackages/call_script_in_another_package.sh" "Dave")))

The full contents of the parent package of hermit/helloworld/hello_world.sh will be copied into the script directory.

If your script requires a dependent package to be in a different directory, you can alias it:

    (with-deps-in-package [["hermit/helloworld/hello_world.sh" "aliased_helloworld"]]
      (println (rsh! "hermit/otherpackages/call_script_in_aliased_package.sh" "Dave")))

Again, call_script_in_aliased_package.sh and call_script_in_another_package.sh are bundled with hermit so this example will work..

hermit's Issues

Using resource paths to packages doesn't work

In all cases we've found up until now, (io/resource "some/package") worked fine.

We have a bug in a project where getting the url for a package works for some dependencies, but not others. It's unclear why this is the case- the packages look identical in /target and in the uberjar. (io/resource "some/package/actual_file.sh") works fine in all cases.

We need to revert to the standard Java approach of using reference paths to real resources.

Clean up temp directory