Skip to content

docs: support headless setup without Obsidian installed#96

Merged
Yakitrak merged 1 commit into
Yakitrak:mainfrom
aeramu:feat/headless-setup
Mar 1, 2026
Merged

docs: support headless setup without Obsidian installed#96
Yakitrak merged 1 commit into
Yakitrak:mainfrom
aeramu:feat/headless-setup

Conversation

@aeramu

@aeramu aeramu commented Feb 27, 2026

Copy link
Copy Markdown
Contributor

I run OpenClaw (a personal AI assistant) on a headless Raspberry Pi. I wanted to use notesmd-cli to 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.json which 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.

@Yakitrak Yakitrak left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR - great idea to add this!

@Yakitrak Yakitrak merged commit dfbc393 into Yakitrak:main Mar 1, 2026
@TriplEight

Copy link
Copy Markdown
Contributor

@Yakitrak @aeramu instead of readme - installation and CLI could check if config exists and path is correct.

@TriplEight

Copy link
Copy Markdown
Contributor

but it's addressed in #93

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.

3 participants