Skip to content

itolkien/dirnote

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📌 dirnote

Your directories have something to say.

Directory-specific notes that automatically appear when you cd into them.

Quick Demo

$ dirnote add "TODO: Refactor auth module"
Note added to ./.dirnote

$ dirnote show
--- Notes for /home/user/project ---
1: [2024-01-15 09:30] TODO: Refactor auth module
----------------------------------------

$ cd my-project  # Notes appear automatically!
--- Notes for /home/user/my-project ---
1: [2024-01-15 10:00] Remember to update API keys
----------------------------------------

Install

pip install dirnote
python -m dirnote init
# Restart your terminal

Usage

dirnote add "TODO: Refactor auth"   # Add note
dirnote show                         # View notes
dirnote rm 1                         # Remove note #1
dirnote clear                        # Remove all

Notes appear automatically:

$ cd my-project
--- Notes for /home/user/my-project ---
1: [2024-01-15 09:30] TODO: Refactor auth
----------------------------------------

Features

  • ✅ Zero dependencies
  • ✅ Cross-platform (Windows, macOS, Linux)
  • ✅ Works with bash, zsh, fish, PowerShell
  • ✅ Auto-display on cd

Why?

Because everyone forgets what they were working on.

License

MIT

About

Directory specific notes that automatically appear when you cd into them

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages