Regiment

A simple, self-contained, RESTful script/job management framework in Ruby.

API

Regiment implements an API through which you can trigger scripts(orders), view which orders are in progress and various other useful actions. The API can be started with the command regiment-api.

Endpoints

/version - This returns the version of Regiment you have running.

CLI

Regiment comes with a tool regiment that implements the interface of the API on your command line to squeeze yet more efficiency out of your workflow.

Sub Commands

version - Returns the version of Regiment used by the client and the version used by the endpoint.

Options

--regiment - String - The hostname(including port) of your Regiment endpoint e.g. localhost:1234

Contributing

Rake

To build and install the gem locally during development ensure you are in the root of the repository and run:

rake buildinstall