https://github.com/mrtazz/plan
cli tool for some planning tasks
https://github.com/mrtazz/plan
cli github golang markdown planning
Last synced: 5 months ago
JSON representation
cli tool for some planning tasks
- Host: GitHub
- URL: https://github.com/mrtazz/plan
- Owner: mrtazz
- License: mit
- Created: 2022-10-19T06:47:52.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-01T14:32:46.000Z (over 2 years ago)
- Last Synced: 2025-06-07T07:40:58.174Z (about 1 year ago)
- Topics: cli, github, golang, markdown, planning
- Language: Go
- Homepage:
- Size: 43.9 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# plan
cli tool for some planning tasks
This is mostly support tooling for https://github.com/mrtazz/vim-plan
## Usage
```
% plan --help
Usage: plan
Flags:
-h, --help Show context-sensitive help.
--debug Enable debug mode.
--config-file=".plan.yaml" path to the config file.
Commands:
add-todo ...
Add a todo to the current daily note.
add-note ...
Add a note to the current daily note.
daily-prep
create the daily note file
get-assigned-issues
Retrieve assigned issues
import-screenshots
Import screenshots to the plan folder
validate-config
Validate the passed config and return.
version
print version and exit.
Run "plan --help" for more information on a command.
```
## Configuration
`plan` looks for a `.plan.yaml` config file in the current directory or can be
passed a config file to use as a flag. There are a couple of things that can
be configured via the config file, like recurring tasks, the daily template to
use, and the query to use to get GitHub issues.
### Example config file
```yaml
recurring_tasks:
Monday:
- plan the week
Friday:
- update achievements doc
daily_template: |-
## Misc
It's {{ .Weekday }} today.
You have {{ len .RecurringTasks }} recurring tasks today:
{{ range .RecurringTasks }}
{{- .Name }}
{{- end }}
You have {{ len .AssignedTasks }} issues assigned:
{{- range .AssignedTasks }}
- [ ] {{ .Name }} [link]({{ .URL }})
{{- end }}
## Log
github:
task_query: "assignee:mrtazz org:github state:open"
screenshot_import:
source: "~/Desktop"
destination: "dailies/20060102_attachments"
file_format: "Screenshot 2006-01-02 at 15.04.05.png"
```
## Installation
There are pre-built binaries [on the releases page](https://github.com/mrtazz/plan/releases/)
or the go standard way should also work, e.g.:
```
go install github.com/mrtazz/plan@latest
```