Skip to content
swelog

Quick Start

1. Create the configuration file

Section titled “1. Create the configuration file”
Terminal window
swelog init

This creates swelog/swelog.json inside your operating system’s configuration directory. Run swelog config at any time to display the exact path.

2. Configure your Obsidian vault

Section titled “2. Configure your Obsidian vault”

Open swelog.json and set obsidianVaultPath to the absolute path of your vault. That is the only field you have to fill in.

{
  "obsidianVaultPath": "/absolute/path/to/your/vault",
  "swelogFolderName": "swelog",
  "workFileName": "WORK.md",
  "contextFileName": "CONTEXT.md",
  "dailyLogFolderName": "Daily",
  "weeklyLogFolderName": "Weekly"
}

Every field is described in Configuration.

3. Create the vault files

Section titled “3. Create the vault files”
Terminal window
swelog setup

Swelog creates the work and context files plus the daily and weekly log directories under <obsidianVaultPath>/<swelogFolderName>.

4. Write today’s notes

Section titled “4. Write today’s notes”

Open WORK.md in Obsidian and jot down what you did under ## Log. Short bullets are enough — this is a scratch pad, not a finished document.

5. File the day

Section titled “5. File the day”
Terminal window
swelog log

This writes Daily/MM-DD-YYYY.md with your notes under a # Daily Log - MM-DD-YYYY heading, then resets WORK.md so tomorrow starts clean. Pass --keep to leave WORK.md alone.

Next steps

Section titled “Next steps”