{"id":44862654,"url":"https://github.com/jingyi-zhao-01/obsidian-cli-inspector","last_synced_at":"2026-03-06T09:06:47.066Z","repository":{"id":336770533,"uuid":"1150303255","full_name":"jingyi-zhao-01/obsidian-cli-inspector","owner":"jingyi-zhao-01","description":"headless high performance query engine on markdown files  that can integrate into various workflows","archived":false,"fork":false,"pushed_at":"2026-02-28T10:25:08.000Z","size":244,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-02-28T12:21:25.159Z","etag":null,"topics":["acp","agent","ai","cli","obsidian","query-engine","rust","tui"],"latest_commit_sha":null,"homepage":"https://crates.io/crates/obsidian-cli-inspector","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jingyi-zhao-01.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-02-05T05:45:46.000Z","updated_at":"2026-02-28T09:35:56.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/jingyi-zhao-01/obsidian-cli-inspector","commit_stats":null,"previous_names":["jingyi-zhao-01/obsidian-cli","jingyi-zhao-01/obsidian-cli-inspector","casper-04/obsidian-cli-inspector"],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/jingyi-zhao-01/obsidian-cli-inspector","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jingyi-zhao-01%2Fobsidian-cli-inspector","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jingyi-zhao-01%2Fobsidian-cli-inspector/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jingyi-zhao-01%2Fobsidian-cli-inspector/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jingyi-zhao-01%2Fobsidian-cli-inspector/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jingyi-zhao-01","download_url":"https://codeload.github.com/jingyi-zhao-01/obsidian-cli-inspector/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jingyi-zhao-01%2Fobsidian-cli-inspector/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30168627,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-06T07:56:45.623Z","status":"ssl_error","status_checked_at":"2026-03-06T07:55:55.621Z","response_time":250,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["acp","agent","ai","cli","obsidian","query-engine","rust","tui"],"created_at":"2026-02-17T10:40:36.717Z","updated_at":"2026-03-06T09:06:47.049Z","avatar_url":"https://github.com/jingyi-zhao-01.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Obsidian CLI Inspector\n\n\n- Note: THIS Feature currently is in alpha\n\n\n[![GitHub](https://img.shields.io/badge/GitHub-obsidian--cli-black?logo=github)](https://github.com/jingyi-zhao-01/obsidian-cli)\n[![Crates.io](https://img.shields.io/crates/v/obsidian-cli-inspector.svg)](https://crates.io/crates/obsidian-cli-inspector)\n[![AUR version](https://img.shields.io/aur/version/obsidian-cli-inspector?logo=arch-linux)](https://aur.archlinux.org/packages/obsidian-cli-inspector)\n[![AUR maintainer](https://img.shields.io/aur/maintainer/obsidian-cli-inspector?logo=arch-linux)](https://aur.archlinux.org/packages/obsidian-cli-inspector)\n[![codecov](https://codecov.io/gh/jingyi-zhao-01/obsidian-cli-inspector/branch/master/graph/badge.svg?token=4C0B7CEC8C)](https://codecov.io/gh/jingyi-zhao-01/obsidian-cli-inspector)\n\n\nA local-first, read-only CLI/TUI for inspecting and querying Obsidian vaults. It helps developers quickly find notes, links, and tags without leaving the terminal.\n\n## What you can do\n\n- Search your vault with fast full‑text queries\n- Navigate backlinks, forward links, and unresolved links\n- Filter notes by tags (AND/OR)\n- Explore note relationships via graph view\n- Get suggestions for related notes\n- Surface large/bloated notes for cleanup\n- Use CLI for scripting or TUI for interactive browsing\n\n## Install\n\n### From crates.io\n\n```bash\ncargo install obsidian-cli-inspector\n```\n\n### From source\n\n```bash\ngit clone https://github.com/jingyi-zhao-01/obsidian-cli.git\ncd obsidian-cli\ncargo build --release\n```\n\nThe binary will be at `target/release/obsidian-cli-inspector`.\n\n## Quick start\n\n1) Create a config file and set your vault path:\n\n```bash\nmkdir -p ~/.config/obsidian-cli\ncp config.toml.example ~/.config/obsidian-cli/config.toml\n```\n\n```toml\nvault_path = \"/path/to/your/obsidian/vault\"\n```\n\n2) Initialize and index your vault:\n\n```bash\nobsidian-cli-inspector init init\nobsidian-cli-inspector index index\n```\n\n3) Explore your notes:\n\n```bash\nobsidian-cli-inspector query search \"your query\"\nobsidian-cli-inspector query backlinks \"Note Name\"\nobsidian-cli-inspector query tags productivity\nobsidian-cli-inspector view stats\n```\n\nIf search returns no results, run indexing again:\n\n```bash\nobsidian-cli-inspector index index --force\n```\n\nUse plain search text as the final argument. Example:\n\n```bash\nobsidian-cli-inspector query search \"Notes\"\n```\n\n## Common commands\n\n```bash\n# Init \u0026 Index\nobsidian-cli-inspector init init [--force]\nobsidian-cli-inspector index index [--dry-run] [--force] [--verbose]\n\n# Query\nobsidian-cli-inspector query search \"query\" [--limit 20]\nobsidian-cli-inspector query backlinks \"Note Name\"\nobsidian-cli-inspector query links \"Note Name\"\nobsidian-cli-inspector query unresolved\nobsidian-cli-inspector query tags [tag-name] [--list]\n\n# Analyze\nobsidian-cli-inspector analyze related \"Note Name\" [--limit 10]\nobsidian-cli-inspector analyze bloat [--threshold 50000] [--limit 10]\n\n# View\nobsidian-cli-inspector view stats\nobsidian-cli-inspector view describe \"Note Name\"\n\n# Diagnose\nobsidian-cli-inspector diagnose orphans [--exclude-templates] [--exclude-daily]\nobsidian-cli-inspector diagnose broken-links\n\n# Interactive\nobsidian-cli-inspector tui\n```\n\n## CLI Contract\n\nThe CLI follows a structured command pattern. See [docs/cli-contract.md](docs/cli-contract.md) for the full CLI contract, including the new group-based command structure and migration guide.\n\n## Machine Contracts (v1.1.0+)\n\nFor agent integration, use JSON output with deterministic contracts. See [docs/machine-contract.md](docs/machine-contract.md) for full documentation.\n\n\u003e **Testing note:** end-to-end contract tests are under `tests/e2e` and are skipped by default during regular `make test` runs. To run them, use:\n\u003e\n\u003e ```bash\n\u003e make -C tests/e2e contracts\n\u003e ```\n\u003e\n\u003e This command automatically prepares test data before running the suite.\n\n## Configuration\n\nThe minimum required setting is `vault_path`. Optional settings include database location, exclusions, and defaults. See [config.toml.example](config.toml.example) for a complete list.\n\n## Status\n\nThe core indexing, parsing, chunking, and query features are in place. Advanced recommendations and hygiene features are evolving. See [docs/TODOs.md](docs/TODOs.md) for a user‑focused roadmap.\n\n## License\n\nApache-2.0\n\n## Contributing\n\nContributions are welcome. Please open an issue to discuss larger changes.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjingyi-zhao-01%2Fobsidian-cli-inspector","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjingyi-zhao-01%2Fobsidian-cli-inspector","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjingyi-zhao-01%2Fobsidian-cli-inspector/lists"}