Shebang/shebang.1 at main · dev-kit77/Shebang · GitHub

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
.TH shebang 1 "December 2024" "Version 1.0" "Shebang Todo List Manager"

.SH NAME
bash shebang.command \- Entrypoint to the Shebang commands index

.SH SYNOPSIS
.B shebang.command <file>
<command> [options] [arguments]

.SH DESCRIPTION
Shebang is a command-line tool used to create, view, and update to-do lists from the comfort of your terminal. When run without arguments, this script will display the help message. Otherwise, it will execute the command specified by the first argument. The first argument must be a valid command name. Valid command names are add, delete, display, edit, find, and sort. Shebang requires bash 5.0 or later to run.

.SH OPTIONS
.TP
.B <path>
Specify the relative or absolute path to the todo list to operate on. Default is ./.data/todo.list

.TP
.B \-a, --add
Add a task to the specified todo list.

.TP
.B \-h, --help
Show help message and exit.

.TP
.B \-V, --version
Show the version of the script.

.TP
.B \-e, --edit
Edit the task specified by its number and the todo list it is in.

Options:
    -u, UUID
    -n, name
    -d, Due date
    -p, Priority
    -t, Tags
    -r, Recurrance
    -i, Interval
    Each option needs an argument passed to it

.TP
.B \-r, --remove
Delete the specified task(s) in the specified todo list.

.TP
.B \-d, --display
Display the whole specified todo list.

.TP
.B \-f, --find
Searches through the specified todo list for the specified parameters

.TP
.B \-s, --sort
Sorts the specified todo list by specified parameters ascending or descending and writes them to a file. the Second file is the one that will be overwritten by the sorted tasks. The third argument is the column by which the list will be sorted. The last one is making the sort in ascending or descending order (by default is ascending, desc for descending).

shebang.command <file>
<command> <file> [column] [argument]

Column Arguments: uuid, name, created, due, priority, tags


.SH EXAMPLES
.B bash shebang.command homework.list --add "New Assignment" "2025-10-25 15:39" High "school,work,homework,important" 5 3600
Adds a new task called "New Assignment" to the homework.list file with a due date of 15:39 on 25th October 2025, a priority of High, tags (school, work, homework, and important). This task will need to be completed 5 times, with a cooldown of an hour.

.B bash shebang.command homework.list --display
Show the whole list called homework.list and print all of its items in a nice way, with indexed numbers.

.B bash shebang.command homework.list --delete 1 2 3
Delete the first three tasks from the homework.list file.

.B bash shebang.command homework.list --edit 2 -n "New Assignment" -p "Low"
Edits the 2nd task in homework.list todo list so its task is changed to "New Assignment" and priority changed to Low.

.B bash shebang.command homework.list --find name/due "submit work"/"2024-12-16 03:59"
Searches for tasks in homework.list todo list with the name "submit work" or due on 16th December 2024 at 3:59 am and displays them

.B bash shebang.command todo.list --sort temp.list name
Sorts the todo.list file by the task names in ascending order and saves the sorted list to temp.list

.SH AUTHOR
This project was written by a small team of students from University of Dundee, Fyrine Sego <2636228@dundee.ac.uk>, Younis Al Riyami, Abdulrahman Bada, and Kit Cochrane, and is licensed under the MIT License.

.SH BUGS
Report bugs to CFATSTips@hq.dhs.gov or ighotline@nsa.gov