Thomas Klausner > App-TimeTracker > App::TimeTracker::Command::Core

Download:
App-TimeTracker-2.020.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

New  6
Open  3
View/Report Bugs
Source  

NAME ^

App::TimeTracker::Command::Core - App::TimeTracker Core commands

VERSION ^

version 2.020

CORE COMMANDS ^

More commands are implemented in various plugins. Plugins might also alter and/or amend commands.

start

    ~/perl/Your-Project$ tracker start
    Started working on Your-Project at 23:44:19

Start tracking the current project now. Automatically stop the previous task, if there was one.

Options:

--at TT::DateTime

    ~/perl/Your-Project$ tracker start --at 12:42
    ~/perl/Your-Project$ tracker start --at '2011-02-26 12:42'

Start at the specified time/datetime instead of now. If only a time is provided, the day defaults to today. See TT::DateTime in App::TimeTracker.

--project SomeProject

  ~/perl/Your-Project$ tracker start --project SomeProject

Use the specified project instead of the one determined by the current working directory.

--description 'some prosa'

  ~/perl/Your-Project$ tracker start --description "Solving nasty bug"

Supply some descriptive text to the task. Might be used by reporting plugins etc.

--tags RT1234 [Multiple]

  ~/perl/Your-Project$ tracker start --tag RT1234 --tag testing

A list of tags to add to the task. Can be used by reporting plugins.

stop

    ~/perl/Your-Project$ tracker stop
    Worked 00:20:50 on Your-Project

Stop tracking the current project now.

Options

--at TT::DateTime

Stop at the specified time/datetime instead of now.

continue

    ~/perl/Your-Project$ tracker continue

Continue working on the previous task after a break.

Example:

    ~$ tracker start --project ExplainContinue --tag testing
    Started working on ExplainContinue (testing) at 12:42
    
    # ... time passes, it's now 13:17
    ~$ tracker stop
    Worked 00:35:00 on ExplainContinue
    
    # back from lunch at 13:58
    ~$ tracker continue
    Started working on ExplainContinue (testing) at 13:58

Options:

same as start

append

    ~/perl/Your-Project$ tracker append

Start working on a task at exactly the time you stopped working at the previous task.

Example:

    ~$ tracker start --project ExplainAppend --tag RT1234
    Started working on ExplainAppend (RT1234) at 14:23
    
    # ... time passes (14:46)
    ~$ tracker stop
    Worked 00:23:00 on ExplainAppend (RT1234)
    
    # start working on new ticket
    # ...
    # but forgot to hit start (14:53)
    ~$ tracker append --tag RT7890
    Started working on ExplainAppend (RT7890) at 14:46

Options:

same as start

current

    ~/perl/Your-Project$ tracker current
    Working 00:20:17 on Your-Project

Display what you're currently working on, and for how long.

No options

worked

    ~/perl/Your-Project$ tracker worked [SPAN]

Report the total time worked in the given time span, maybe limited to some projects.

Options:

--from TT::DateTime [REQUIRED (or use --this/--last)]

Begin of reporting iterval, defaults to first day of current month.

--to TT::DateTime [REQUIRED (or use --this/--last)]

End of reporting iterval, default to DateTime->now.

--this [day, week, month, year]

Automatically set --from and --to to the calculated values

    ~/perl/Your-Project$ tracker worked --this week
    17:01:50

--last [day, week, month, year]

Automatically set --from and --to to the calculated values

    ~/perl/Your-Project$ tracker worked --last day (=yesterday)
    06:39:12

--project SomeProject [Multiple]

    ~$ tracker worked --last day --project SomeProject
    02:04:47

report

    ~/perl/Your-Project$ tracker report

Print out a detailed report of what you did. All worked times are summed up per project (and optionally per tag)

Options:

The same options as for worked, plus:

--detail

    ~/perl/Your-Project$ tracker report --last month --detail tag

Valid options are: tag, description, all

Will print the tag(s) and/or description.

Also calc sums per tag.

--verbose

    ~/perl/Your-Project$ tracker report --last month --verbose

Lists all found trackfiles and their respective duration before printing out the report.

list

    ~/perl/Your-Project$ tracker list

Print out a detailed report of what you did in a tabular format including start and stop times.

Options:

The same options as for report

init

    ~/perl/Your-Project$ tracker init

Create a rather empty .tracker.json config file in the current directory.

No options

show_config

    ~/perl/Your-Project$ tracker show_config

Dump the config that's valid for the current directory. Might be handy when setting up plugins etc.

No options

plugins

    ~/perl/Your-Project$ tracker plugins

List all installed plugins (i.e. stuff in App::TimeTracker::Command::*)

No options

recalc_trackfile

    ~/perl/Your-Project$ tracker recalc_trackfile --trackfile 20110808-232327_App_TimeTracker.trc

Recalculates the duration stored in an old trackfile. Might be useful after a manual update in a trackfile. Might be unneccessary in the future, as soon as task duration is always calculated lazily.

Options:

--trackfile name_of_trackfile.trc REQUIRED

Only the name of the trackfile is required, but you can also pass in the absolute path to the file. Broken trackfiles are sometimes reported during report.

commands

    ~/perl/Your-Project$ tracker commands

List all available commands, based on your current config.

No options

AUTHOR ^

Thomas Klausner <domm@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2011 by Thomas Klausner.

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: