Inspired by Una Kravets
Simple way to create and manage weekly/monthly/yearly/other goals
To use: yarn global add personal-goals-cli
make sure to set the active directory and where to store your README although they will default to the folder you first call goals
from.
goals cfg dir '/users/me/projects/personal-goals/goals'
goals cfg readme '/users/me/projects/personal-goals/'
They can be the same, I just like the goals contained in their own folder 😀
All commands will start with goals
You can use new
or n
to create a new goal followed by the type (yearly
or y
, monthly
or m
, weekly
or w
, other
or o
).
The default is weekly
goals new w 'Play with puppies' #creates a new weekly goal
goals n other 'Work on a cool side project' #creates a new 'other' goal
goals n y 'Be kind' #creates a new yearly goal
goals n y 'Contribute to open source'
goals n y 'Write more blog posts'
You can use complete
or c
to mark a goal as completed followed by the type (yearly
or y
, monthly
or m
, weekly
or w
, other
or o
).
The default is weekly
goals complete w #will list all weekly goals and allow you to choose which to mark as completed
goals c #will list all weekly goals and allow you to choose which to mark as completed
goals c y #will list all yearly goals and allow you to choose which to mark as completed
You can use ls
or list
to list goals followed by the type (yearly
or y
, monthly
or m
, weekly
or w
, other
or o
, completed
or c
, or all
or a
).
The default is all
goals ls #lists all goals
goals list #lists all goals
goals ls c #lists all completed goals
goals list y #lists all yearly goals
goals ls weekly #lists all weekly goals
You can use config
or cfg
to manage the configuration settings
Possible configuration keys are dir
, readme
, types
, alias
, focus
, and title
The dir
is where your goals reside and readme
is where you want the README.md to be generated
goals cfg dir '/users/me/projects/personal-goals/goals'
goals cfg readme '/users/me/projects/personal-goals/'
goals conf focus w 'getting enough sleep'
goals config focus weekly 'getting more involved in communities'
goals cfg title weekly 'Shit I need to do this week'
goals cfg type today #creates a new goal of type 'today'
goals cfg alias t today #creates an alias for today so you can shorten it to 't'
goals cfg clear type t #for when you want to delete a goal type
goals config clear #will clear all config settings
goals config clear focus #will delete the all focuses
goals config ls #will list the current config settings
You can use clear
or clr
to clear goal followed by the type (yearly
or y
, monthly
or m
, weekly
or w
, other
or o
, completed
or c
, or all
or a
).
The default is all
goals clr #deletes all goals
goals clear weekly #deletes all weekly goals
goals clr c #deletes all completed goals
You can use delete
, d
, or del
to delete a goal followed by the type (yearly
or y
, monthly
or m
, weekly
or w
, other
or o
, completed
or c
, or all
or a
).
The default is weekly
goals del #lists weekly goals and will allow you to choose which to delete
goals delete y #lists yearly goals and will allow you to choose which to delete
goals d month #lists monthly goals and will allow you to choose which to delete
For each new goal, a README is generated in the directory specified by the dir
configuration. You'll see the goals for this project in the goals
driectory
The generated README will be in the following format where the order of the goals is configurable. Just edit the generated README and reorder as you wish
Personal Goals
==============
Personal goals made open source for accessibility across computers I use, transparency, accountability, and versioning. Learn more about it [here](http://una.im/personal-goals-guide).
Generated by the [personal-goals-cli](https://github.com/kevindavus/personal-goals-cli)
<!-- goals yearly start-->
# Overarching Goals:
* [ ] Be Kind
* [ ] Contribute To Open Source
* [ ] Write More Blog Posts
<!-- goals yearly end-->
<!-- goals weekly-focus start-->
### This Week's Focus: Be Awesome.
# Sep 4th, 2017
<!-- goals weekly-focus end-->
<!-- goals weekly start-->
### Things I'll Do This Week:
* [x] Play With Puppies _- September 6th 2017_
<!-- goals weekly end-->
<!-- goals monthly start-->
### Things I'll Do This Month ( September 2017 ):
* [ ] Read A Book
* [ ] Submit A CFP For A Conference
<!-- goals monthly end-->
<!-- goals other start-->
### Other Goals:
* [ ] Work On A Cool Side Project
<!-- goals other end-->
and will render like this :
Personal goals made open source for accessibility across computers I use, transparency, accountability, and versioning. Learn more about it here.
Generated by the personal-goals-cli
- Be Kind
- Contribute To Open Source
- Write More Blog Posts
- Play With Puppies - September 6th 2017
- Read A Book
- Submit A CFP For A Conference
- Work On A Cool Side Project