docs: support headless setup without Obsidian installed#96
Merged
Conversation
Yakitrak
approved these changes
Mar 1, 2026
Yakitrak
left a comment
Owner
There was a problem hiding this comment.
Thanks for the PR - great idea to add this!
Contributor
Contributor
|
but it's addressed in #93 |
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.
I run OpenClaw (a personal AI assistant) on a headless Raspberry Pi. I wanted to use
notesmd-clito manage my Obsidian vault, but couldn't install Obsidian since the official installer requires a GUI.The CLI kept throwing errors even though the documentation says it doesn't require Obsidian to be running. After some debugging, I realized it still needs Obsidian's config file to exist.
I had to explore the source code to understand what configuration it expects, where it looks for it, and what format it needs to be in. Turns out, the CLI just needs the vault configuration in
~/.config/obsidian/obsidian.jsonwhich gets created when you first run the Obsidian app.This PR adds documentation for users in headless environments to manually create the required config and use the CLI without Obsidian installed.