Worque

Worque is a CLI which is helpful to manage your daily notes.

  • Ever stunned when your boss suddenly asked what you've done yesterday?
  • Wanna check/note your daily tasks without exiting your favourite editor VIM?
  • Something to report on daily stand-ups?

Then worque is definitely a right tool for you!

Installation

DO NOT add this to your Gemfile

Install it by

$ gem install worque

Quick start guide

CLI

worque todo

Add this to your .bash_profile

export WORQUE_PATH='/path/to/your/notes'

I often map it to my Dropbox like this

export WORQUE_PATH='~/Dropbox/Notes/Todos'

Then executing the command below will create a today's note for you

worque todo --for today
# ~/notes/notes-2016-07-19.md

Or look back what's done yesterday.

workque todo --for=yesterday
# ~/notes/checklist-2016-07-18.md
# This will jump back to Friday's note if it's Monday today!

If you're kind of nerd and you have no life. You would rather work over the weekend than hanging out with folks, so you should enable the hardcore mode which will stop skipping weekend for you.

worque todo --for yesterday --no-skip-weekend

You can also explicitly specify the file path

worque todo --for today --path ~/path/to/your/notes

It's chain-able with other commands

vim worque
vim $(worque todo --for yesterday)
cat $(worque todo --for=yesterday) | grep pending

Personally I alias it like today like this, so vim will automatically open the file when I type today

alias today="vim $(worque todo) +':cd $WORQUE_PATH'"
alias ytd="vim $(worque todo) +':cd $WORQUE_PATH'"

worque todo

Please remember to add SLACK_API_TOKEN in your .bash_profile

export SLACK_API_TOKEN=very-$3Cr3T

Then the note for today will be automatically posted to the channel specified.

worque push --channel=daily-report

Alternatively, you can choose to push the note for yesterday

worque push --channel daily-report --for yesterday

VIM Integration

Add this to your VIM plugin manager

Plug 'huynhquancam/vim-worque'

Then :TD, :YTD for today and yesterday's notes respectively.

Read more about vim-worque.

View more in my dotfiles

Development

bundle install
bundle exec rake test

To be implemented

Something in my plan:

  • Test suites: Embarrassingly there's no test currently, but this will be my first priority.
  • worque list: List all notes you have.
  • worque changelog: Sync your Git commits to daily notes.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/huynhquancam/worque.

License

The gem is available as open source under the terms of the MIT License.