Introduction

KatanOS is a local-first productivity desktop app built with Electron, React, and TypeScript.

Core functional areas:

• dashboard

• agenda (calendar)

• todo board and checklists

• finance tracking and planning

• contacts

• habits

• journal

• bookshelf

• encrypted vault

• mini-games

The app has no backend service. Primary data persistence is local (IndexedDB with localStorage fallback), plus optional filesystem backups through Electron IPC.

Project Status

This repository is published as a stable baseline, not as a fast-moving product branch.

The intended usage is:

• reference implementation

• forkable foundation

• modifiable personal desktop system

Documentation Scope

These docs are implementation-driven and describe the current codebase behavior, including:

• runtime architecture and process boundaries

• module-by-module behavior and data contracts

• service APIs and Electron bridge

• build/release workflows

• security model and known limitations

What "Spec" Means Here

This documentation uses "spec" in a pragmatic sense:

• it documents what the code does now

• it highlights important edge behavior and constraints

• it avoids aspirational features not present in source

When code and docs diverge, source code is authoritative.