obsidian-cli-inspector 0.2.2

Local-first CLI/TUI for indexing and querying Obsidian vaults
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
use crate::config::Config;
use crate::db::Database;
use crate::logger::Logger;
use crate::query;
use anyhow::{Context, Result};
use chrono;

/// Search vault using full-text search
pub fn search_vault(
    config: &Config,
    query_str: &str,
    limit: usize,
    logger: Option<&Logger>,
) -> Result<()> {
    let db_path = config.database_path();

    if !db_path.exists() {
        anyhow::bail!(
            "Database not found at: {}\nRun 'obsidian-cli init' first",
            db_path.display()
        );
    }

    let db = Database::open(&db_path)
        .with_context(|| format!("Failed to open database: {}", db_path.display()))?;

    if query_str.is_empty() {
        if let Some(log) = logger {
            let _ = log.print_and_log("search", "Search query cannot be empty");
        } else {
            println!("Search query cannot be empty");
        }
        return Ok(());
    }

    let results = db
        .conn()
        .execute_query(|conn| query::search_chunks(conn, query_str, limit))
        .context("Failed to execute search")?;

    if results.is_empty() {
        let msg = format!("No results found for: {query_str}");
        if let Some(log) = logger {
            let _ = log.print_and_log("search", &msg);
        } else {
            println!("{msg}");
        }
        return Ok(());
    }

    let msg = format!(
        "Search Results for '{query_str}' ({} results):",
        results.len()
    );
    if let Some(log) = logger {
        let _ = log.print_and_log("search", &msg);
    } else {
        println!("{msg}");
    }

    for (idx, result) in results.iter().enumerate() {
        let heading_info = result
            .heading_path
            .as_ref()
            .map(|h| format!(" [{h}]"))
            .unwrap_or_default();
        let msg = format!(
            "{}. {} ({}){}\n   {}",
            idx + 1,
            result.note_title,
            result.note_path,
            heading_info,
            result
                .chunk_text
                .lines()
                .next()
                .unwrap_or("")
                .chars()
                .take(80)
                .collect::<String>()
        );
        if let Some(log) = logger {
            let _ = log.print_and_log("search", &msg);
        } else {
            println!("{msg}");
        }
    }

    Ok(())
}

/// Get all notes that link to a specific note (backlinks)
pub fn get_backlinks(config: &Config, note: &str, logger: Option<&Logger>) -> Result<()> {
    let db_path = config.database_path();

    if !db_path.exists() {
        anyhow::bail!(
            "Database not found at: {}\nRun 'obsidian-cli init' first",
            db_path.display()
        );
    }

    let db = Database::open(&db_path)
        .with_context(|| format!("Failed to open database: {}", db_path.display()))?;

    let backlinks = db
        .conn()
        .execute_query(|conn| query::get_backlinks(conn, note))
        .context("Failed to get backlinks")?;

    if backlinks.is_empty() {
        let msg = format!("No backlinks found for: {note}");
        if let Some(log) = logger {
            let _ = log.print_and_log("backlinks", &msg);
        } else {
            println!("{msg}");
        }
        return Ok(());
    }

    let msg = format!("Backlinks to '{}' ({} found):", note, backlinks.len());
    if let Some(log) = logger {
        let _ = log.print_and_log("backlinks", &msg);
    } else {
        println!("{msg}");
    }

    for (idx, link) in backlinks.iter().enumerate() {
        let link_type = if link.is_embed { "embed" } else { "link" };
        let msg = format!(
            "{}. {} ({})\n   Type: {} {}",
            idx + 1,
            link.note_title,
            link.note_path,
            link_type,
            link.alias
                .as_ref()
                .map(|a| format!("(alias: {a})"))
                .unwrap_or_default()
        );
        if let Some(log) = logger {
            let _ = log.print_and_log("backlinks", &msg);
        } else {
            println!("{msg}");
        }
    }

    Ok(())
}

/// Get all notes that a specific note links to (forward links)
pub fn get_forward_links(config: &Config, note: &str, logger: Option<&Logger>) -> Result<()> {
    let db_path = config.database_path();

    if !db_path.exists() {
        anyhow::bail!(
            "Database not found at: {}\nRun 'obsidian-cli init' first",
            db_path.display()
        );
    }

    let db = Database::open(&db_path)
        .with_context(|| format!("Failed to open database: {}", db_path.display()))?;

    let forward_links = db
        .conn()
        .execute_query(|conn| query::get_forward_links(conn, note))
        .context("Failed to get forward links")?;

    if forward_links.is_empty() {
        let msg = format!("No forward links found for: {note}");
        if let Some(log) = logger {
            let _ = log.print_and_log("links", &msg);
        } else {
            println!("{msg}");
        }
        return Ok(());
    }

    let msg = format!(
        "Forward links from '{}' ({} found):",
        note,
        forward_links.len()
    );
    if let Some(log) = logger {
        let _ = log.print_and_log("links", &msg);
    } else {
        println!("{msg}");
    }

    for (idx, link) in forward_links.iter().enumerate() {
        let status = if link.note_id < 0 {
            "[unresolved]"
        } else {
            "[resolved]"
        };
        let msg = format!(
            "{}. {} ({})\n   {}",
            idx + 1,
            link.note_title,
            link.note_path,
            status
        );
        if let Some(log) = logger {
            let _ = log.print_and_log("links", &msg);
        } else {
            println!("{msg}");
        }
    }

    Ok(())
}

