Quick Start

1. Create the configuration file

swelog init

This creates swelog/swelog.json inside your operating system’s configuration directory.

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 unless you want to change the names of the files and folders that swelog creates.

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

See Configuration for more details.

3. Create the vault files

swelog setup

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

4. Write today’s notes

Open the work file in Obsidian. Write down your priorities for the day under ## Priorities and what you did under ## Log.

5. Fetch activity from external sources

Fetch GitHub activity, Linear tickets, Google Calendar events, etc.

swelog fetch github
swelog fetch linear
swelog fetch google-calendar

# Run the following command to fetch all configured integrations
swelog fetch all

See Integrations for more details.

6. Log the day

Option 1: Log your notes verbatim

swelog log

This stores your notes into the daily log and resets your work file.

Option 2: Summarize your notes

swelog summarize

This stores an AI-generated summary of your notes, with your original notes appended at the bottom so they are not lost.

See Summarization for more details.

7. Summarize your week (Optional)

Once it is Friday and you have a weeks worth of notes, you can summarize your week with

swelog summarize week

See Summarization for more details.