wox-plugin-creator

name: wox-plugin-creator description: 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 Creator

Overview

The Wox Plugin Creator skill provides comprehensive support for developing and maintaining Wox plugins across multiple technology stacks. This skill enables developers to efficiently scaffold new plugins, manage existing codebases, and prepare plugins for production deployment.

Wox is a powerful launcher application that enhances productivity by providing quick access to applications, files, and web resources. The plugin ecosystem supports various development approaches including Node.js-based plugins, Python-based plugins, and lightweight script plugins that can be executed directly within the Wox environment.

Usage

Plugin Development Workflow

Developers can leverage this skill to initiate new plugin projects or extend existing implementations. The workflow encompasses template cloning, code generation, and deployment preparation activities.

Configuration Management

Proper configuration ensures consistent plugin behavior across different environments. Key configuration elements include plugin identification, trigger keyword definitions, and author information management.

Guidelines

Operational Mode

This section outlines the core operational procedures for plugin development and maintenance. All activities should follow established patterns to ensure consistency and maintainability.

Development Standards

• 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.

Deployment Procedures

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

Examples

Node.js Plugin Example

// Plugin configuration structure
{
  "id": "wox-plugin-creator",
  "name": "Wox Plugin Creator",
  "triggerKeywords": ["plugin", "scaffold", "development"],
  "author": "Development Team"
}

Python Plugin Example

# Plugin initialization
from wox_plugin import PluginBase

class WoxPluginCreator(PluginBase):
    def __init__(self):
        self.name = "Wox Plugin Creator"
        self.version = "1.0.0"

Script Plugin Example

# Execute script plugin
python3 scripts/scaffold_wox_plugin.py \
  --type script-nodejs \
  --output-dir ./Wox.Plugin.Script.MyScript.js \
  --name "My Script" \
  --trigger-keywords my

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/