https://github.com/charmbracelet/taskcli
A tutorial for building a Taskwarrior-inspired task tracker in Go using glamorous CLI libraries
https://github.com/charmbracelet/taskcli
golang productivity tutorial
Last synced: 8 months ago
JSON representation
A tutorial for building a Taskwarrior-inspired task tracker in Go using glamorous CLI libraries
- Host: GitHub
- URL: https://github.com/charmbracelet/taskcli
- Owner: charmbracelet
- License: mit
- Created: 2023-08-17T19:48:31.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-05T22:28:29.000Z (almost 2 years ago)
- Last Synced: 2024-10-11T23:14:43.165Z (12 months ago)
- Topics: golang, productivity, tutorial
- Language: Go
- Homepage: https://youtu.be/yiFhQGJeRJk
- Size: 43 KB
- Stars: 102
- Watchers: 7
- Forks: 15
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Creating a Task Manager (a Charm Tutorial)
This project is inspired by the incredible work on Task Warrior, an open source
CLI task manager. I use this project quite a bit for managing my projects
without leaving the safety and comfort of my terminal. (⌐■_■)
We built a kanban board TUI in a previous [tutorial][kanban-video], so the
idea here is that we're going to build a task management CLI with [Cobra][cobra] that has Lip Gloss
styles *and* can be viewed using our kanban board.
*Note: We walk through the code explaining each and every piece of it in the
[corresponding video](https://youtu.be/yiFhQGJeRJk) for this tutorial. Enjoy!!*
Here's the plan:
## Checklist
If you're following along with our tutorials for this project, or even if you
want to try and tackle it yourself first, then look at our solutions, here's
what you need to do:
### Data Storage
- [ ] set up a SQLite database
- [ ] open SQLite DB
- [ ] add task
- [ ] delete task
- [ ] edit task
- [ ] get tasks
### Making a CLI with Cobra
- [ ] add CLI
- [ ] add task
- [ ] delete task
- [ ] edit task
- [ ] get tasks
### Add a little... *Je ne sais quoi*
- [ ] print to table layout with [Lip Gloss][lipgloss]
- [ ] print to Kanban layout with [Lip Gloss][lipgloss]
## Project Layout
`db.go` - here we create our custom `task` struct and our data layer.
`main.go` - our main file handles our initial setup including opening a
database and setting the data path for our application.
`cmds.go` - this is where we do all of our Cobra commands and setup for our
CLI.
[lipgloss]: https://github.com/charmbracelet/lipgloss
[charm]: https://github.com/charmbracelet/charm
[cobra]: https://github.com/spf13/cobra
[kanban-video]: https://www.youtube.com/watch?v=ZA93qgdLUzM&list=PLLLtqOZfy0pcFoSIeGXO-SOaP9qLqd_H6