wox-launcher/wox
Overview
This skill scaffolds and prepares Wox plugins for Node.js, Python, and single-file script plugins (script-nodejs, script-python). It automates cloning official SDK templates, filling metadata, and producing ready-to-publish plugin folders or single-file script plugins. Use it to standardize plugin structure and speed up development and publishing.
How this skill works
The tool runs a scaffold script that either clones official Node.js/Python SDK templates or copies local script templates for single-file plugins. It replaces placeholders (ID, name, description, trigger keywords, author) in template files and generates output in the specified directory or filename. Additional scripts help package and publish SDK-based plugins using the template's Makefile.
When to use it
- Starting a new Wox plugin project in Node.js or Python from the official SDK templates.
- Creating a single-file script plugin for quick utilities (JavaScript or Python).
- Preparing plugin metadata and folder structure before packaging and publishing.
- Generating consistent plugin IDs, names, descriptions, and trigger keywords automatically.
- Prototyping plugins quickly without manually copying template files.
Best practices
- Use the scaffold script for consistent template cloning and metadata replacement rather than copying files manually.
- Name single-file script plugins with the Wox.Plugin.Script.<Name>.<ext> pattern for discoverability.
- Prefer standard library features in scripts to avoid extra runtime dependencies.
- Edit translated strings and i18n files according to plugin_i18n guidance in the references.
- Run the template repo's Makefile (make publish) for SDK-based plugins to build and publish correctly.
Example use cases
- Create a new Node.js Wox plugin by cloning the official Node SDK template and auto-filling plugin metadata.
- Generate a lightweight single-file Python script plugin for a personal quick-action tool with predefined trigger keywords.
- Scaffold a Python SDK plugin folder for a feature-rich extension that will be packaged and published via the template's publishing flow.
- Standardize multiple plugins in a team by using the same template cloning workflow and metadata placeholders.
FAQ
Yes. The script plugin modes copy local script templates from the assets folder and produce a single file with metadata filled.
How do I publish a plugin created from an SDK template?
Enter the cloned template repo and run its packaging/publish steps, typically documented in the template; for SDK templates use the provided Makefile (make publish).
