Signin Signup

Feature Request: Official CLI Support for SiYuan

Hello SiYuan Team,

Thank you for your excellent work on SiYuan. I really appreciate the flexibility, powerful architecture, and advanced capabilities the app offers.

I would like to respectfully suggest adding an official CLI for SiYuan, or providing an officially supported command-line interface for interacting with notes, documents, and blocks.

I noticed that Obsidian recently introduced official CLI support, which reflects a growing interest in automation-friendly workflows. I believe SiYuan could offer great value by providing a similar capability in a way that fits its own ecosystem.

This would be especially useful for users who rely on automation, scripting, external integrations, and AI-based workflows. While SiYuan already provides a powerful API, an official CLI would make these workflows much more accessible and convenient.

A CLI could help users with tasks such as creating notes, searching content, updating documents, appending blocks, and integrating SiYuan into automated pipelines.

I believe this would significantly improve the developer experience and make SiYuan even more attractive to advanced users and technical communities.

Thank you for considering this request, and I look forward to seeing the future development of SiYuan.

Best regards,
Khalil

    20 Ask
    4 Reply
    2
    65 12 2 51

    Related articles

    4 Reply
    Feature Request: Official CLI Support for SiYuan

    Welcome to here!

    Here we can learn from each other how to use SiYuan, give feedback and suggestions, and build SiYuan together.

    Signup About
    Please input reply content ...
    • 88250 •
      MOD

      Since the API can be invoked directly via the command line, we do not believe there is a significant need to provide a separate command-line interface.

    • MiscReply
    • 88250 •
      MOD

      While SiYuan already provides a powerful API, an official CLI would make these workflows much more accessible and convenient.

      Could you give an example?

    • FEU •
      VIP Warrior

      +1

    • Khalil •
      Author

      Hello,

      Sure — here is an example of the kind of feature I mean:

      Obsidian recently introduced an official CLI:
      https://help.obsidian.md/cli

      I am sharing it only as a reference to illustrate the type of workflow I have in mind, not as a request to copy it exactly.

      What I mean is an officially supported command-line interface that would allow users to interact with SiYuan more easily through automation and scripting. For example, it could help with tasks such as:

      • creating notes or documents from the terminal
      • searching content quickly
      • appending or updating blocks programmatically
      • integrating SiYuan into scripts, developer workflows, or AI-based pipelines

      Since SiYuan already has a strong API foundation, I believe an official CLI or a lightweight supported wrapper around the API could make these workflows much more accessible.

      Best regards,
      Khalil

    Khalil
    Reply
    1
     Article
    1
     Point
    493

    Recent hot