Skip to main content

How to use plugin-template

Plugin template repo (based on the official turtle-ui repo).

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

Plugin template repo (based on the official turtle-ui repo).

— source: plugins.ai_summary

Install & verify

dsh plugin --profile web add github:omdsh-dev/plugin-template

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

— source: plugins.install

Key points

  • src/index.ts owns the Loader namespace;
  • src/config.ts owns the serializable schema and direct-call defaults;
  • src/runtime.ts owns fakeable host boundaries and Cordis activation;
  • tests/harness.ts owns the shared real-Cordis test mount;
  • cohesive production behavior grows under capability-named src/<feature>/ directories;

— source: plugin_wiki.readme_en (fallback readme_raw)

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