Chronicle

A minimalist command-line journaling system for tracking daily activities, metrics, and insights.

Chronicle is a lightweight tool that helps you systematically log and analyze your daily life using simple, human-readable text files. It emphasizes privacy by storing all data locally while maintaining flexibility in how you record and review your information.

Features

• Chronicle uses a simple text format: you can use any text editor with our .chr file format.
• It is privacy-first: all data stored locally on your machine.
• You can track multiple metrics:
  • daily activities and events,
  • health and fitness metrics,
  • tasks and goals,
  • sleep patterns,
  • custom metrics.
• Chronicle allows you to generate insights: analyze patterns and create summaries.
• .chr files have a flexible syntax: intuitive format for quick entries.

Data Format

Chronicle uses plain text files with the .chr extension. The syntax is designed to be both human-readable and machine-parseable.

Events and Tasks

Events are activities that have occurred, while tasks are planned future events.

-- Comments start with `--`.

-- Completed events.
podcast @inner_french e147 00:00/45:00
19:00/19:30 run 5.2km

-- Tasks (prefixed with [ ] or [x]).
[x] do the dishes
[ ] clean @bathroom

-- Future events (prefixed with >>>).
>>> 20:00/ concert @radiohead

Objects

Define reusable objects to simplify your entries:

podcast @innerfrench = Inner French Podcast .fr
book @dune = Dune by Frank Herbert

Special Commands

Date entries help organize your journal chronologically:

2024-01-01 -- Sets the current date.

Requirements

• Python 3.12+.

Installation

pip install .

Usage

See

chronicle --help