██████╗ ██╗ ██╗███╗ ██╗███████╗ ██╔══██╗██║ ██║████╗ ██║██╔════╝ ██████╔╝██║ ██║██╔██╗ ██║█████╗ ██╔══██╗██║ ██║██║╚██╗██║██╔══╝ ██║ ██║╚██████╔╝██║ ╚████║███████╗ ╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝╚══════╝

Rune is a terminal-first note-making app built with Go.
Pick a topic, chat through it, and generate structured markdown notes that are written to disk and previewed live inside a dual-panel tabbed TUI.

Why Rune

Rune is designed for people who want to learn, research, and write notes without leaving the terminal.

It helps you:

• start from a topic instead of a blank file
• guide a session as either learning or research
• generate markdown notes directly into your notes folder
• preview files live while they are being created
• resume older topic sessions later

Features

• Dual-panel tabbed TUI for chat and live notes preview
• Topic classification into skill or research workflows
• Pre-session guidance before the main session starts
• Markdown file generation with live filesystem watching
• Persistent session history per topic
• Local/cloud Ollama model selection with fallback support
• In-app log viewer, file explorer, and settings screen

Feature Highlights

Guided Topic Sessions

Rune starts from a topic, classifies the session, and guides the user through a more structured path instead of dropping them into an empty workspace.

Live Markdown Preview

Generated markdown files are written directly to disk and rendered live in the preview pane, so users can see their notes take shape immediately.

Resumable Sessions

Each topic keeps its own local session state, making it easy to come back later and continue work without starting over.

Terminal-First Workflow

Rune is built for users who prefer learning, researching, and writing without leaving the terminal.

Demo Flow

1. Start Rune
2. Enter a topic such as Java, system design, or linear algebra
3. Rune classifies the topic and begins a guided session
4. Notes are generated as markdown files
5. Notes preview updates live on the second panel (switch to it with Tab)
6. You can reopen the same topic later and continue where you left off

Demo Videos

Watch Rune in action to see how it structures your learning sessions directly inside the terminal.

Full Walkthrough

A complete walkthrough showing topic classification, live notes generation, and TUI pane switching.

full_tutorial.mp4

---

Feature Clips

1. Model & Provider Switching (Ollama Fallback)

Demonstrating how Rune routes prompts and switches models/providers seamlessly.

2. Resuming Previous Sessions

Demonstrating how topic session history and previous chats are reloaded on startup.

3. Document & File Attachments

Demonstrating how to attach files and documents (PDFs, markdown, CSVs, etc.) as context for topic sessions.

Missing / Required Demos:

To complete the demo section, the following feature recordings are still needed:

• Topic Classification: Showing how a user enters a topic (e.g., Go, linear algebra) and Rune classifies it as a learning or research session.
• Live Notes Preview: Zooming in on the live document rendering as files are created and updated live.
• File Explorer & Settings: Demonstrating Ctrl+E to toggle the file tree and Ctrl+T to adjust preferences.

Requirements

• Go 1.25.3
• Ollama running locally or reachable through OLLAMA_URL

Default Ollama endpoint:

http://localhost:11434

Optional environment variables:

OLLAMA_URL
OLLAMA_MODEL
OLLAMA_CLOUD_MODEL
OLLAMA_API_KEY
OLLAMA_NO_CLOUD=1

Installation

Automatic (Recommended)

Run the installation script to build and install Rune globally:

git clone https://github.com/bogusdeck/Rune
cd Rune
./install.sh

Manual

Clone the repository and build from source:

git clone https://github.com/bogusdeck/Rune
cd Rune
go build -o rune .

To run it locally:

./rune

Usage

If you used the Automatic installation, you can launch Rune from any directory:

rune

If you chose the Manual path and kept the binary in the project folder, run:

./rune

Controls

• Enter send chat input
• Tab switch active pane
• Ctrl+E toggle the file explorer
• Ctrl+L open the in-app log viewer
• Ctrl+O return to topic selection
• Ctrl+R rewind one user turn
• Ctrl+T open settings
• Ctrl+C quit

Project Structure

.
├── internal/
│   ├── core/        # private helper logic: prompts, parser, config, sessions
│   └── tui/         # TUI logic: model, views, updates, watcher, client, classifier
├── main.go          # app entrypoint
└── README.md

Notes Storage

Rune stores topic sessions and generated notes under your local notes directory in your home folder.

That includes:

• generated markdown files
• per-topic session state
• local Rune configuration
• log output

For Contributors

Useful local commands:

go test ./...
go build ./...
gofmt -w .

Publishing Notes

Before pushing this project to GitHub, keep the repository source-only:

• do not commit compiled binaries like rune
• do not commit local machine files like .DS_Store
• keep setup instructions in the README so users can build locally

License

Add a LICENSE file before publishing if you want others to use, modify, or distribute the project clearly.