This commit is contained in:
thePR0M3TH3AN
2025-05-15 23:15:30 -04:00
parent e6d22ba605
commit e82c5cb53e
10 changed files with 307 additions and 58 deletions

View File

@@ -1,9 +1,42 @@
# Quick start & Demo
## Quick start
```bash
# initialize the demo database
marlin init
# index only your demo folder
marlin scan ~/marlin_demo_complex
# tag all markdown in your demo Projects as “project/md”
marlin tag "~/marlin_demo_complex/Projects/**/*.md" project/md
# mark your demo reports as reviewed
marlin attr set "~/marlin_demo_complex/Reports/*.pdf" reviewed yes
# search for any reviewed files
marlin search "attr:reviewed=yes"
# snapshot the demo database
marlin backup
# test linking within your demo
touch ~/marlin_demo_complex/foo.txt ~/marlin_demo_complex/bar.txt
marlin scan ~/marlin_demo_complex
foo=~/marlin_demo_complex/foo.txt
bar=~/marlin_demo_complex/bar.txt
marlin link add "$foo" "$bar"
marlin link list "$foo"
marlin link backlinks "$bar"
````
---
# Marlin Demo
Heres a little “complexdemo” you can spin up to exercise tags, attributes, FTS queries, `--exec` hooks, backups & restores. Just copypaste each block into your terminal:
---
### 0Create the demo folder and some files
```bash
@@ -148,18 +181,4 @@ marlin restore "$snap"
# Confirm you still see “TODO”
marlin search TODO
```
---
That gives you:
* **wide folder structures** (Projects, Logs, Reports, Scripts, Media)
* **hierarchical tags** you can mix and match
* **key-value attributes** to flag state & review
* **FTS5 queries** with AND/OR/NOT
* **`--exec` hooks** to trigger external commands
* **JSON output** for programmatic gluing
* **backups & restores** to guard your data
Have fun playing around!
```