Skip to content

Commit d2aa6de

Browse files
committed
feat: add initialization step for new SDK plugin projects in documentation
1 parent b2eca22 commit d2aa6de

File tree

3 files changed

+5
-0
lines changed

3 files changed

+5
-0
lines changed

.agents/skills/wox-plugin-creator/SKILL.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ description: Create, scaffold, implement, and package Wox plugins (nodejs, pytho
2121
- Use `scripts/scaffold_wox_plugin.py` for `nodejs`, `python`, `script-nodejs`, or `script-python`.
2222
- Pass `--name` and `--trigger-keywords` for every runtime. The scaffold exits without them.
2323
- For Node.js and Python, the scaffold clones the official template repos and replaces placeholders like `{{.ID}}`, `{{.Name}}`, `{{.Description}}`, `{{.TriggerKeywordsJSON}}`, `{{.Author}}`.
24+
- Before starting work in a new SDK plugin project, run `make init` in the project root when the project has not been initialized yet.
2425
- Script plugins are **single-file** plugins. Prefer filenames like `Wox.Plugin.Script.<Name>.<ext>` (e.g., `Wox.Plugin.Script.Memos.py`).
2526
- For script plugins, the scaffold copies Wox script templates from `~/.wox/ai/skills/wox-plugin-creator/assets/script_plugin_templates/` and fills metadata placeholders.
2627
- Prefer standard library features; avoid third-party dependencies unless absolutely necessary.

.agents/skills/wox-plugin-creator/references/scaffold_nodejs.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Best practice: clone the official template repo instead of hardcoding a scaffold
66
git clone https://github.com/Wox-launcher/Wox.Plugin.Template.Nodejs my-plugin
77
```
88

9+
Before editing a new project, run `make init` in the project root when initialization has not been done yet.
10+
911
Then follow the template README, update `plugin.json` fields (ID, Name, Description, TriggerKeywords), and implement your plugin logic.
1012

1113
Build and publish:

.agents/skills/wox-plugin-creator/references/scaffold_python.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Best practice: clone the official template repo instead of hardcoding a scaffold
66
git clone https://github.com/Wox-launcher/Wox.Plugin.Template.Python my-plugin
77
```
88

9+
Before editing a new project, run `make init` in the project root when initialization has not been done yet.
10+
911
Then follow the template README, update `plugin.json` fields (ID, Name, Description, TriggerKeywords), and implement your plugin logic.
1012

1113
Build and publish:

0 commit comments

Comments
 (0)