Skip to content

hiragram/yaru

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

$ 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".

$ 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.

$ yaru next
$ yaru current
debug ios app

Installation

Install using Mint (Recommended)

Use Mint to install Yaru.

$ 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

$ yaru init

This command creates ~/.yaru.yml. Tasks are stored in this file.

Advanced

Show current task in prompt

Add to ~/.zshrc.

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

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages