mirror of https://github.com/HKUDS/CLI-Anything.git synced 2026-07-03 13:02:27 +08:00

Files

Mubashir Rahim b01e0e745c fix(obsidian): use vendor Content-Type for /search/ (DQL + JsonLogic)

Obsidian Local REST API rejects POST /search/ with `40012 Unknown or
invalid Content-Type` when the request is sent with `application/json`
and a JSON-wrapped `{"query": ...}` body. The endpoint expects:

  - `application/vnd.olrapi.dataview.dql+txt` for Dataview DQL queries
  - `application/vnd.olrapi.jsonlogic+json` for JsonLogic queries

with the query body sent verbatim, not wrapped.

Changes:
  - Add `api_post_raw(base_url, endpoint, api_key, body, content_type, …)`
    helper that mirrors `api_put`'s raw-body pattern.
  - `search_query` now takes a `query_type` arg (default `"dql"`) and
    routes through `api_post_raw` with the right vendor Content-Type.
  - `search query` CLI command gains `--type [dql|jsonlogic]`.
  - Refresh unit + CLI tests; add backend tests for `api_post_raw`.
  - Update SKILL.md (canonical + packaged), README, OBSIDIAN SOP doc.
  - Bump package + registry version 1.0.0 → 1.1.0.

Fixes #271

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>

2026-05-19 02:48:05 +05:00

3.9 KiB

Raw Permalink Blame History

Obsidian: Project-Specific Analysis & SOP

Architecture Summary

Obsidian is a knowledge management and note-taking app that stores notes as local Markdown files. The Local REST API plugin exposes vault operations via an HTTPS server on localhost:27124.

┌───────────────────────────────────────────────────┐
│              Obsidian Desktop App                  │
│  ┌───────────┐ ┌──────────┐ ┌──────────────────┐  │
│  │   Vault    │ │  Search  │ │    Commands      │  │
│  │  Manager   │ │  Engine  │ │    Registry      │  │
│  └─────┬──────┘ └────┬─────┘ └───────┬──────────┘  │
│        │             │               │              │
│  ┌─────┴─────────────┴───────────────┴───────────┐ │
│  │     Local REST API Plugin (port 27124)        │ │
│  │  /vault/     /search/     /commands/          │ │
│  │  /active/    /periodic-notes/                 │ │
│  └───────────────────┬───────────────────────────┘ │
└──────────────────────┼─────────────────────────────┘
                       │ HTTPS + Bearer Token
         ┌─────────────┴──────────────┐
         │   cli-anything-obsidian    │
         │   Click CLI + REPL         │
         └────────────────────────────┘

CLI Strategy: REST API Wrapper

Our CLI wraps the Obsidian Local REST API plugin with:

requests — HTTP client for all API calls (HTTPS, self-signed cert)
Bearer token — Authentication via API key
Click CLI — Structured command groups matching the API surface
REPL — Interactive mode for exploratory use

API Endpoints

Endpoint	Method	Purpose
`/`	GET	Server status/auth check
`/vault/`	GET	List vault files
`/vault/{path}`	GET	Read note content
`/vault/{path}`	PUT	Create/update note
`/vault/{path}`	DELETE	Delete note
`/vault/{path}`	PATCH	Append/prepend to note
`/search/`	POST	Structured search — Dataview DQL (`application/vnd.olrapi.dataview.dql+txt`) or JsonLogic (`application/vnd.olrapi.jsonlogic+json`)
`/search/simple/`	POST	Plain text search
`/active/`	GET	Get active note
`/active/`	PUT	Open a note
`/commands/`	GET	List commands
`/commands/{id}/`	POST	Execute command

Authentication

The Local REST API plugin generates an API key in its settings. Pass via --api-key flag or OBSIDIAN_API_KEY environment variable. All requests use HTTPS with a self-signed certificate (verify=False).

CLI → API Mapping

CLI Command	API Call
`vault list [path]`	`GET /vault/[path]/`
`vault read <path>`	`GET /vault/{path}`
`vault create <path>`	`PUT /vault/{path}`
`vault update <path>`	`PUT /vault/{path}`
`vault delete <path>`	`DELETE /vault/{path}`
`vault append <path>`	`PATCH /vault/{path}`
`search query <q> [--type dql\|jsonlogic]`	`POST /search/` (raw body, vendor Content-Type)
`search simple <q>`	`POST /search/simple/`
`note active`	`GET /active/`
`note open <path>`	`PUT /active/`
`command list`	`GET /commands/`
`command execute <id>`	`POST /commands/{id}/`
`server status`	`GET /`
`session status`	(local state)

3.9 KiB Raw Permalink Blame History