/// List all unresolved links in the vault
pub fn list_unresolved_links(config: &Config, logger: Option<&Logger>) -> Result<()> {
    let db_path = config.database_path();

    if !db_path.exists() {
        anyhow::bail!(
            "Database not found at: {}\nRun 'obsidian-cli init' first",
            db_path.display()
        );
    }

    let db = Database::open(&db_path)
        .with_context(|| format!("Failed to open database: {}", db_path.display()))?;

    let unresolved = db
        .conn()
        .execute_query(query::get_unresolved_links)
        .context("Failed to get unresolved links")?;

    if unresolved.is_empty() {
        let msg = "No unresolved links found!";
        if let Some(log) = logger {
            let _ = log.print_and_log("unresolved-links", msg);
        } else {
            println!("{msg}");
        }
        return Ok(());
    }

    let msg = format!("Unresolved Links ({} found):", unresolved.len());
    if let Some(log) = logger {
        let _ = log.print_and_log("unresolved-links", &msg);
    } else {
        println!("{msg}");
    }

    for (idx, link) in unresolved.iter().enumerate() {
        let msg = format!(
            "{}. {}{}\n   In: {}",
            idx + 1,
            link.note_title,
            link.note_path,
            link.note_path
        );
        if let Some(log) = logger {
            let _ = log.print_and_log("unresolved-links", &msg);
        } else {
            println!("{msg}");
        }
    }

    Ok(())
}

/// List notes by tag or show all tags
pub fn list_notes_by_tag(
    config: &Config,
    tag: &Option<String>,
    all: bool,
    logger: Option<&Logger>,
) -> Result<()> {
    let db_path = config.database_path();

    if !db_path.exists() {
        anyhow::bail!(
            "Database not found at: {}\nRun 'obsidian-cli init' first",
            db_path.display()
        );
    }

    let db = Database::open(&db_path)
        .with_context(|| format!("Failed to open database: {}", db_path.display()))?;

    if all || tag.is_none() {
        // List all tags
        let all_tags = db
            .conn()
            .execute_query(query::list_tags)
            .context("Failed to list tags")?;

        if all_tags.is_empty() {
            let msg = "No tags found in vault";
            if let Some(log) = logger {
                let _ = log.print_and_log("tags", msg);
            } else {
                println!("{msg}");
            }
            return Ok(());
        }

        let msg = format!("All Tags ({} total):", all_tags.len());
        if let Some(log) = logger {
            let _ = log.print_and_log("tags", &msg);
        } else {
            println!("{msg}");
        }

        for (idx, tag_name) in all_tags.iter().enumerate() {
            let msg = format!("{}. {}", idx + 1, tag_name);
            if let Some(log) = logger {
                let _ = log.print_and_log("tags", &msg);
            } else {
                println!("{msg}");
            }
        }
    } else if let Some(tag_name) = tag {
        // List notes with specific tag
        let notes = db
            .conn()
            .execute_query(|conn| query::get_notes_by_tag(conn, tag_name))
            .context("Failed to get notes by tag")?;

        if notes.is_empty() {
            let msg = format!("No notes found with tag: {tag_name}");
            if let Some(log) = logger {
                let _ = log.print_and_log("tags", &msg);
            } else {
                println!("{msg}");
            }
            return Ok(());
        }

        let msg = format!("Notes with tag '{}' ({} found):", tag_name, notes.len());
        if let Some(log) = logger {
            let _ = log.print_and_log("tags", &msg);
        } else {
            println!("{msg}");
        }

        for (idx, note) in notes.iter().enumerate() {
            let msg = format!(
                "{}. {} ({})\n   Tags: {}",
                idx + 1,
                note.note_title,
                note.note_path,
                note.tags.join(", ")
            );
            if let Some(log) = logger {
                let _ = log.print_and_log("tags", &msg);
            } else {
                println!("{msg}");
            }
        }
    }

    Ok(())
}

