Wox Plugin Creator

Scaffold and publish Wox launcher plugins in minutes

✨ The solution you've been looking for

Verified

Tested and verified by our team

26494 Stars

Create and scaffold Wox plugins (nodejs, python, script-nodejs, script-python). Use when cloning official SDK templates, generating script plugin templates, or preparing plugins for publish.

wox plugin-development scaffolding nodejs python automation launcher templating

Repository

See It In Action

Interactive preview & real-world examples

Live Demo

AI Conversation Simulator

See how users interact with this skill

User Prompt

Help me create a new Wox plugin in Node.js for managing bookmarks with trigger keyword 'bm'

Skill Processing

Analyzing request...

Agent Response

Complete plugin directory with template files, proper package.json, plugin.json metadata, and scaffold ready for development

Quick Start (3 Steps)

Get up and running in minutes

Install

claude-code skill install wox-plugin-creator

claude-code skill install wox-plugin-creator

Config

First Trigger

@wox-plugin-creator help

Commands

Command	Description	Required Args
@wox-plugin-creator create-a-new-node.js-plugin	Scaffold a full Node.js plugin using official templates with proper structure and metadata	None
@wox-plugin-creator generate-a-quick-script-plugin	Create single-file script plugins for simple automation tasks without full SDK overhead	None
@wox-plugin-creator package-plugin-for-distribution	Prepare and package completed plugins following Wox publishing standards	None

Typical Use Cases

Create a new Node.js plugin

Scaffold a full Node.js plugin using official templates with proper structure and metadata

Generate a quick script plugin

Create single-file script plugins for simple automation tasks without full SDK overhead

Package plugin for distribution

Prepare and package completed plugins following Wox publishing standards

Overview

Wox Plugin Creator

Quick Start

Scaffold a Node.js plugin (clones template repo):
- python3 scripts/scaffold_wox_plugin.py --type nodejs --output-dir ./MyPlugin
Scaffold a Python plugin (clones template repo):
- python3 scripts/scaffold_wox_plugin.py --type python --output-dir ./MyPlugin
Scaffold a script plugin (uses local templates; plugin-id auto-generated; single file output):
- python3 scripts/scaffold_wox_plugin.py --type script-nodejs --output-dir ./Wox.Plugin.Script.MyScript.js --name "My Script" --trigger-keywords my

Workflow

1) Scaffold plugin files

Use scripts/scaffold_wox_plugin.py for nodejs, python, script-nodejs, or script-python.
For Node.js and Python, the scaffold clones the official template repos and replaces placeholders like {{.ID}}, {{.Name}}, {{.Description}}, {{.TriggerKeywordsJSON}}, {{.Author}}.
Script plugins are single-file plugins. Prefer filenames like Wox.Plugin.Script.<Name>.<ext> (e.g., Wox.Plugin.Script.Memos.py).
For script plugins, the scaffold copies Wox script templates from ~/.wox/ai/skills/wox-plugin-creator/assets/script_plugin_templates/ and fills metadata placeholders.
Prefer standard library features; avoid third-party dependencies unless absolutely necessary.
For SDK usage and API details, read references/sdk_nodejs.md or references/sdk_python.md.

2) Package and publish

For SDK plugins cloned from templates, run make publish inside the template repo.
Publishing notes: references/publishing.md.

Resources

scripts: scripts/scaffold_wox_plugin.py, scripts/package_plugin.py
references: references/plugin_overview.md, references/scaffold_nodejs.md, references/scaffold_python.md, references/sdk_nodejs.md, references/sdk_python.md, references/plugin_json_schema.md, references/plugin_i18n.md, references/publishing.md
assets: assets/script_plugin_templates/