Skip to content

docs(obsidian-cli): sync with current CLI behavior#78

Open
half-adder wants to merge 1 commit into
kepano:mainfrom
half-adder:docs/obsidian-cli-sync
Open

docs(obsidian-cli): sync with current CLI behavior#78
half-adder wants to merge 1 commit into
kepano:mainfrom
half-adder:docs/obsidian-cli-sync

Conversation

@half-adder

Copy link
Copy Markdown

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):

  • silent flag no longer exists in the CLI. Replaced silent overwrite example with open overwrite (the explicit opt-in flag). The trailing note is reworded to reflect that silent is now the default.
  • File targeting: the previous wording ("Without either, the active file is used") was only true for content commands. List/aggregation commands (aliases, properties, tags, tasks) default to vault-wide and require the active flag to scope to the active file. Verified:
    • obsidian properties (no args) → vault-wide property list
    • obsidian properties active → active note's frontmatter
    • obsidian tags / tags active → same pattern
    • obsidian read / outline (no args) → active file content (content default)
  • active flag is now documented.

New command examples in Common patterns:

  • rename — rename a file
  • move — move/relocate a file
  • search:context — search with surrounding context
  • daily:path — get expected daily note path
  • create ... open — create and open in one step

obsidian move quirk 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/" → error
  • to="folder" → error
  • to="folder/file.md" → success

The command's --help says to=<path> with the description "Destination folder or path (required)", but in practice only a full file path works.

Documentation tip:

  • Added a note about obsidian help <command> (or <command> --help) for per-command detail.

Test plan

  • Verified silent flag is absent from current CLI help (obsidian create --help)
  • Verified open flag exists on create and works as opt-in
  • Verified content commands (read, outline) default to active file
  • Verified list commands (aliases, properties, tags, tasks) default to vault-wide
  • Verified active flag scopes list commands to active file
  • Verified obsidian move folder-target failure and filename workaround

- 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant