”list-vaults“ means “lists all registered Obsidian vaults”, but no command show how resgister vault

[pengkchang]

Describe the bug

”list-vaults“ means “lists all registered Obsidian vaults”, but no command show how resgister vault.

i list all the commands availuable below

notesmd-cli --help
Interact with Obsidian vaults from the terminal

Usage:
notesmd-cli [command]

Available Commands:
completion Generate the autocompletion script for the specified shell
create Creates note in vault
daily Creates or opens daily note in vault
delete Delete note in vault
frontmatter View or modify note frontmatter
help Help about any command
list List files and folders in vault
list-vaults lists all registered Obsidian vaults
move Move or rename note in vault and updated corresponding links
open Opens note in vault by note name
print Print contents of note
print-default prints default vault name and path
search Fuzzy searches and opens note in vault
search-content Search note content for search term
set-default Sets default vault and/or open type

Flags:
-h, --help help for notesmd-cli
-v, --version version for notesmd-cli

Use "notesmd-cli [command] --help" for more information about a command.

To Reproduce
notesmd-cli --help

Expected behaviour
"Available Commands" should include "vault-add" or similar one

[Yakitrak]

Thanks for the feedback. In hindsight this is a great idea, the real reason it for not existing is because the initial versions of this CLI were not headless and did require Obsidian to be installed/opened. We do have a section to set up the config without Obsidian installed but it might be worth automating. I'll only add it if its a good solution, otherwise I think its okay to just open Obsidian which will handle this for you.

[TheFacc]

I agree this is worth considering! Especially for a true 'headless' use case.

I just finished setting up a custom Obsidian headless server on a low-end hardware, avoiding running the full Electron app - so, Obsidian is not installed at all. The service uses your repo to interact with notes, for example, creating/editing daily notes from templates. (I use Templater plugin, its code is not resolved at creation, but it is resolved only at the first opening from the actual Obsidian app on another device, which is good enough for my use case).

The service runs as a custom user with restricted permissions, which does not have a proper $HOME directory. I was able to manually create the .config/obsidian/obsidian.json in a mock location to make the tool work, but the ability to provide a custom config folder at runtime would be ideal.

OT - while I'm at it... is it correct that the daily command does not work with --content/--append? Why so? It would be nice to programmatically add content to the daily note, without specifying the full note path with create :)

Thanks for the great project!

[Yakitrak]

That makes sense, and I will work on it when I get time in the future. If anyone else wants to please feel free to make a PR!

I think it would probably still require the .config/obsidian/obsidian.json as the goal is to use what Obsidian is declaring but maybe if it doesn't exist, the CLI can make a minimal one. I would need to play around with it to know whats best.

In terms of daily command, yes that was a limitation since originally this CLI required Obsidian to create/open daily note and it did not have a way to do content. However thats changed now, as this CLI just creates it using file system operations. I will add that to the list of things to do too!