README

Giroapp

Command line app for managing autogiro donations.

Installation

Using phive (recommended)

Install using phive

phive install byrokrat/giroapp

As a phar archive

Download the latest phar archive from the releases tab.

Optionally rename giroapp.phar to giroapp for a smoother experience.

Using composer

Install as a composer dependency

composer require byrokrat/giroapp

This will make giroapp avaliable as vendor/bin/giroapp.

From source

To build you need make

make
sudo make install

The build script uses composer to handle dependencies and phive to handle build tools. If they are not installed as composer or phive respectivly you can use something like

make COMPOSER_CMD=./composer.phar PHIVE_CMD=./phive.phar

Getting started

By default giroapp looks for configurations in a file called giroapp.ini in the current working directory. Tell giroapp where to look for configurations be defining a GIROAPP_INI environment variable.

Run giroapp init to create a default giroapp.ini in the current working directory. Edit using a standard text editor.

Simply run giroapp to se the list of avaliable commands.

Plugins

Giroapp supports dynamic plugins. Officially supported plugins:

• giroapp-completion-plugin: shell completion.
• giroapp-mailer-plugin: send mails on giroapp events.