Files
gems/README.md
T
joakim 52160345bf Implement Jade CLI v1.0 MVP
Complete implementation of note management CLI with all core features:

Commands:
- add: Create new notes in $EDITOR with auto-generated filenames
- list: Display all notes with titles, paths, and tags
- search: Full-text search via ripgrep, tag-based filtering
- tags: List all tags with occurrence counts
- edit: Fuzzy search and edit notes by title
- rm: Move notes to trash with confirmation prompt

Features:
- Automatic depository structure initialization (.jade/trash/)
- Configurable tag prefix (default '+')
- Parse title from first # heading (filename fallback)
- Extract tags anywhere in content
- Parse both [[wiki-links]] and [markdown](links)
- Trash system with timestamps to prevent conflicts

Technical:
- Global config at ~/.config/jade/config.yml
- Per-depository settings support
- Ripgrep integration for fast search
- $EDITOR integration for note editing
- Comprehensive README with usage examples
2026-01-01 21:54:36 +01:00

55 lines
2.1 KiB
Markdown

# Notr
Simple Go application for organizing and referencing notes. Loosely based on Obsidian.
**Implementation:** See `jade-depo/` directory for the CLI tool.
## Workflow
I take notes in two primary ways:
### Phone
- Quick notes, on the go.
- View and search notes.
### Workstation
- Using NeoVim for notetaking
### Other infrastructure
- I host a VPS with a Nextcloud and Gitea instances.
## What I want
- A Obsidian Vault like structure. A folder where notes live.
- A file is a note
- Can also store attachments, such as images. These files can then be referenced in the relevant notes.
- Directories is the main organization method, although tags and links can seam-lesly cross directories boundries.
- Markdown syntax (this can be handled by NeoVim and a markdown editor on other devices.)
- Tags: Syntax +tag
- Note links for referencing other notes or any other vault files. Syntax uncertain. Obsidian uses [[]]?
- See reports about the vault. Tag report
- At some point I would like to have a web-app and host it on my server. This would integrate with my authentik service for auth, and would be a live view of a users vault
- OCR would be great.
## Implementation
I have a tendency to scope creep and never actually getting a usable product, so an important goal here is practicing getting a usable app up and running. This should not have to be the biggest project, so I'll try to predict the process:
### Version 0.1
Here I use other tools for the note-taking and accept that any searching is on a directory basis only.
- [ ] I create a directory in Nextcloud. This I will start using immediately.
- [ ] Find a good Markdown editor for android.
- [ ] Adopt any crutial Obsidian notes
### Version 1.0 ✓
This is where I can use Notr to find and search notes on my workstation. CLI implementation complete!
- [x] Process notes. Metadata and diffs
- [x] Search and Filter by tags
- [x] Search and Filter by content
- [x] Add, edit, delete notes
- [x] List all notes and tags
### Version 2.0
Here I can do the same on my phone.
Also:
- [ ] OCR
## Metadata approach
Multiple approaches possible.