Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cidem/todo-fish
Pretty-print progress of an arbitrary number of todo.txt files
https://github.com/cidem/todo-fish
fish fisher todotxt
Last synced: 6 days ago
JSON representation
Pretty-print progress of an arbitrary number of todo.txt files
- Host: GitHub
- URL: https://github.com/cidem/todo-fish
- Owner: cideM
- License: apache-2.0
- Created: 2019-09-30T19:44:01.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-09T09:16:03.000Z (almost 2 years ago)
- Last Synced: 2024-11-07T08:50:24.152Z (about 2 months ago)
- Topics: fish, fisher, todotxt
- Language: Shell
- Size: 12.7 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Fish :fish: Shell `todo.txt` parser
Super minimal `todo.txt` pretty-printer.
## Quickstart
```fish
fisher install cideM/todo-fish
```
```fish
$ echo "x this is done" > todo.txt
$ echo "not done" >> todo.txt
$ echo "(A) priority" >> todo.txt
$ echo todo.txt | ftd
.
[ ] (A) priority
[ ] not done
$ echo todo.txt | ftd -v
. (1/3)
[ ] (A) priority
[ ] not done
[x] this is done
```
## Installation
### Fisher
Install with [Fisher](https://github.com/jorgebucaran/fisher) (recommended):
```shell
fisher install cideM/todo-fish
```
### Manual
This assumes that you're fish config folder is located under `~/.config/fish`
```shell
curl https://raw.githubusercontent.com/cideM/todo-fish/master/functions/ftd.fish\
-o ~/.config/fish/functions/ftd.fish
```
## Usage
Pipe a list of file paths to `ftd`...
```fish
echo todo.txt | ftd
```
...or call with filenames
```fish
ftd todo.txt
```
Call it with the `-v` or `--verbose` flag for progress stats and displaying done tasks.
```fish
echo todo.txt | ftd -v
```
## Recipes
### How to show the stats for several todo.txt files
```fish
fd todo.txt | ftd
```
Just use whatever program generates a list of paths to `todo.txt` files and pipe it into `ftd`. Alternatively pass the file names as positional parameters:
```fish
ftd path/to/todo.txt path/to/another/todo.txt
```
## TODO
- [ ] Rename -v to --show-done and --show-stats
- [x] Accept positional params for file lists