tasg 0.1.1

Manage your tasks with tasg!
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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

<p align="center">
  <img src="https://img.shields.io/crates/l/tasg.svg" alt="license">
  <a href="https://crates.io/crates/tasg"><img src="https://img.shields.io/crates/v/tasg.svg?colorB=319e8c" alt="Version info"></a><br>
  <img src="https://github.com/Ce11an/tasg/actions/workflows/ci.yaml/badge.svg?branch=main" alt="CI status"><br>
    <i>Manage your tasks with tasg!</i>
</p>

## Features

- **Add New Tasks**: Easily add tasks with descriptions.
- **List Tasks**: View all tasks or filter to see only incomplete tasks.
- **Complete Tasks**: Mark tasks as complete.
- **Delete Tasks**: Remove tasks when they are no longer needed.

## Installation

Install via Cargo:

```sh
cargo install tasg
```

## Uninstallation

First delete the `tasg` storage data (irreversible action):

```sh
tasg nuke
```

To uninstall `tasg`, you can use Cargo to remove the installed binary:

```sh
cargo uninstall tasg
```

## Usage

`tasg` provides a straightforward CLI interface. Below are the available commands:

### Add a Task

Add a new task with a description:

```sh
tasg add "Your task description"
```

### List Tasks

To list incomplete tasks:

```sh
tasg list
```

To list all tasks, including completed ones:

```sh
tasg list --all
```

### Complete a Task

Mark a task as complete by specifying its ID:

```sh
tasg complete <task_id>
```

### Delete a Task

Remove a task by specifying its ID:

```sh
tasg delete <task_id>
```

### Nuke All Tasks

To delete all tasks (irreversible action), use:

```sh
tasg nuke
```

You will be prompted to confirm this action.

## Invalid Commands

If you enter an invalid command or missing arguments, `tasg` will display an error message to guide you.

## Running Tests

`tasg` includes a comprehensive suite of tests. To run the tests, use:

```sh
cargo test
```

## Example

Here’s a step-by-step example of how to use `tasg`:

```sh
# Add a new task
tasg add "Write README"

# List all incomplete tasks
tasg list

# Complete the task with ID 1
tasg complete 1

# List all tasks, including completed ones
tasg list --all

# Delete the task with ID 1
tasg delete 1

# Verify the task has been deleted
tasg list
```

## Contributing

Contributions are welcome! Please fork the repository, make your changes, and submit a pull request. Ensure all tests pass before submitting your pull request.