docs(obsidian-cli): sync with current CLI behavior#78
Open
half-adder wants to merge 1 commit into
Open
Conversation
- Replace removed `silent` flag with `open` in create example - Clarify File targeting: content commands default to active; list/aggregation commands (aliases, properties, tags, tasks) default to vault-wide and require `active` flag to scope to active - Document `active` flag - Add command examples: rename, move, search:context, daily:path - Note `obsidian move` quirk: `to=` requires filename, not just folder - Add tip about `obsidian help <command>` for per-command help - Reword silent-default note to match new CLI default Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
sigrunixia
added a commit
to sigrunixia/obsidian-skills
that referenced
this pull request
May 23, 2026
sigrunixia
added a commit
to sigrunixia/obsidian-skills
that referenced
this pull request
May 23, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The obsidian-cli SKILL.md had drifted from the CLI's current behavior. This PR updates the documentation to match what the CLI actually does (verified empirically on the current release) and adds commonly-used command examples.
Changes
Behavior corrections (each verified by running the command):
silentflag no longer exists in the CLI. Replacedsilent overwriteexample withopen overwrite(the explicit opt-in flag). The trailing note is reworded to reflect that silent is now the default.aliases,properties,tags,tasks) default to vault-wide and require theactiveflag to scope to the active file. Verified:obsidian properties(no args) → vault-wide property listobsidian properties active→ active note's frontmatterobsidian tags/tags active→ same patternobsidian read/outline(no args) → active file content (content default)activeflag is now documented.New command examples in Common patterns:
rename— rename a filemove— move/relocate a filesearch:context— search with surrounding contextdaily:path— get expected daily note pathcreate ... open— create and open in one stepobsidian movequirk documented:to=must be a full destination path including the filename. Passing a folder (with or without trailing slash) fails with "Destination file already exists." Verified:to="folder/"→ errorto="folder"→ errorto="folder/file.md"→ successThe command's
--helpsaysto=<path>with the description "Destination folder or path (required)", but in practice only a full file path works.Documentation tip:
obsidian help <command>(or<command> --help) for per-command detail.Test plan
silentflag is absent from current CLI help (obsidian create --help)openflag exists oncreateand works as opt-inread,outline) default to active filealiases,properties,tags,tasks) default to vault-wideactiveflag scopes list commands to active fileobsidian movefolder-target failure and filename workaround