About worma-guidelines
worma-guidelines is a reference skill for using worma, an OpenAPI code generator. It helps developers find the right documentation for setup, migration, CLI use, templates, plugins, and other workflows.
Key features
- 01Scenario-based documentation lookup
- 02Migration guidance from axios, ky, and wormhole
- 03Guides for CLI, templates, and plugins
- 04Overview of built-in templates and plugins
Use cases
- 01Finding setup steps for a new worma project
- 02Planning a migration from axios or ky
- 03Learning how to add a custom plugin
- 04Looking up API code generation options
Install
Copy the command and run it in a terminal.
npx skills add https:/After installing, type/worma-guidelinesin Claude Code to confirm it loaded.
Bundled filesREADME.mdreferences/migration-wormhole.md
Details
From the project READMEworma — Universal OpenAPI Code Generator
Pick the scenario that matches the user's need, then fetch the detailed information from the corresponding docs link before answering.
If no specific guide is found in this document, consult the worma documentation index at https://worma.js.org/llms.txt to locate the relevant guide.
Migration Trigger Phrases
Use this skill for questions such as:
- migrate from @alova/wormhole to worma
- migrate from axios to worma
- migrate from ky to worma
- switch from wormhole/axios/ky to worma
Scenario Guides
| Scenario | Docs Link |
|---|---|
| First time setup / install & configure | Installation & Configuration |
| Quick start | Quick Start |
Migrate from axios | From Axios migration |
Migrate from ky | From Ky migration |
CLI commands (init, gen, etc.) | CLI Commands |
| Write custom Handlebars templates | Custom Templates |
| Build your own plugin | Custom Plugin / Plugin API |
| Programmatic API | Core Functions / Configuration API |
| Generate AI Skill docs | AI Skills |
| VSCode extension | Editor Docs |
| Monorepo setup | Monorepo |
| Performance tuning | Performance |
Migration Workflow from @alova/wormhole to worma
→ references/migration-wormhole.md
Predefined Templates
worma ships with request-library templates such as alova, axios, fetch, and ky. Use them in generator.plugins to control how API code is generated.
→ See Predefined Templates for usage, options, and examples.
Using the alova template? Install the alova skills for better client/server API usage guidance:
npx skills add https://github.com/alovajs/skills --skill alova-client-usage npx skills add alovajs/skills --skill alova-server-usage
Predefined Plugins
Add these plugins to generator.plugins to customize the generation pipeline.
| Plugin | Description | Docs |
|---|---|---|
aiDoc() | Generates AI-readable interface docs for coding assistants. | aiDoc |
platform() | Auto-assembles OpenAPI URLs for Swagger, Knife4j, FastAPI, and YApi. | platform |
apifox() | Imports OpenAPI documents directly from Apifox. | apifox |
rename() | Renames/transforms API URLs and parameters. | rename |
tagModifier() | Modifies the tags of APIs in the OpenAPI spec. | tagModifier |
payloadModifier() | Adds, removes, or changes request/response parameter types. | payloadModifier |
filterApi() | Filters APIs by URL or tag with matching rules. | filterApi |
importType() | Reuses external types and excludes auto-generated types. | importType |
→ See Built-in Plugins Overview for shared usage patterns and more details.