Manage your daily notes like a bosssss
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib
test
.gitignore
.travis.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
Gemfile
INTRO.gif
INTRO_VIM.gif
LICENSE
README.md
Rakefile
worque.gemspec

README.md

Worque

Build Status Gem Version

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!

HOW IT WORKS

INTRO

WITH VIM

INTRO VIM

Installation

DO NOT add this to your Gemfile

Install it by

$ gem install worque

Quick start guide

CLI

worque todo

Explicitly declare your path

worque todo --path /path/to/your/notes

Or you might want to put it in the global configuration file ~/.worquerc

{
  "path": "/path/to/your/notes"
}

I often prefer mapping notes to my Dropbox like this:

{
  "path": "~/Dropbox/Notes/Todos"
}

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

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

Or look back what's done yesterday.

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

If you live in the future

worque todo --for=tomorrow
# ~/notes/checklist-2016-07-20.md

If you want to start from a default template

echo <<-EOF
List of things I need to do

* ......
* ...

Happy hacking
EOF >> /path/to/my/template

worque todo --template-path=/path/to/my/template
# ~/notes/checklist-2016-07-18.md
cat ~/notes/checklist-2016-07-18.md
> List of things I need to do
>
> * ......
> * ...
>
> Happy hacking

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

Moreover, you can add a task into your notes quickly without open that file.

worque todo --for today --append-task "Your task"

It's chain-able with other commands

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

Personally I like to create a shell function today like this, so vim will automatically open the file when I type today

today () { vim $(worque todo); }
ytd () { vim $(worque todo --for=yesterday); }

worque push

Please remember to add your slack api token to your ~/.worquerc

{
  "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

WORKQUE FOR WORKQUE

Something in my plan:

  • 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/issues.

License

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