PitchHut logo
Effortlessly manage notes using the Zettelkasten method from your terminal.
Pitch

ztlgr is a terminal-based note-taking application designed around the Zettelkasten methodology. Offering fast search capabilities, multiple note types, and an intuitive linking system, it promotes efficient organization and retrieval of knowledge. Built with Rust, it ensures both speed and reliability for seamless note management.

Description

ztlgr is a lightweight, terminal-based note-taking application that employs the Zettelkasten methodology, developed using Rust. This tool offers a structured approach to organizing notes through Luhmann-style IDs and supports various note types, ensuring a flexible and efficient workflow for users.

Key Features

  • Zettelkasten Methodology: Deploys Luhmann-style IDs to enhance the organization of notes.
  • Fast Search: Utilizes SQLite FTS5 for advanced full-text searching capabilities.
  • Diverse Note Types: Supports daily, fleeting, literature, permanent, reference, and index notes, catering to different note-taking needs.
  • Link System: Enables easy linking of notes with a wiki-style approach using [[note-title]] links, complete with backlinks.
  • Custom Themes: Offers built-in themes such as Dracula (default), Gruvbox, Nord, and Solarized, with the option to create personalized themes.
  • Vim Keybindings: Features modal editing that leverages familiar Vim shortcuts for seamless user interaction.
  • Future-Proof Architecture: Built on a robust system with local files and smart database indexing, ready for future extensions.

Quick Start

Begin by creating a new vault and organizing notes effortlessly with commands like:

ztlgr new my-vault  
ztlgr open my-vault  
# Or use the default vault location
ztlgr

KeyBindings

Normal Mode

  • j/k: Navigate note list
  • h/l: Switch between panels
  • g/G: Jump to top/bottom
  • n: Create a new note
  • /: Search
  • :q: Quit (Vim-style)

Insert Mode

  • Esc: Exit insert mode

Configuration

Easily customize your setup by editing the configuration stored in ~/.config/ztlgr/config.toml. This file allows adjustments such as theme selection, sidebar width, and auto-save intervals.

Themes

Choose from several built-in themes:

  • dracula: Purple and cyan accents
  • gruvbox: A retro color palette
  • nord: Cool, arctic tones
  • solarized: Thoughtfully designed precision colors

Or design a custom theme by defining color settings in your config.

Architecture

ztlgr employs a multi-agent architecture, enhancing the app’s modular functionality:

  • NoteAgent: Handles note creation, reading, updating, and deletion.
  • LinkAgent: Manages connections between notes effectively.
  • SearchAgent: Responsible for full-text search capabilities.
  • GraphAgent: Manages knowledge graph operations.
  • UIAgent: Oversees terminal user interface interactions.

Optimize knowledge management by incorporating advanced features and intuitive design in your note-taking with ztlgr.

0 comments

No comments yet.

Sign in to be the first to comment.