Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hiragram/yaru
https://github.com/hiragram/yaru
Last synced: 25 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/hiragram/yaru
- Owner: hiragram
- Created: 2022-03-12T04:02:58.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-07-14T09:52:46.000Z (over 2 years ago)
- Last Synced: 2024-04-20T14:56:54.760Z (7 months ago)
- Language: Swift
- Size: 337 KB
- Stars: 11
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Yaru
Yaru is a command line tool that manages simple tasks.
_The word "yaru(やる)" means "do" in Japanese._
## Usage
To add a new task, simply run `yaru add TASK`.
And then, run `yaru current` to show what to do right now.
```zsh
$ yaru add "debug ios app"
$ yaru current
debug ios app
```
When you have got interrupted by the other task, use a subcommand called "insert". The new task is inserted at head of your task list.
You can see all tasks in your list using subcommand called "all".
```zsh
$ yaru insert "code review #12345"
$ yaru current
code review #12345
$ yaru all
code review #12345
debug ios app
```
When you completed your task, run `yaru next` to mark current task as completed and start next task.
```zsh
$ yaru next
$ yaru current
debug ios app
```
## Installation
### Install using Mint (Recommended)
Use [Mint](https://github.com/yonaskolb/Mint) to install Yaru.
```zsh
$ mint install hiragram/yaru@main
🌱 Cloning yaru main
🌱 Resolving package
🌱 Building package
🌱 Installed yaru main
🌱 Linked yaru main to /Users/hiragram/.mint/bin
```
Make sure Mint's link path is included in PATH.
### Initialization
```zsh
$ yaru init
```
This command creates `~/.yaru.yml`. Tasks are stored in this file.
## Advanced
### Show current task in prompt
Add to `~/.zshrc`.
```zsh
precmd() {
YARU_CURRENT=`yaru current`
PROMPT_YARU_CURRENT="%K{yellow}%F{black}${YARU_CURRENT}%f%k"
RPROMPT="${PROMPT_YARU_CURRENT}"
}
```
then, current task is shown in the right side of terminal.
## Contribution
Yaru is made for my personal use, so its implementation is so rough. PRs are welcome.
## License
MIT