marktask 0.2.0

A CLI tool for parsing and manipulating Markdown tasks.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83

[![Rust](https://github.com/ruivieira/marktask/actions/workflows/rust.yaml/badge.svg)](https://github.com/ruivieira/marktask/actions/workflows/rust.yaml) [![](https://img.shields.io/crates/v/marktask.svg)](https://crates.io/crates/marktask)
# marktask

`marktask` is a command-line interface (CLI) application designed for parsing and manipulating Markdown tasks.
It allows users to filter, extract, and transform task information seamlessly within their shell environment.

## Features

- Parse Markdown-formatted tasks.
- Extract tasks with due dates, scheduled dates, and start dates.
- Filter tasks based on completion status.
- Filter out or include overdue tasks with the `--overdue` option.
- Output tasks in plain text or JSON format for easy consumption by other tools.
- Filter tasks within a specific date range using `--from` and `--to` options.

## Installation

```sh
cargo build --release
mv target/release/marktask /usr/local/bin
```

## Usage

`marktask` can be used with pipes and with other commands in a shell environment. Below are some examples to get you started:

### Display Tasks from a File

```sh
marktask < tasks.md  # or
cat tasks.md | marktask
```

### Filter Tasks Containing Specific Text

```sh
cat tasks.md | marktask | grep "Project A"
```

This command sequence reads tasks from `tasks.md`, parses them, and then uses `grep` to filter tasks related to "Project A".

### Convert Tasks to JSON

For integration with other tools that consume JSON, `marktask` can output tasks in JSON format:

```sh
cat tasks.md | marktask --json
```

### Filter Overdue Tasks

To exclude overdue tasks from the output, use the `--overdue=false` option. By default, all tasks, including overdue ones, are shown:

```sh
cat tasks.md | marktask --overdue=false
```

### Filter Tasks by Date Range

To include tasks starting from a specific date or from a relative date like one week from today:

```sh
cat tasks.md | marktask --from 2024-01-01
cat tasks.md | marktask --from +1w  # Tasks starting from one week from today
```

To include tasks up to a specific date or up to a relative period like two days from now:

```sh
cat tasks.md | marktask --to 2024-01-31
cat tasks.md | marktask --to +2d  # Tasks up to two days from today
```

To include tasks within a specific date range or within a relative period:

```sh
cat tasks.md | marktask --from 2024-01-01 --to 2024-01-31
cat tasks.md | marktask --from -1w --to +1m  # Tasks from last week to one month from today
```

## License

This project is licensed under the Apache License Version 2.0 - see the [LICENSE](./LICENSE) file for details.