🚀 Open Source • MIT License

Terminal-Based
Note Manager

A powerful, keyboard-driven TUI for managing your markdown notes. Built for developers who live in the terminal.

100%
Python
MIT
License
6
Templates
notes-tui
$ python -m notes_tui
┌─────────────────────────────────────┐
│ 📁 Notes                            │
│ ├── 📁 work                         │
│ │   ├── 📄 project-alpha.md         │
│ │   └── 📄 meeting-2025-10-27.md   │
│ ├── 📁 personal                     │
│ │   ├── 📄 daily-journal.md         │
│ │   └── 📄 ideas.md                 │
│ └── 📁 learning                     │
│     └── 📄 python-tips.md           │
└─────────────────────────────────────┘
Ready to browse your notes

Powerful Features

Everything you need to manage your notes efficiently from the terminal

📁

File Browser

Navigate your notes with an intuitive tree view. Keyboard-driven navigation for maximum efficiency.

👀

Live Preview

See your markdown rendered beautifully with syntax highlighting and rich formatting.

🎨

Template System

Create notes from 6 built-in templates: journals, meetings, projects, budgets, and more.

Fast & Lightweight

Minimal resource usage. Instant startup. Works perfectly over SSH and in remote environments.

🔍

Full-Text Search

Search across all your notes quickly. Find what you need when you need it.

⌨️

Keyboard First

Every action is accessible via keyboard shortcuts. Mouse optional.

🔗

Wiki Links

Connect your notes with [[wiki-style]] links. Build your personal knowledge base.

🎯

YAML Frontmatter

Organize notes with tags, categories, and custom metadata.

🌈

Syntax Highlighting

Beautiful code highlighting powered by Pygments for all major languages.

Quick Installation

Get started in seconds with pip or your favorite package manager

📦 Install from GitHub

# Clone the repository
git clone https://github.com/sirbrasscat/notes-tui.git
cd notes-tui

# Create virtual environment
python -m venv .venv

# Activate (Windows PowerShell)
.\.venv\Scripts\Activate.ps1

# Activate (macOS/Linux)
source .venv/bin/activate

# Install dependencies
pip install -r requirements.txt

# Run the app
python -m notes_tui

⚙️ Configuration

# Run with custom configuration
python -m notes_tui -c config/windows.yaml

# Configuration file example (config.yaml)
notes_directory: "./my-notes"
templates_directory: "./templates"
editor:
  default: "nvim"
  alternatives: ["vim", "nano"]

📋 Requirements

  • Python 3.8 or higher
  • Terminal with 256-color support
  • Works on Windows, macOS, and Linux

Built-in Templates

Start writing faster with professional note templates

📝

General Note

All-purpose template with sections, references, and related notes.

📅

Daily Journal

Track your daily thoughts, accomplishments, and reflections.

🤝

Meeting Notes

Capture agendas, discussions, and action items from meetings.

🚀

Project

Plan and track projects with milestones, tasks, and stakeholders.

📚

Learning Note

Document educational content with examples and practice exercises.

💰

Budget Entry

Track income, expenses, and savings with detailed tables.

Documentation

Everything you need to know to get the most out of Notes TUI

Ready to Get Started?

Join developers who manage their notes efficiently in the terminal