From 9881d83cb4c03b815c1f0ee149f854399aad3c63 Mon Sep 17 00:00:00 2001 From: Olivier Date: Sat, 27 Dec 2025 21:20:39 -0500 Subject: [PATCH] feat: Add navigation commands for periodic notes and update filename formats in README.md --- README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/README.md b/README.md index 815b22a..6562f64 100644 --- a/README.md +++ b/README.md @@ -76,6 +76,35 @@ onyx quarterly onyx yearly ``` +### Periodic Notes Navigation + +You can open, create, or navigate to specific daily, weekly, monthly, quarterly, or yearly notes using: + +```bash +# Open a note for a specific date +onyx daily --date "2025-11-27" # opens daily note for Nov 27, 2025 +onyx weekly --date "2025-11-27" # opens weekly note for the week containing Nov 27, 2025 +onyx monthly --date "2025-11-27" # opens monthly note for Nov 2025 +onyx quarterly --date "2025-11-27" # opens quarterly note for Q4 2025 +onyx yearly --date "2025-11-27" # opens yearly note for 2025 + +# Navigate to next or previous period +onyx daily --next # opens tomorrow's note +onyx weekly --previous # opens last week's note +onyx monthly --next # opens next month's note +onyx quarterly --next # opens next quarter's note +onyx yearly --previous # opens last year's note +``` + +**Filename formats:** +- Daily: `YYYY-MM-DD.md` +- Weekly: `YYYY-WWW.md` (ISO week, e.g. `2025-W48.md`) +- Monthly: `YYYY-MM.md` +- Quarterly: `YYYY-QX.md` (e.g. `2025-Q4.md`) +- Yearly: `YYYY.md` + +The correct filename is always generated automatically, regardless of your plugin settings. + ### Creating & Editing Notes ```bash @@ -200,3 +229,4 @@ default_vault: my-vault vaults: my-vault: /path/to/vault work: /path/to/work/vault +```