ledgerkit-editor 1.0.0

A keyboard-driven terminal editor for hledger plain-text accounting journals

ledgerkit-editor

A keyboard-driven terminal editor for hledger plain-text accounting journals.

Early beta — use with caution. This software is under active development and may corrupt your journal files. Always keep a backup before editing. Do not use on irreplaceable data without a recovery plan.

Built with Textual and ledgerkit.

---

Features

• Full-screen text editor with hledger syntax highlighting (dates, payees, accounts, amounts, commodities, comments, directives)
• Monokai Pro default theme; runtime theme switching supported
• Incremental search with match highlighting (Ctrl+F, Shift+PgUp/Down)
• View filter — show all / cleared-only / unreconciled-only transactions (Ctrl+L)
• Transaction block selection and duplication (Ctrl+T, Ctrl+G)
• Cleared status toggle — single transaction (3-state cycle) and bulk selection (Ctrl+R)
• Insert today's date at cursor (Ctrl+D)
• Date shifting with Shift+Up / Shift+Down (cursor-position-aware)
• Save with date-sort and whitespace re-alignment (Ctrl+S)
• Undo / Redo (Ctrl+Z / Ctrl+Y)
• Command palette (Ctrl+P)

Planned / In Progress

• Transaction filter popup (Ctrl+O) — UI stub only; criteria filtering not yet implemented
• BalanceSidebar — account balance tree (wired up, threaded refresh on save)
• RegisterPanel — account transaction register (wired up, last 500 rows)
• Reconciliation mode

---

Installation

From PyPI

pip install ledgerkit-editor
ledgerkit-editor path/to/my.journal

Development setup

git clone https://github.com/ctosullivan/ledgerkit-editor.git
cd ledgerkit-editor

python -m venv .venv
.venv\Scripts\activate        # Windows
# source .venv/bin/activate   # macOS / Linux

pip install --upgrade pip
pip install -e ".[dev]"

# Run tests
pytest --tb=short

# Launch
ledgerkit-editor path/to/my.journal

---

Journal File Resolution

The editor resolves the journal file in this order:

1. Path passed as a command-line argument
2. $LEDGER_FILE environment variable
3. ~/.hledger.journal default
4. Interactive prompt on launch (if none of the above resolve)

---

Keyboard Shortcuts

See docs/shortcuts.md for the full reference.

---

Requirements

• Python 3.9+
• textual 8.2.5
• ledgerkit 1.0.0.dev1

---

Development

See CONTRIBUTING.md for setup instructions and the ledgerkit dependency update workflow.

Roadmap

See ROADMAP.md for planned features and current development status.

---

This repository was previously named PyLedger-editor. GitHub redirects old URLs automatically.