/// Show placeholder for unimplemented commands
pub fn show_unimplemented(command: &str, logger: Option<&Logger>) {
    let msg = format!("{command}() command not yet implemented");
    if let Some(log) = logger {
        let _ = log.print_and_log(command, &msg);
    } else {
        println!("{msg}");
    }
}

pub fn show_search(query: &str, limit: usize, logger: Option<&Logger>) {
    if let Some(log) = logger {
        let _ = log.print_and_log("search", "Search command not yet implemented");
        let _ = log.print_and_log("search", &format!("  query: {query}"));
        let _ = log.print_and_log("search", &format!("  limit: {limit}"));
    } else {
        println!("Search command not yet implemented");
        println!("  query: {query}");
        println!("  limit: {limit}");
    }
}

pub fn show_backlinks(note: &str, logger: Option<&Logger>) {
    if let Some(log) = logger {
        let _ = log.print_and_log("backlinks", "Backlinks command not yet implemented");
        let _ = log.print_and_log("backlinks", &format!("  note: {note}"));
    } else {
        println!("Backlinks command not yet implemented");
        println!("  note: {note}");
    }
}

pub fn show_links(note: &str, logger: Option<&Logger>) {
    if let Some(log) = logger {
        let _ = log.print_and_log("links", "Links command not yet implemented");
        let _ = log.print_and_log("links", &format!("  note: {note}"));
    } else {
        println!("Links command not yet implemented");
        println!("  note: {note}");
    }
}

pub fn show_tags(tag: &Option<String>, all: bool, logger: Option<&Logger>) {
    if let Some(log) = logger {
        let _ = log.print_and_log("tags", "Tags command not yet implemented");
        let _ = log.print_and_log("tags", &format!("  tag: {tag:?}"));
        let _ = log.print_and_log("tags", &format!("  all: {all}"));
    } else {
        println!("Tags command not yet implemented");
        println!("  tag: {tag:?}");
        println!("  all: {all}");
    }
}

pub fn show_suggest(note: &str, limit: usize, logger: Option<&Logger>) {
    if let Some(log) = logger {
        let _ = log.print_and_log("suggest", "Suggest command not yet implemented");
        let _ = log.print_and_log("suggest", &format!("  note: {note}"));
        let _ = log.print_and_log("suggest", &format!("  limit: {limit}"));
    } else {
        println!("Suggest command not yet implemented");
        println!("  note: {note}");
        println!("  limit: {limit}");
    }
}

pub fn show_bloat(threshold: usize, limit: usize, logger: Option<&Logger>) {
    if let Some(log) = logger {
        let _ = log.print_and_log("bloat", "Bloat command not yet implemented");
        let _ = log.print_and_log("bloat", &format!("  threshold: {threshold}"));
        let _ = log.print_and_log("bloat", &format!("  limit: {limit}"));
    } else {
        println!("Bloat command not yet implemented");
        println!("  threshold: {threshold}");
        println!("  limit: {limit}");
    }
}

pub fn show_tui(logger: Option<&Logger>) {
    if let Some(log) = logger {
        let _ = log.print_and_log("tui", "TUI not yet implemented");
    } else {
        println!("TUI not yet implemented");
    }
}

pub fn show_graph(note: &Option<String>, depth: usize, logger: Option<&Logger>) {
    if let Some(log) = logger {
        let _ = log.print_and_log("graph", "Graph command not yet implemented");
        let _ = log.print_and_log("graph", &format!("  note: {note:?}"));
        let _ = log.print_and_log("graph", &format!("  depth: {depth}"));
    } else {
        println!("Graph command not yet implemented");
        println!("  note: {note:?}");
        println!("  depth: {depth}");
    }
}

/// Describe file metadata (without displaying paragraphs)
pub fn get_note_describe(config: &Config, filename: &str, logger: Option<&Logger>) -> Result<()> {
    let db_path = config.database_path();

    if !db_path.exists() {
        anyhow::bail!(
            "Database not found at: {}\nRun 'obsidian-cli init' first",
            db_path.display()
        );
    }

    let db = Database::open(&db_path)
        .with_context(|| format!("Failed to open database: {}", db_path.display()))?;

    let note = db
        .conn()
        .execute_query(|conn| query::get_note_by_filename(conn, filename))
        .context("Failed to get note metadata")?;

    match note {
        Some(note) => {
            // Format timestamps
            let mtime = chrono::DateTime::from_timestamp(note.mtime, 0)
                .map(|dt| dt.format("%Y-%m-%d %H:%M:%S").to_string())
                .unwrap_or_else(|| note.mtime.to_string());

            println!("File Metadata:");
            println!("=============");
            println!("ID:          {}", note.id);
            println!("Title:       {}", note.title);
            println!("Path:        {}", note.path);
            println!("Modified:    {mtime}");
            println!("Hash:        {}", note.hash);
            println!("Created:     {}", note.created_at);
            println!("Updated:     {}", note.updated_at);

            if let Some(frontmatter) = note.frontmatter {
                if !frontmatter.is_empty() {
                    println!("Frontmatter: {frontmatter}");
                }
            }

            Ok(())
        }
        None => {
            let msg = format!("Note not found: {filename}");
            if let Some(log) = logger {
                let _ = log.print_and_log("describe", &msg);
            } else {
                println!("{msg}");
            }
            Ok(())
        }
    }
}

