Obsidian Stats logoObsidian Stats

Book Metasearch

by bongho
5
4
3
2
1
Score: 40/100
Install Code

Description

Book note maker with metasearch across Aladin, Kakao, Google Books, and Open Library. Successor to anpigon/obsidian-book-search-plugin (Naver EOL 2026-08-01).

Reviews

No reviews yet.

Stats

4
stars
347
downloads
0
forks
43
days
0
days
17
days
34
total PRs
3
open PRs
6
closed PRs
25
merged PRs
3
total issues
2
open issues
1
closed issues
55
commits

Latest Version

v1.2.5
18 days ago

Changelog

🎉 New Features

Auto-Generate Review Notes for Reading Progress

Automatically create Review notes when marking books as 'reading' or 'read'. This feature helps organize your book reviews and reading progress in a structured way.

What's New:

  • 📝 Review notes are auto-created in a dedicated Reviews/ folder
  • 🔗 Backlinks to original book notes for easy navigation
  • ⚙️ Reading status unification with READING_STATUS constants
  • ✅ Idempotent creation prevents duplicates
  • 🚫 Wishlist status doesn't create reviews (as intended)

📋 Implementation Details

Status Constants

Introduced READING_STATUS constant object for centralized vocabulary:

export const READING_STATUS = {
  WISHLIST: 'wishlist',
  READING: 'reading',
  READ: 'read',
} as const;

Review Note Creation Logic

  • shouldCreateReviewNote(): Gate function returning true only for reading/read
  • createReviewNote(): Creates minimal Review note with backlink
  • setStatus(): Conditionally triggers Review creation
  • Idempotency: Prevents duplicate notes via basename check

Updated Components

  • Command palette: All 3 status commands now use READING_STATUS constants
  • Tests: 58/58 passing with new shouldCreateReviewNote scenarios
  • Build: ✅ TypeScript type-check passed, ESBuild successful

🧪 Testing

CI Status

  • ✅ Node.js 20.x: PASS
  • ✅ Node.js 22.x: PASS
  • ✅ Node.js 24.x: PASS

Test Coverage

  • Test Files: 7/7 passed
  • Tests: 58/58 passed
  • Success Rate: 100%

📝 Breaking Changes

None. Fully backward compatible.

🔄 Migration Notes

No migration needed. Existing books work unchanged. Review notes only created when you explicitly mark books as reading/read.

Release Date: 2026-08-29 Author: Claude Code Agent Related PR: #29

See all version on GitHub

README file from

Github

Book Metasearch

Book note maker with metasearch across Aladin · Kakao · Google Books · Open Library, queried in parallel. Korean-first with foreign fallback.

Successor to anpigon/obsidian-book-search-plugin (unmaintained). Built to solve the Naver Book Search API EOL (2026-08-01) and provide a proper Korean-first book note workflow.

Install

From the community plugin directory:

  1. In Obsidian, open Settings → Community plugins
  2. Turn off Restricted mode if enabled
  3. Click Browse and search for Book Metasearch
  4. Click Install, then Enable

Features

Core (v1.0)

  • 4-provider metasearch: Aladin (Korean primary) · Kakao (Korean recall) · Google Books (foreign primary) · Open Library (foreign covers/ISBN)
  • Two strategies: Sequential fallback (default) or parallel Fanout with ISBN13 dedupe
  • Commands: Search books · Search by ISBN · Search based on current note · Update book info · Migration helper
  • Template file support with {{variable}} substitution — Templater <% %> blocks are preserved for post-creation execution
  • Frontmatter customization: useDefaultFrontmatter toggle · key case (as-is / camelCase / snake_case / kebab-case) · additional YAML fragment with {{variable}} substitution
  • Cover image download to a configurable folder
  • 37 ISO 639-1 locale codes for cross-provider language filtering
  • API keys masked in settings with click-to-reveal
  • Cover thumbnails in search results (opt-in)
  • Naver EOL migration: opt-in helper detects an existing obsidian-book-search-plugin config and guides users through Aladin setup

v1.1 additions

  • Auto-filled Abstract / Description section — new notes get the provider's book description written into the ## Abstract / Description block (HTML stripped). "Update book info in current note" refreshes it while preserving edits outside the auto-block markers.
  • ISBN13 vault-wide duplicate detection — before creating a note, the plugin scans the vault. On match, DuplicateModal offers: open existing / update existing / create anyway / cancel. Backed by an incremental VaultBookIndex.
  • Reading Log — three commands ("Mark book as wishlist / reading / read") with automatic startedAt / finishedAt date stamping (idempotent). New notes get a configurable initial status (default: wishlist).
  • Insert book citation at cursor — editor command that emits a wikilink to an existing vault note (if any) or an unresolved link. Two link styles.
  • Aladin used-book price check (opt-in) — surfaces used-book minimum prices as a Notice or appended ## Price Watch section.
  • Redacted error diagnostics — healthcheck / migration failures auto-write a diagnostics note with secrets masked, so users can attach it to bug reports.

See CHANGELOG.md for the full v1.1.0 changelog.

Provider setup

Only Aladin and Kakao require API keys (both free, instant issuance). Google Books works without a key at a lower rate limit. Open Library needs no auth.

Provider Auth Free tier Where to get a key
Aladin TTB Key (required) 5,000/day aladin.co.kr/ttb
Kakao REST API Key (required) 30,000/day developers.kakao.com
Google Books API Key (optional) 1,000/day with key, low limit without Google Cloud Console — enable Books API first
Open Library No auth Effectively unlimited —

After installing, open Settings → Book Metasearch → Providers, paste keys, and hit Healthcheck on each provider.

Attribution

The Aladin OpenAPI general-tier terms don't strictly mandate a credit link, but keeping the "Book DB by Aladin" footer in generated notes is the polite (and forward-compatible if you ever upgrade to the premium tier). Leave the credit toggle on unless you have a specific reason.

Development

Prerequisites: Node 22.12+, npm.

git clone https://github.com/bongho/obsidian-book-metasearch.git
cd obsidian-book-metasearch
npm install

# dev — build directly into your vault's plugin folder
export VAULT_PLUGIN_DIR="/path/to/your/vault/.obsidian/plugins/book-metasearch"
mkdir -p "$VAULT_PLUGIN_DIR"
cp manifest.json styles.css "$VAULT_PLUGIN_DIR/"
OUTDIR="$VAULT_PLUGIN_DIR" npm run dev

# production build
npm run build

For hot-reload, install pjeby/hot-reload via BRAT and create an empty .hotreload file in the plugin folder.

License

MIT © 2026 BongHo Lee

Sponsors