Paul Jamieson Fenwick > WebService-HabitRPG-0.20 > hrpg

Download:
WebService-HabitRPG-0.20.tar.gz

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Source   Latest Release: WebService-HabitRPG-0.22

NAME ^

hrpg - hrpg - Command line interface to HabitRPG

VERSION ^

version 0.20

SYNOPSIS ^

Usage:

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

    Debugging commands:
    
    hrpg version                          : Show version information
    hrpg show [task]                      : Show detailed info about a task
    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 the + and - commands, any unique shortening of a task name can be used. When using history and show, all tasks matching the name specified will be displayed.

The --beta switch may be provided as a first argument to use the beta API server. The --dev switch may be used to use http://localhost:3000/api/v1 as the server.

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 WebService::HabitRPG

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.

You may also have an [auth-dev] and/or [auth-beta] section, if you use a development or beta server and have different credentials there. Most users will never need this.

On some systems, the default-behaviour of using keep-alives (which normally improve performance) causes troubles. You can disable keep-alives by adding the following to your .habitrpgrc:

    [connection]
    keep_alive = 0

EXPERIMENTAL FEATURES ^

These features are considered experimental, and may change in the future.

TAGS

As there is no API for tags yet, you need to include them in your configuration file if you wish to be able to use them. The syntax is:

    [tags]
    study = 96681445-0e8a-43f7-85ac-9b7f1cb130ee
    home  = 1b832ec1-a87c-4c11-9b54-e1c24c27313f
    qs    = 63bc4f62-aaa4-4207-887b-95254bcbcfff

To find out the uuid of a tag, use `hrpg show` on a task having that tag, and examine the resulting data structure. Once the upstream tag API is finished, this process will be obsolete.

Tags can be used in any search by prefixing them with the tag prefix character, which defaults to caret (^). For example:

    hrpg daily ^work      # Show daily tasks tagged with 'work'
    hrpg tasks ^code      # Show all tasks tagged with 'code'

If you don't like the tag prefix character, you can change it in your configuration file. Simply add:

    [config]
    tag_prefix = @

This might be handy if you tend to use location tags. You could write: hrpg daily @home and hrpg daily @work to show daily tasks with the home and work tags respectively.

INTEGRATION WITH IDONETHIS

If you have WebService::Idonethis installed, then you can add items to your done-list at the same time as you complete habits. This is done by adding an extra argument to the + or - calls to hrpg:

    hrpg + bugfix   "Recalibrated the flux capacitor."
    hrpg - junkfood "Won the local doughnut eating competition."

This integration is extraordinarily simple for now. We simply call out to the idone command-line tool with all additional arugments given. If you're an idone power user, this means you can use switches like -l.

If WebService::Idonethis is not installed, any additional arguments to habit reporting are ignored.

CUSTOM ATTRIBUTES

Additional arguments after the value to hrpg new are considered to be custom arguments that are sent to the API. These must be key/value pairs, which are encoded into JSON and passed directly as-is, without any sanity checking. These can allow tasks to be created that may hook into new features on the server, or which contain additional information which is not used by the main HabitRPG servers.

ENVIRONMENT ^

If the HRPG_API_BASE environment variable is set, it will be used as the API base URL. This may be useful in testing, or when working with other servers.

BUGS ^

I'm sure there are plenty! Please view and/or record them at https://github.com/pjf/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.

syntax highlighting: