module Rtasklib

Constants

TW

To interact with the TaskWarrior database simply instantiate this with a path to the .task folder where data is stored. If left out it will look for a database in the default location `~/.task`

Optionally pass in a hash of taskrc options to override what is in your .taskrc on every command. By default `rtasklib` provides a set of sensible defaults:

@example

# Use the default path and overrides
tw = Rtasklib::TaskWarrior.new
# TaskWarrior is also available aliased as TW:
tw = Rtasklib::TW.new
# Custom path, in this case the test db in spec/
tw = Rtasklib::TW.new("./spec/data/.task")
# Custom override, in this case calling the gc everytime
# This will change id numbers whenever the task list changes
# By default this is off, but may have some performance implications.
tw = Rtasklib::TW.new(opts={gc: "on"})

@example

DEFAULTS = {
  json_array:              'true',
  verbose:                 'nothing',
  gc:                      'off',
  confirmation:            'no',
  dependency_confirmation: 'no',
  exit_on_missing_db:      'yes', }

These of course can be overridden with opts param as well

In general `rtasklib` is only feature complete on TaskWarrior installs 2.4 and greater and it will warn you if yours is lower or can't be determined, but will still allow you to interact with it. Proceed at your own risk.

@!attribute [r] version

@return [Gem::Version] The version of the current TaskWarrior install

@!attribute [r] data_location

@return [String] The file path that you passed in at initialization

@!attribute [r] taskrc

@return [Rtasklib::Taskrc] Your current TaskWarrior configuration

@!attribute [r] udas

@return [Hash{Symbol=>Hash}] Currently configured User Defined Attributes

@!attribute [r] override

@return [Rtasklib::Taskrc] The options to override the default .taskrc

@!attribute [r] override_a

@return [Array] override in array form, useful for passing to shell

@!attribute [r] override_str

@return [String] override in string form, useful for passing to shell

VERSION

The latest version of rtasklib