KatanOS

Local-first productivity desktop app built with Electron, React, and TypeScript.

Quick Links

• Install (Microsoft Store)
• Docs
• Forking
• Cite/Attribution

Fork-friendly: feel free to rebrand and ship your own version. Please keep LICENSE and NOTICE; CITATION.cff is provided for attribution.

Screenshots

More screenshots

Local-first productivity desktop app built with Electron, React, and TypeScript.

Documentation · Website · Sponsor

Built to keep your life organized, not your data exposed.

What KatanOS is

KatanOS combines core productivity workflows into one desktop app while keeping data ownership on your machine.

Why It Feels Different

• local-first architecture, no required backend
• desktop-native Electron bridge (window.katanos) for real filesystem workflows
• encrypted vault with recovery flow
• per-user backup/restore and export/import support
• modular structure designed to be forked and extended

Modules At a Glance

• dashboard
• agenda and events
• todo and checklists
• finance tracking
• contacts
• habits
• journal
• bookshelf
• encrypted vault
• mini-games

Project Status

This repository is published as a stable open baseline.

The original scope has been shipped. The codebase is now available for anyone who wants to fork it, extend it, or adapt it.

Documentation

The full technical documentation lives on GitBook:

• docs.katania.me

It covers architecture, modules, data model, Electron APIs, security, and release workflow.

Forking

If you want to create your own branded variant, see FORKING.md for rebrand, build, and publish steps.

Sponsorship (optional)

If KatanOS is useful to you, sponsorship helps sustain maintenance.

• GitHub Sponsors
• Backers list

No support SLA; sponsorship is a donation.

Contributing

For contributions and collaboration flow, see CONTRIBUTING.md.

For issue filing, use the templates:

• Bug report template
• Feature request template

Quick Start

Run in development:

npm ci
npm run electron:dev

Run tests:

npm run test

Build desktop package:

npm run electron:build

Metadata

Key	Value
Version	1.0.9
App ID	com.katanos.app
Microsoft Store ID	9NBNSBD58DNL

License

Apache License 2.0.

See LICENSE for details.

Attribution

If you reuse this project, keep LICENSE and NOTICE intact and, if possible, credit the author in your About page or documentation.

This is a social norm, not an additional legal requirement beyond Apache-2.0.