jwkblades / mule

Mule, the stupid package manager

Mule, the stupid package manager

Mule is a quick and easy package manager which allows you to create and manage repository mirrors easily. Inspired by git and vundle, mule aims to allow you the ease of accessing multiple repository mirrors with potentially differing packages, and is aimed at workplace environments where newhires need to get off the ground running but installing all the potentially needed (or wanted) software for the end user isn't always an option.

Setting Up A Mule Repo Mirror

Setting up a repo mirror is as easy as setting up a git server. Once you have your git server up simply start adding packages to it (view example.bag to see how packages are expected to be -- when we get them implemented).

Mule Commands

clean

Clean out all downloaded bag repos to save space. NOTE - When removing an installed bag, or updating the bag repo is downloaded once more.

install BAGNAME

Install the specified BAG (package) on your machine if it is found and supports your OS.

remove BAGNAME

Remove the specified BAG from your machine if it is installed.

update

Update all of the known repo mirrors and download any BAG updates which are available.

repo

Manipulate the repo mirrors which mule will look at.

repo add REPOURL

Add the specified REPO to the repos list (stored in the .mule file) if it doesn't already exist.

repo remove REPONAME

Remove the specified REPO from the repos list if it exists.

repo list

List all REPOs in the .mule file

repo help

Show the repo usage message.

Examples

Just starting off with mule you will want to add a repo mirror to mule so it has something to look through when we tell it to install a bag. To accomplish this we first need to add the repo mirror:

mule repo add [email protected]:JamesB/mule_example_repo_mirror.git

Then we need to tell mule to update itself and actually pull down the mirror's baggage:

mule update

Once we have a baggage file on our machines we can install any bag that it has listed within it by calling install with the bag name:

mule install example

Which will pull down the git repository associated with the bag, along with the dependencies it has (both dev and normal) and call the installer scripts within each. Install also makes sure to install the dependencies before the desired bag to limit confusion if one package actually does check for others.

Now, say we are getting tired of a bag being installed, we can remove it using remove:

mule remove example

At the moment, remove doesn't remove the dependencies which were originally installed with a package, however it will remove any bags which are dependent on the one we are actively attempting to remove. When removing a bag we first call the uninstall script, and then we remove the git repository associated with the bag.

If you want to see which repos you have installed in mule you can issue with following command:

mule repo list

And finally, if you want to remove a repo from mule you can run:

mule repo remove mule_example_repo_mirror

NOTE - the ".git" is not missing from the end of the remove statement, mule considers the repository name to be anything after the last /, not including .git (which it removed) in the URL.

File Formats

.mule

A JSON object containing a repos member which is an object of name to REPO URL key-value pairings, and a bags member which is an array of bag objects (following the examples.bag model) that are installed on the machine.

example.bag

A JSON object containing name, version, description, keywords, author, dependencies, devDependencies, installer, uninstaller, and license members.

Requirements

perl, perl-JSON, git

License

(The MIT License)

Copyright (c) 2013 James Blades <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software, and that credit be given where credit is due.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.