README
¶
CLI Todo App in Go
This project represents a simple but efficient CLI pplication written in Go, which allows you to manage your tasks through a simple and intuitive interface directly from your terminal. This is one of my first Go projects and it was initially inspired by the work of Abah Joseph. However, I've adopted quite a few distinct approaches and significantly expanded upon the initial concept.
Setup
Before using the CLI todo app, you need to have Go installed on your system. You can download and install Go from the official Go website.
Once you have Go installed, you can build the project using the following steps:
- Clone the repository:
git clone https://github.com/davidandw190/simple-todo-go.git
- Navigate to the project directory and build the project:
cd todo && go build ./cmd/todo
- Add the directory containing the executable to the system's PATH environment variable. I will showcase how to do it on LINUX, but it will work through other means on Windows too:
export PATH=$PATH:/full/path/to/the/program/here
Usage
The todo app currently supports the following functionalities:
List Tasks
To list all tasks, run the following command:
todo -l
By default, all tasks are listed. You can use additional flags to customize the output:
- To show only completed tasks:
-sc or --completed - To show only the pending tasks:
-sp or --pending
Add Task
To add a new task, run the following command, and the CLI will prompt you for input:
todo -a
Edit Task
To edit an existing task, run the following command and the CLI will prompt you for input:
todo -e <taskIndex>
Complete Task
To mark a task as completed, run the following command:
todo -c <taskIndex>
Delete Task
To delete an existing task, run the following command:
todo -d <taskIndex>
Delete All Tasks
To delete all existing tasks, run the following command:
todo -da
Documentation
¶
Overview ¶
Package todo provides functionality for a simple CLI todo application.
Index ¶
- Constants
- func Blue(s string) string
- func Green(s string) string
- func Grey(s string) string
- func PrintBlue(w io.Writer, s string)
- func PrintGreen(w io.Writer, s string)
- func PrintGrey(w io.Writer, s string)
- func PrintRed(w io.Writer, s string)
- func PrintRedStderr(s string)
- func Red(s string) string
- type Item
- type Todos
- func (t *Todos) Add(task string)
- func (t *Todos) Complete(index int) error
- func (t *Todos) Delete(index int) error
- func (t *Todos) DeleteAll() error
- func (t *Todos) Edit(index int, newTask string) error
- func (t *Todos) Load(filename string) error
- func (t Todos) Print()
- func (t Todos) PrintCompleted()
- func (t Todos) PrintPending()
- func (t *Todos) Store(filename string) error
Constants ¶
const ( ColorDefault = "\x1b[39m" ColorRed = "\x1b[91m" ColorGreen = "\x1b[32m" ColorBlue = "\x1b[94m" ColorGrey = "\x1b[90m" )
Variables ¶
This section is empty.
Functions ¶
func PrintGreen ¶
Types ¶
type Todos ¶
type Todos []Item
Todos is a collection of todo items.
func (Todos) PrintCompleted ¶
func (t Todos) PrintCompleted()
PrintCompleted prints only the completed todo items to the console.
func (Todos) PrintPending ¶
func (t Todos) PrintPending()
PrintPending prints only the pending todo items to the console.
Source Files
Directories