Skip to content

aeilot/lsnotes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

lsnotes

Screen Shot 2025-08-09 at 10 43 26 PM

Adding descriptions to your directories!

lsnotes - lsnotes: Annotate Your Directories, the Easy Way | Product Hunt


What’s lsnotes?

lsnotes lets you attach and display notes for directories. Just drop a .lsnotes file in any folder and voilà—your directory has a description. Now remade with:

  • Python — easier to use and extend
  • Typer — for snappy, intuitive CLI
  • Markdown support — so your notes can look sleek and formatted

A story

It was originally just an April Fools joke that I told @MrWillCom, but it turned out to be a brilliant idea. So I made this project.

Installation

Clone and build by yourself!

poetry install

or get it from PyPI!

pip install lsnotes

Usage

lsnotes view # does the same as above

lsnotes --help # for assistance

lsnotes edit # edits the .lsnotes file with your default editor

lsnotes config # for configuration

Examples

alias ls = "lsnotes view && ls"
alias pwd = "lsnotes view && pwd"
# etc.

Other Ports

We welcome you to implement the .lsnotes standard using various languages or on diverse platforms.


Made with love by @aeilot at aeilot.top

About

Add a description to your directories!

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages