Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qcam/worque
Manage your daily notes like a bosssss
https://github.com/qcam/worque
Last synced: 18 days ago
JSON representation
Manage your daily notes like a bosssss
- Host: GitHub
- URL: https://github.com/qcam/worque
- Owner: qcam
- License: mit
- Created: 2016-07-20T09:49:32.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-07-03T12:33:58.000Z (over 7 years ago)
- Last Synced: 2024-05-12T12:21:31.219Z (6 months ago)
- Language: Ruby
- Homepage: https://github.com/qcam/worque
- Size: 3.96 MB
- Stars: 123
- Watchers: 8
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Worque
[](https://travis-ci.org/huynhquancam/worque)
[](https://badge.fury.io/rb/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
```sh
worque todo --path /path/to/your/notes
```
Or you might want to put it in the global configuration file `~/.worquerc`
```json
{
"path": "/path/to/your/notes"
}
```
I often prefer mapping notes to my Dropbox like this:
```sh
{
"path": "~/Dropbox/Notes/Todos"
}
```
Then executing the command below will create a today's note.
```sh
worque todo --for today
# ~/notes/notes-2016-07-19.md
```
Or look back what's done yesterday.
```sh
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
```sh
worque todo --for=tomorrow
# ~/notes/checklist-2016-07-20.md
```
If you want to start from a default template
```sh
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.
```sh
worque todo --for yesterday --no-skip-weekend
```
Moreover, you can add a task into your notes quickly without open that file.
```sh
worque todo --for today --append-task "Your task"
```
It's chain-able with other commands
```sh
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`
```sh
today () { vim $(worque todo); }
ytd () { vim $(worque todo --for=yesterday); }
```
#### `worque push`
Please remember to add your [slack api token](https://api.slack.com/docs/oauth-test-tokens) to your `~/.worquerc`
```json
{
"token": "very-$3Cr3T"
}
```
Then the note for today will be automatically posted to the channel specified.
```sh
worque push --channel=daily-report
```
Alternatively, you can choose to push the note for yesterday
```sh
worque push --channel daily-report --for yesterday
```
### VIM Integration
Add this to your VIM plugin manager
```viml
Plug 'huynhquancam/vim-worque'
```
Then `:TD`, `:YTD` for today and yesterday's notes respectively.
Read more about [vim-worque](https://github.com/huynhquancam/vim-worque).
View more in my [dotfiles](https://github.com/huynhquancam/dotfiles)
## Development
```sh
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](https://github.com/huynhquancam/worque/issues).
## License
The gem is available as open source under the terms of the
[MIT License](http://opensource.org/licenses/MIT).