Skip to main content

How to use notes

Have the DSH agent organize the current conversation into Markdown and export it as a Hammer Note, saving it to the note service or generating a note long image.

This article is auto-derived from indexed fields (wiki / faq / compatibility_json), not freshly AI-generated.

This article is derived from the plugin's already-indexed fields (wiki / faq / compatibility_json / readme), not freshly generated by AI. Source field is noted at the end of each section.

Quick start

notes

— source: plugin_wiki.wiki_content

Install & verify

dsh plugin --profile web add @zhaoolee/dsh-notes

Run the command above in your DSH Web Profile. Then enable the plugin in the plugin list.

— source: plugins.install

Key points

  • 一个锤子便签风格的导出器，预览与图片导出支持暖白纸感、深夜便签、iPhone 备忘录深浅模式和 Bear 极简排版。
  • 可用来分享与openclaw的对话记录。
  • 完美复刻锤子便签网页版和PC版，支持多便签，分类存储。
  • 支持Docker一键私有化部署
  • 纯WEB应用，无需安装任何App，打开即用

— source: plugin_wiki.readme_en (fallback readme_raw)

FAQ

After installation, the agent won't automatically call it. What needs to be said?

Restart the target profile after installation to activate the plugin. The agent has registered the notes_export_conversation tool; users can trigger it by saying "export our conversation as a note" or similar phrases. The tool will automatically organize the conversation into Markdown and invoke it.

Can it be used directly without any configuration?

Yes. The plugin will automatically fall back to the default demo server notes.fangyuanxiaozhan.com, render the conversation as a锤子note long-image PNG and save it locally; this mode cannot write to the note list and is only suitable for a quick try.

How to configure to store notes on my own service?

Configure the note service address (NOTES_API_BASE_URL or plugin config.baseUrl) and provide a Token or username/password. The agent will write the conversation as a note to the current account's cloud workspace, creating new or updating by note_id.

What are the different action types returned by the tool and what do they mean?

created means a new note was written; updated means an existing note was updated by note_id; exported-image means it was rendered as a note long-image via the demo server (image mode), returning a local PNG path instead of a note link.

Where does the note title come from?

It comes from the first line of the full Markdown text; the plugin removes heading symbols, quotes, and list markers, truncating to 38 characters or less. It is recommended to use # for the title in the first line of the body.

Which note themes are supported?

Image mode supports six themes: default, smartisan-dark, apple-notes, apple-notes-light, bear, and telegraph; the theme for write mode is determined by the note service side, and the tool does not modify the theme.

Can version 0.1.0 be used?

Not recommended. Version 0.1.0 will abort the session on first call with DSH 0.1.0-rc.6 due to duplicate installation of the host runtime; please use version 0.1.1 or above (current latest is 0.1.2).

How to completely uninstall?

Run dsh plugin --profile web remove @zhaoolee/dsh-notes, then restart the target profile; also clean up NOTES_API_* environment variables and credentials in the plugin config.

— source: plugin_wiki.faq_json

Compatibility

  • DSH: 0.1.0-rc.6+
  • Node: 未声明
  • Platforms: 跨平台

— source: plugin_wiki.compatibility_json

Pitfalls

Review the upstream repo before installing. This guide is auto-derived from indexed fields and may lag the latest release. If anything contradicts the official docs, treat the upstream source as authoritative.

— source: general rule