Skip to main content

Directory notes that appear when you cd into them

Project description

📌 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dirnote-1.0.0.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dirnote-1.0.0-py3-none-any.whl (5.2 kB view details)

Uploaded Python 3

File details

Details for the file dirnote-1.0.0.tar.gz.

File metadata

  • Download URL: dirnote-1.0.0.tar.gz
  • Upload date:
  • Size: 4.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for dirnote-1.0.0.tar.gz
Algorithm Hash digest
SHA256 66f3abd09c495853725d060be71dfda828ddc8522db400c23e27f2f1fe64bd19
MD5 8307a122b3ea94c54a24e11a2f0bb71c
BLAKE2b-256 d12e38079fa94bf73de784d1ea082f4253202591bbcbce2015579ebeefef60b0

See more details on using hashes here.

File details

Details for the file dirnote-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: dirnote-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 5.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.0

File hashes

Hashes for dirnote-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 616f79e5efdf14a370be28f2a3348302f5005c3f53cc7b9b3f1d1cf81bfeb997
MD5 7afcb39137263d06057347168ead17df
BLAKE2b-256 ef1536c6e95a88a4b700dfdd92e50aadcef2feb7f7a3f21af73ee40379936b2a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page