Provides commands to create, search, and open Markdown notes in user-defined spaces, using a configuration file for paths and editor settings.
Basic usage and setup on Linux.
python .\vfm.py --help
usage: vfm.py [-h] {init,new,stats,search} ...
Virtual Forest Mind CLI
positional arguments:
{init,new,stats,search}
init Initialize directories and config
new Create a new note
stats Output statistics: number of notes, most active space, total words.
search egrep-like search in a space/path. Usage: vfm.py search [target] pattern
options:
-h, --help show this help message and exitPlace either just outside or inside the root folder and change the permissions, or to make it system wide on Linux:
install -Dm755 vfm /usr/local/vfm/vfmWhat is the end goal of note-taking?
- Ease and simplicity to note-taking (less is more mentality)
- Shareability
- Flexibility and scalability
- Version control
I have been playing around with Foam and Obsidian, but having my own custom Python script vfm/vfm.py gave some more detailed control over certain details of the PKM, as well as meeting the ease and simplicity goal. I'll likely use a combination of the my script and some sort of GUI (like qOwnNotes, Obsidian, etc.).
If you're interested and the journey I took to get here, see my thoughts on note-taking.
Presenting a simple structure that can grow as needed:
virtual.forest.mind/
├── vfm.private/
│ ├── subdir-1, ..., subdir-N
│ └── For private material that is not to be shared...
|
├── vfm.public/
│ ├── subdir-1, ..., subdir-N
│ └── For material that I would like to share or publish...
| :
├── vfm.space/
│ ├── subdir-1, ..., subdir-N
│ └── Hammerspace space for Zettelkasten style notes that do not need any organization.
├── .git/
└── .gitignore
GNU GPLv3