A terminal-based post-it notes application with a 3x3 grid layout
Project description
TUI Notes 📝
A terminal-based post-it notes application — organize your thoughts in a 3×3 grid, right from the command line.
Features
- 3×3 Post-it Grid — Up to 9 notes displayed simultaneously
- 6 Colors — Yellow, Green, Blue, Pink, Orange, Purple (press
cto change) - Persistent Storage — Auto-saves to
~/.config/tui-notes/notes.json - Move Mode — Rearrange notes freely, even to empty slots
- Export — Export all notes to Markdown (
Ctrl+E) - Keyboard-driven — Full operation without mouse
Installation
# Clone and install
git clone https://github.com/douglas/tui-notes.git
cd tui-notes
pip install -e .
# Or with pipx (recommended for CLI tools)
pipx install .
Usage
tui-notes
Keyboard Shortcuts
| Key | Action |
|---|---|
a |
Add note at selected position |
e / Enter |
Edit selected note |
d |
Delete selected note (with confirmation) |
c |
Change note color |
m |
Enter Move mode (swap/reorder) |
← ↑ ↓ → |
Navigate between slots |
Ctrl+S |
Save notes manually |
Ctrl+R |
Reload notes from disk |
Ctrl+E |
Export to ~/tui-notes-export.md |
? |
Show help screen |
Escape |
Cancel move mode |
q |
Quit |
Data Storage
Notes are stored as JSON in the platform-specific config directory:
| Platform | Path |
|---|---|
| Linux | ~/.config/tui-notes/notes.json |
| macOS | ~/Library/Application Support/tui-notes/notes.json |
| Windows | %APPDATA%/tui-notes/notes.json |
Development
# Setup
python -m venv venv
source venv/bin/activate
pip install -e .
pip install -r requirements-dev.txt
# Run
python -m tui_notes
# Tests
pytest
# Linting
black tui_notes/ tests/
isort tui_notes/ tests/
pylint tui_notes/
Requirements
- Python 3.9+
- Terminal with color support
License
MIT — see LICENSE file.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file tui_notes-0.1.0.tar.gz.
File metadata
- Download URL: tui_notes-0.1.0.tar.gz
- Upload date:
- Size: 13.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8e8be5b5b43cb751124c3c893017e67bb0f916f863351a5c3ccfc8a6f204e669
|
|
| MD5 |
400e8196c1af16355e39d882d73a3f1d
|
|
| BLAKE2b-256 |
66b430543db6eda41ffa1e597a94ba7bbbd24217556f34788f2c05a48e576267
|
Provenance
The following attestation bundles were made for tui_notes-0.1.0.tar.gz:
Publisher:
publish.yml on Douglas019BR/tui-notes
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
tui_notes-0.1.0.tar.gz -
Subject digest:
8e8be5b5b43cb751124c3c893017e67bb0f916f863351a5c3ccfc8a6f204e669 - Sigstore transparency entry: 952256353
- Sigstore integration time:
-
Permalink:
Douglas019BR/tui-notes@b60a362e0beb521b9a08bcad7a6ad9e958b3b016 -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/Douglas019BR
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@b60a362e0beb521b9a08bcad7a6ad9e958b3b016 -
Trigger Event:
release
-
Statement type:
File details
Details for the file tui_notes-0.1.0-py3-none-any.whl.
File metadata
- Download URL: tui_notes-0.1.0-py3-none-any.whl
- Upload date:
- Size: 16.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0201e375205503850ea9d21685293abb285d4dc62371778ece760b5d917fe912
|
|
| MD5 |
62d0f886b3d0c93484db13575ed2144b
|
|
| BLAKE2b-256 |
8bce02125ea7ee31712c3c70abc1fd505105cb85af5b2293934af3a2f17d0159
|
Provenance
The following attestation bundles were made for tui_notes-0.1.0-py3-none-any.whl:
Publisher:
publish.yml on Douglas019BR/tui-notes
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
tui_notes-0.1.0-py3-none-any.whl -
Subject digest:
0201e375205503850ea9d21685293abb285d4dc62371778ece760b5d917fe912 - Sigstore transparency entry: 952256355
- Sigstore integration time:
-
Permalink:
Douglas019BR/tui-notes@b60a362e0beb521b9a08bcad7a6ad9e958b3b016 -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/Douglas019BR
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@b60a362e0beb521b9a08bcad7a6ad9e958b3b016 -
Trigger Event:
release
-
Statement type: