qcam / worque

Manage your daily notes like a bosssss

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!

HOW IT WORKS

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

worque's Issues

Drop ruby 1.9 support

Failure to launch on OSX

After a fresh install on OSX, I get the following output on running worque todo

/System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/lib/ruby/2.0.0/fileutils.rb:1545:in `path': no implicit conversion of nil into String (TypeError)
        from /System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/lib/ruby/2.0.0/fileutils.rb:1545:in `block in fu_list'
        from /System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/lib/ruby/2.0.0/fileutils.rb:1545:in `map'
        from /System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/lib/ruby/2.0.0/fileutils.rb:1545:in `fu_list'
        from /System/Library/Frameworks/Ruby.framework/Versions/2.0/usr/lib/ruby/2.0.0/fileutils.rb:199:in `mkdir_p'
        from /Library/Ruby/Gems/2.0.0/gems/worque-0.1.4/lib/worque/utils/command.rb:9:in `mkdir'
        from /Library/Ruby/Gems/2.0.0/gems/worque-0.1.4/lib/worque/command/todo.rb:13:in `call'
        from /Library/Ruby/Gems/2.0.0/gems/worque-0.1.4/lib/worque/command/todo.rb:23:in `run'
        from /Library/Ruby/Gems/2.0.0/gems/worque-0.1.4/lib/worque/cli.rb:18:in `todo'
        from /Library/Ruby/Gems/2.0.0/gems/thor-0.19.1/lib/thor/command.rb:27:in `run'
        from /Library/Ruby/Gems/2.0.0/gems/thor-0.19.1/lib/thor/invocation.rb:126:in `invoke_command'
        from /Library/Ruby/Gems/2.0.0/gems/thor-0.19.1/lib/thor.rb:359:in `dispatch'
        from /Library/Ruby/Gems/2.0.0/gems/thor-0.19.1/lib/thor/base.rb:440:in `start'
        from /Library/Ruby/Gems/2.0.0/gems/worque-0.1.4/bin/worque:6:in `<top (required)>'
        from /usr/bin/worque:23:in `load'
        from /usr/bin/worque:23:in `<main>'

This is using ruby 2.0.0p481 and gem 2.0.14, OSX 10.10.5

as a user I would like to start my status from a template

Options to jump back on workdays or all days

As I noticed:

worque --yesterday

Will jumps to Friday's notes if it's Monday.

I'm a passionate developer who spending all my weekend coding, so why not add an option or config to allow worque skip or not the weekend?

P/S: @huynhquancam please do not do this. I create this issue just because I think I want to assign it to myself for a pull request

Configuration file

By default configuration will be loaded from ./.worquerc, ~/.worquerc, files are in JSON format including:

{
  "worque_path":"~/path/to/worque",
  "skip_weekend":true
}

Another command likeworque init to help initiate the file.

as a user, I would like to set up future todo's

I'm often planning days out. it would be nice to at a minimum be able to set up tomorrow.