/// Diagnose orphan notes (no incoming AND no outgoing links)
pub fn diagnose_orphans(
    config: &Config,
    exclude_templates: bool,
    exclude_daily: bool,
    logger: Option<&Logger>,
) -> Result<()> {
    let db_path = config.database_path();

    if !db_path.exists() {
        anyhow::bail!(
            "Database not found at: {}\nRun 'obsidian-cli init' first",
            db_path.display()
        );
    }

    let db = Database::open(&db_path)
        .with_context(|| format!("Failed to open database: {}", db_path.display()))?;

    let orphans = db
        .conn()
        .execute_query(|conn| query::get_orphans(conn, exclude_templates, exclude_daily))
        .context("Failed to get orphans")?;

    let dead_ends = db
        .conn()
        .execute_query(|conn| query::get_dead_ends(conn, exclude_templates, exclude_daily))
        .context("Failed to get dead ends")?;

    // Print orphans
    println!("=== ORPHANS (no incoming + no outgoing links) ===");
    if orphans.is_empty() {
        println!("No orphan notes found.");
    } else {
        println!("Found {} orphan note(s):\n", orphans.len());
        for (idx, note) in orphans.iter().enumerate() {
            println!(
                "{}. {} ({})\n   In: {}",
                idx + 1,
                note.note_title,
                note.note_path,
                note.note_path
            );
        }
    }

    // Print dead ends
    println!("\n=== DEAD ENDS (has incoming but no outgoing links) ===");
    if dead_ends.is_empty() {
        println!("No dead-end notes found.");
    } else {
        println!("Found {} dead-end note(s):\n", dead_ends.len());
        for (idx, note) in dead_ends.iter().enumerate() {
            println!(
                "{}. {} ({})\n   In: {}",
                idx + 1,
                note.note_title,
                note.note_path,
                note.note_path
            );
        }
    }

    if let Some(log) = logger {
        let _ = log.print_and_log(
            "diagnose-orphans",
            &format!(
                "Found {} orphans, {} dead-ends",
                orphans.len(),
                dead_ends.len()
            ),
        );
    }

    Ok(())
}

/// Diagnose broken links (unresolved and ambiguous)
pub fn diagnose_broken_links_cmd(config: &Config, logger: Option<&Logger>) -> Result<()> {
    let db_path = config.database_path();

    if !db_path.exists() {
        anyhow::bail!(
            "Database not found at: {}\nRun 'obsidian-cli init' first",
            db_path.display()
        );
    }

    let db = Database::open(&db_path)
        .with_context(|| format!("Failed to open database: {}", db_path.display()))?;

    let broken_links = db
        .conn()
        .execute_query(query::diagnose_broken_links)
        .context("Failed to diagnose broken links")?;

    if broken_links.is_empty() {
        println!("=== BROKEN LINKS ===");
        println!("No broken links found! All links are valid.");
    } else {
        // Separate unresolved and ambiguous
        let unresolved: Vec<_> = broken_links
            .iter()
            .filter(|l| l.status == "unresolved")
            .collect();
        let ambiguous: Vec<_> = broken_links
            .iter()
            .filter(|l| l.status == "ambiguous")
            .collect();

        println!("=== BROKEN LINKS ===");
        println!("Found {} broken link(s):\n", broken_links.len());

        if !unresolved.is_empty() {
            println!("--- UNRESOLVED ({}) ---", unresolved.len());
            for (idx, link) in unresolved.iter().enumerate() {
                println!(
                    "{}. [[{}]] → {} (in {})",
                    idx + 1,
                    link.target,
                    link.raw_link,
                    link.src_path
                );
            }
            println!();
        }

        if !ambiguous.is_empty() {
            println!("--- AMBIGUOUS ({}) ---", ambiguous.len());
            for (idx, link) in ambiguous.iter().enumerate() {
                println!("{}. [[{}]] (in {})", idx + 1, link.target, link.src_path);
                println!("   Candidates: {}", link.candidates.join(", "));
            }
        }
    }

    if let Some(log) = logger {
        let _ = log.print_and_log(
            "diagnose-broken-links",
            &format!("Found {} broken links", broken_links.len()),
        );
    }

    Ok(())
}