Skip to main content
skill CX Codex

wiki-cli — Claude Code skill: what it does, how to install

wiki-cli is a Claude Code skill that checks whether the official Obsidian CLI can read a vault, then searches notes; if unavailable, it reads files directly.

MIT 341 installs ★ 16,676 updated 2026-10-22

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add AgriciDaniel/claude-obsidian --skill wiki-cli -a claude-code
Open on GitHub

What wiki-cli does

wiki-cli decides how an agent should read an Obsidian vault and then reads or searches it. It runs scripts/detect-transport.sh --peek --vault and checks available.cli.usable. A found obsidian binary proves little: the CLI fails when the Obsidian app is closed or command-line access is switched off.

With a ready CLI, commands run from inside the vault folder, such as obsidian read path=... and obsidian search query=.... Backlinks, tags and Bases results have read-only commands too. If the CLI is not ready, the agent opens files directly and searches with rg. Absolute note paths, .. traversal and symlinks leading outside the vault are rejected.

The skill never writes. Creating, editing, moving or deleting notes through the CLI is off the table, and so are direct file writes; every change goes through a reviewed transaction in the claude-obsidian core. The detector script is looked up in the installed claude-obsidian directory, so that product has to be installed first. .vault-meta/transport.json is rewritten with --force only on request.

What it helps with

  • check whether the Obsidian CLI responds before the first command
  • read a note by its path inside the vault
  • search notes with obsidian search
  • pull backlinks and tags once the CLI is ready
  • search the vault with rg when the CLI is unavailable

Example prompts for the agent

  • Use wiki-cli to check whether the Obsidian CLI works for my vault
  • Search my Obsidian vault for notes about OAuth with wiki-cli
  • Read this note and list its backlinks through the Obsidian CLI

How to install wiki-cli

1Skills CLI (Vercel)

npx skills add AgriciDaniel/claude-obsidian --skill wiki-cli -a claude-code

2Manually: put the files in place

~/.claude/skills/wiki-cli/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/wiki-cli/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about wiki-cli

How do I install wiki-cli in Claude Code?

Run npx skills add AgriciDaniel/claude-obsidian --skill wiki-cli -a claude-code. The skill file is ~/.claude/skills/wiki-cli/SKILL.md.

What does wiki-cli do?

It detects whether the Obsidian CLI is usable and then reads or searches the chosen vault without changing it. When the CLI is not ready, it reads files directly.

Does wiki-cli work when Obsidian is not running?

The CLI needs the app running and command-line access enabled. Without that, the skill falls back to reading files and searching with rg.

Source text

SKILL.md · MIT
---
name: wiki-cli
description: "Detect and use the official Obsidian command-line interface for read-only vault access; use for wiki-cli, Obsidian CLI, Obsidian read, Obsidian search, vault transport, which transport, transport detection, backlinks, tags, or Obsidian command line. Mutations always go through the claude-obsidian transaction core."
---

# Obsidian CLI read transport

Use this skill only to detect transport and read or search a selected vault.
The official executable is `obsidian`; binary presence alone does not prove it
is usable.

Resolve the installed product root from this skill's own location, not from the
vault or current working directory:

```bash
PRODUCT_ROOT=/absolute/path/to/installed/claude-obsidian
DETECT_TRANSPORT="$PRODUCT_ROOT/scripts/detect-transport.sh"
test -f "$DETECT_TRANSPORT"
```

Every `../wiki/references/` link in this file resolves the same way, relative
to this skill's own directory under `$PRODUCT_ROOT`, never relative to the
selected vault's `wiki/` directory.

## Detect safely

Probe without persisting host state:

```bash
bash "$DETECT_TRANSPORT" --peek --vault "$VAULT"
```

Trust `available.cli.usable`, not merely `present` or exit status. A supported
CLI can still be unavailable because the Obsidian app is not running, command
line access is disabled, or its response is an error. Use filesystem reads as
the portable fallback.

Persist a refreshed `.vault-meta/transport.json` only when the user or setup
workflow asks for a transport snapshot:

```bash
bash "$DETECT_TRANSPORT" --force --vault "$VAULT"
```

That file is derived runtime configuration, not knowledge content. Preserve a
valid `manual_override` recorded by the detector.

## Read and search

Run official CLI commands from the selected vault so Obsidian resolves the
correct workspace. Confirm supported syntax with the installed CLI before
relying on optional commands. Typical read-only forms are:

```bash
(cd "$VAULT" && obsidian read path="$NOTE")
(cd "$VAULT" && obsidian search query="$QUERY")
```

Use read-only commands for backlinks, tags, or Bases results only when the
detector reports the CLI ready. Otherwise read files under `$VAULT` directly
and use `rg` for search. Reject absolute note arguments, traversal, symlinks, or
resolved paths outside the selected vault.

## Mutation boundary

Do not use CLI create, write, append, property-set, daily-append, move, rename,
or delete commands. Do not replace those commands with direct filesystem
writes. Any knowledge or configuration change must be expressed as one
reviewed transaction through the portable core; see
[operation transactions](../wiki/references/operation-transactions.md).

Transport choice never changes mutation semantics. The CLI is an optional read
surface, not a lock manager, transaction engine, or Git checkpoint mechanism.

## Checkpoint

Observe actual capability, think about the least complex read transport, verify
that every resolved path stays in the vault, and accept filesystem fallback
when the CLI is not ready.

© AgriciDaniel · MIT · AgriciDaniel/claude-obsidian

Similar skills

All skills for Notes, tasks and projects →

From the same set15

The whole set →
wiki-query wiki-query is a Claude Code skill that answers questions from a chosen Obsidian vault without changing its files. It uses the vault as the evidence source. CX Codex +1 512installs wiki-lint wiki-lint runs a deterministic read-only check on an Obsidian vault: dead links, orphan pages, frontmatter gaps. It reports, it does not repair. CX Codex +1 508installs canvas Creates and edits Obsidian boards in JSON Canvas format: text cards, files, links, groups and edges. Useful when you want a visual map of a vault. CX Codex +1 500installs defuddle Plans Defuddle extraction and retains already available local source files. No network cleaning ships with it — just the plan and the capture. CX Codex +1 478installs wiki-fold wiki-fold is a Claude Code skill that builds a rollup from entries in an Obsidian wiki/log.md. It previews the draft first and leaves child pages untouched. CX Codex +1 445installs wiki-retrieve wiki-retrieve builds a local BM25 index from wiki/ notes and finds relevant passages. Use it when an agent needs matching pages to read before answering a question. CX Codex +1 348installs wiki-mode wiki-mode configures vault filing methodologies like PARA, LYT, or Zettelkasten and suggests destinations for new Obsidian notes without writing files. CX Codex +1 344installs think Applies a ten-stage OBSERVE–LISTEN–THINK–CONNECT–FEEL–ACCEPT–CREATE–GROW cycle to complex decisions, architecture reviews, and incident postmortems. Separates facts from assumptions and surfaces hidden risks. CX Codex +1 337installs

Project sponsors

Companies that keep this analytics open