task

command module
v0.0.0-...-fbe9dd7 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 19, 2019 License: MIT Imports: 15 Imported by: 0

README

Task

A simple command-line tool for your task list.

Data Storage

Data is stored as plain-text files in TOML format. The files can be edited, searched, or managed as any text files, there is no database or stored state outside of the TOML files.

A top level TASKDIR is used, see configuration section below. The files are stored in project directories using their unique task id and state.

For example, task id 13 in sriracha project is stored at: TASKDIR/sriracha/13.toml

When task 13 is marked complete, renamed to: TASKDIR/sriracha/13.done.toml

The directory structure, file format, and naming allows for using any set of command-line text processing tools, not just task program.

Install

Install using go get github.com/mkaz/task

or Download from Github releases: https://github.com/mkaz/task/releases

Configuration

Task requires a directory to be set to store task files

The task directory can be set:

  • Option 1: Use --task-dir DIR flag on command-line
  • Option 2: Create task.conf in XDG_CONFIG_DIR
  • Option 3: Create $HOME/.task.conf

The config file uses TOML format and requires TaskDir set

Example:

TaskDir='/home/username/Documents/tasks'
Contributions and License

Task is open source and free to use, modify, and distribute. It is licensed under the MIT License.

All contributions are welcome. Use Github issues to report a bug, or submit a feature request.

An mkaz contrivance.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL