/llm-markdown-journal-summary

Script to run Ollama to summarise journals in Markdown.

Primary LanguageTypeScript

Markdown Journal Summariser

Requirements

Before running this script you need to:

1. Install Bun

Bun is the JavaScript runtime used to run this script.

You can check if Bun is installed by running bun -v in the terminal.

To install Bun, have a look at the installation documentation.

2. Install Ollama

Ollama is used to run a local language model on your maching.

Make sure to download and install Ollama.

3. Install dependencies

bun install

4. Update Obsidian path

Copy the example file:

cp .env.example .env

Update the .env file with the path to your Obsidian journals.

Usage

Start Ollama by either:

  1. Run ollama serve in your terminal, or
  2. Open the Ollama app.

Run the script:

Caution

The script modifies files on your system without confirmation. Use with caution, and backup your data.

bun run start

To run without file changes:

bun run start --dry

Configuration

See:

  • Path to your Obsidian journals: .env.example
  • To tweak prompts: /src/config.ts

Gotchas

  • This script does not process subdirectories.
  • As you might know, large language models are prone to hallucination.

Contributing

  • Feel free to create an issue if you would like to implement a feature or improve the script!