NAME

hrpg - hrpg - Command line interface to HabitRPG

VERSION

version 0.03

SYNOPSIS

Usage:

hrpg status                  : Show current HP/XP/GP
hrpg tasks                   : Show current tasks
hrpg habit|daily|reward|todo : Show tasks of current type
hrpg new                     : Create new task 'hrpg new' for help.
hrpg [+-] task               : Increment/decrement a task or habit

Debugging commands:

hrpg dump                    : Dump entire user info
hrpg dump tasks              : Dump task info

DESCRIPTION

This is a command-line client for the HabitRPG service. Use hrpg with no arguments for help.

When using hrpg + task and hrpg - task any unique shortening of the task name can be used.

SETUP

Installation

If you have not already installed this software, the easiest way is to use cpanm and local::lib. If you don't have them installed, it's easy with:

curl -L http://cpanmin.us/ | perl - --self-upgrade
~/perl5/bin/cpanm -L ~/perl5 App::local::lib::helper
source ~/perl5/bin/localenv-bashrc

You might want to put that last line in your ~/.bashrc file.

You can then install hrpg and related utilities with:

cpanm hrpg

Configuration

Create a .habitrpgrc file in your home directory. Place in it the following lines:

[auth]
user_id   = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
api_token = xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Replace the long strings of 'x's with the values you obtain by going to Settings - API> in the HabitRPG web interface.

BUGS

I'm sure there are plenty! Please view and/or record them at https://github.com/pfenwick/WebService-HabitRPG/issues .

SEE ALSO

WebService::HabitRPG

AUTHOR

Paul Fenwick <pjf@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2013 by Paul Fenwick.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.