https://github.com/amorriscode/cronicle

A journal in your terminal
https://github.com/amorriscode/cronicle

brag-document cli golang journal todo

Last synced: 4 months ago
JSON representation

A journal in your terminal

• Host: GitHub
• URL: https://github.com/amorriscode/cronicle
• Owner: amorriscode
• License: other
• Created: 2022-03-05T05:22:49.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-04-04T03:30:31.000Z (almost 3 years ago)
• Last Synced: 2024-05-01T16:58:08.851Z (9 months ago)
• Topics: brag-document, cli, golang, journal, todo
• Language: Go
• Homepage:
• Size: 88.9 KB
• Stars: 10
• Watchers: 2
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# cronicle

A journal in your terminal.

As developers, it's easy to get lost in the weeds. `cronicle` helps you keep track of your todo list, your daily work log, and your [brag doc](https://jvns.ca/blog/brag-documents/).

Keep track of your developer journey in the command line.

## Features

- Manage your todos

- Log your daily work

- Keep track of [work you're proud of](https://jvns.ca/blog/brag-documents/)

- All your data is stored in plain text; toss it in git or take it elsewhere

## Data Formats

All plain text data in `cronicle` is stored as a combination of Markdown and YAML. We use YAML front matter to store metadata related to daily logs and brag doc items.

`tags` are optional for all data formats.

### Todo

```yaml

---

date: 2022-03-01 05:03:30

due: 2022-04-01 05:03:30

type: todo

tags: [bug]

---

- [ ] Debug infinite loop on /status page

```

### Daily Log

Daily logs are stored in a single Markdown file that has the date (eg. `2022-03-1`). This allows you to write as much detail as you'd like for an item.

When a todo item is completed, it will automatically get added to a To Do section in the daily log.

```yaml

---

date: 2022-03-01 05:03:30

type: daily

tags: [pr]

---

## To Do

- [x] Review PR for updating UI during create events

## Daily

- Reviewed [PR](https://github.com/12products/warroom-frontend/pull/46) for updating UI during create events

```

### Brag Item

```yaml

---

date: 2022-03-01 05:03:30

type: brag

tags: [talk]

---

- Gave talk to entire company on performance improvements.

```