den-python 0.1.1

Braindumping for projects made easy.

Braindumping for projects made easy.

Overview

• Context-Aware Notes: Thoughts are meant to be messy. den provides a place to put thoughts down and come back to them later. It keeps your notes tied to the specific project you’re working on, so nothing loses context. As you switch directories and projects, your notes move with you organically.
• Interactive TUI: The built-in curses-based Terminal User Interface (TUI) provides a fast, keyboard-first way to navigate, search, view, and manage your notes.
• Reference Tracking: Anchor your thoughts to specific parts of your codebase by attaching file references directly to your notes.
• Scriptable CLI: Core commands (den add, den ls, den rm) are simple and designed to be integrated into broader developer workflows or native editor mappings (like Neovim or shell aliases).

Installation

[!IMPORTANT] The PyPI package name is den-python, but the installed command is den. Requires Python 3.12+.

pip (PyPI)

The recommended way to install den is using pip (or pipx for an isolated environment):

pip install den-python

Arch Linux (AUR)

If you are using Arch Linux, you can install from the AUR:

yay -S den

From Source

You can always clone and install directly from the source:

git clone https://github.com/RaghavGohil/den.git
cd den
pip install .

Usage

Interactive Dashboard (TUI)

den

Opens an interactive curses-based TUI to quickly navigate and operate on your notes.

List notes

den ls

Displays all saved notes for the current project.

Add a note

den add <note text>

You can pass multiple words without quotes:

den add build a realtime terrain engine

Attach a code reference: If your thought is linked to a specific implementation, you can track it with the --ref flag:

den add fix this rendering issue --ref src/engine.py:42-50

Edit a note

den edit [id]

Opens the note in your default $EDITOR. If no id is provided, edits the most recently added note (default: 1).

Remove a note

den rm [id]

Deletes a note. If no id is provided, removes the most recently added note (default: 1).

Commands Summary

Command	Description
den	Launch interactive TUI
den ls	List all notes for the current project
den add [text]	Add a note
den add --ref [path]	Add a note with an anchored code reference
den edit [id]	Edit a note (defaults to the most recent note)
den rm [id]	Remove a note (defaults to the most recent)

Dependencies

This project uses no external dependencies (outside of the Python standard library), ensuring a lightweight and conflict-free tool logic.

Additional notes

If you find this project to be useful, please don't forget to leave a star. This keeps me motivated to continue working on the project.

License

MIT License