Repository files navigation

butler isthe itch.io command-line tools - all by itself.

It is used by:

• Content creators onitch.io to push builds quickly & reliably
• the itch app for some network, filesystem and patching operations

Documentation for butler is available as a Gitbook:

• 📝https://itch.io/docs/butler

Questions about butler are welcome on itsIssue tracker,or, if the matter is private,itch.io support.

The following projects integrate butler as part of their workflow:

• itchy-electron lets you package your Electron games for itch.io and upload them there
• gradle-butler-plugin is a Gradle plugin for automatically installing, updating, and running butler as part of your build.

butler was mostly written byAmos Wenger, but wouldn't havebeen possible without the work of many before him.

Amos would like to thank in particular Leaf Corcoran, Jesús Higueras and Tomáš Duda.

butler is released under the MIT License. See theLICENSE file for details.

While butler built from source is fully MIT-licensed, some components it can use at runtime(if present) have other licenses:

• The 7-zip decompression engine (thegithub.com/itchio/boar/szextractor package) opensdynamic libraries forlibc7zip, and7-zip, which have components licensed under the LGPL 2.1 licenseand the MPL 2.0 license, along with specific terms for the RAR extraction code.