docs(cli): note that auto-launch does not apply on WSL2#1090
Open
max-nothacker wants to merge 1 commit into
Open
docs(cli): note that auto-launch does not apply on WSL2#1090max-nothacker wants to merge 1 commit into
max-nothacker wants to merge 1 commit into
Conversation
The "Get started" section claims the CLI auto-launches the GUI when Obsidian is not running. This holds on macOS (and presumably Windows and Linux with a deb/rpm/snap install) but not on WSL2, where the CLI's binary contains no GUI-discovery logic and invocation cold- prints the "unable to find Obsidian" error. Two additive edits: - A note in the Get started info-callout pointing to the new section. - A `#### WSL2` subsection under the existing `### Linux` troubleshooting block. No existing text is removed; the auto-launch claim is preserved verbatim. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com> in the session with id 47723288
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
1 participant
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.
What
Adds a WSL2-specific note to the Get started auto-launch sentence and a new
#### WSL2 (Windows Subsystem for Linux)subsection inside the existing### Linuxtroubleshooting block. No existing text is removed; the auto-launch claim is preserved verbatim and only annotated with a forward reference to the new subsection.Why
While running Obsidian on WSL2, the documented behavior
does not occur. Invoking the CLI from a terminal when the GUI is not running returns the error:
Investigation:
~/.local/bin/obsidianby the in-app "Command line interface" toggle is small (~67 KB ELF, aarch64). Runningstringson it reveals only the unix-socket-related literals (XDG_RUNTIME_DIR,%s/.obsidian-cli.sock) and the error message above — no PATH lookups for a GUI binary, no.desktopdiscovery, no AppImage scanning. The binary appears to be CLI-socket-only.wsl --shutdown,wsl --update, and a full Windows reboot did not change the behavior — it is reproducible on every cold launch.Scope
This PR only documents the WSL2 case, because that is the only environment in which the failure was reproduced. The wording is intentionally not generalized to "Linux" — desktop Linux installs via deb/rpm/snap may behave differently and were not tested.
Reproduce
--appimage-extract.obsidian.Expected per docs: GUI launches.
Actual: prints "The CLI is unable to find Obsidian. Please make sure Obsidian is running and try again." and exits.
Files changed
en/Extending Obsidian/Obsidian CLI.md— two additive edits described above.