How do I install the Worma Guidelines skill?

Run npx skillmds@latest add alovajs/worma-guidelines in your terminal (requires Node.js), paste this page's agent-chat prompt into Claude, Cursor, or any MCP-connected agent, or download the SKILL.md file and copy it into your agent's skills directory.

Is Worma Guidelines safe to use?

This skill has not completed SkillMD's automated safety review yet. SkillMD never runs a skill's scripts for you; review the SKILL.md before installing.

Which AI agents work with Worma Guidelines?

This skill is tagged as working with Claude Code, Claude.ai, OpenAI Codex. SKILL.md is an open format, so most agents that read a skills directory can load it too.

Is Worma Guidelines free to use?

Yes. Installing skills from SkillMD is free, and the skill stays under its author's original license.

Who published Worma Guidelines?

alovajs (@alovajs) published this skill. Their other Agent Skills are listed on their SkillMD profile.

Worma Guidelines by alovajs — Agent Skill

Name: Worma Guidelines
Author: alovajs

Worma Guidelines

worma OpenAPI code generation and configuration. Use this skill whenever the user mentions worma config, API code generation, OpenAPI/Swagger integration, worma CLI, or migration from @alova/wormhole, axios, or ky. Trigger for questions about worma.config, npx worma init/gen, generating API code from OpenAPI specs, or switching from @alova/wormhole, axios, or ky to worma.

alovajs a0010da 3 files · 8.8 KB Updated Sep 17, 2026

File contents

worma — 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.

---name: worma-guidelinesdescription: worma OpenAPI code generation and configuration. Use this skill whenever the user mentions worma config, API code generation, OpenAPI/Swagger integration, worma CLI, or migration from @alova/wormhole, axios, or ky. Trigger for questions about worma.config, npx worma init/gen, generating API code from OpenAPI specs, or switching from @alova/wormhole, axios, or ky to worma.---# worma — Universal OpenAPI Code GeneratorPick 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 PhrasesUse 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](https://worma.js.org/llms.mdx/docs/guide/installation-config.md) || Quick start | [Quick Start](https://worma.js.org/llms.mdx/docs/quick-start.md) || Migrate from `axios` | [From Axios migration](https://worma.js.org/docs/migration/from-axios) || Migrate from `ky` | [From Ky migration](https://worma.js.org/docs/migration/from-ky) || CLI commands (`init`, `gen`, etc.) | [CLI Commands](https://worma.js.org/llms.mdx/docs/cli-commands.md) || Write custom Handlebars templates | [Custom Templates](https://worma.js.org/docs/template-system/custom-templates) || Build your own plugin | [Custom Plugin](https://worma.js.org/llms.mdx/docs/plugin-system/custom-plugin.md) / [Plugin API](https://worma.js.org/llms.mdx/docs/api/plugin-api.md) || Programmatic API | [Core Functions](https://worma.js.org/llms.mdx/docs/api/core-functions.md) / [Configuration API](https://worma.js.org/llms.mdx/docs/api/configuration.md) || Generate AI Skill docs | [AI Skills](https://worma.js.org/llms.mdx/docs/ai-skills.md) || VSCode extension | [Editor Docs](https://worma.js.org/llms.mdx/docs/guide/editor-docs.md) || Monorepo setup | [Monorepo](https://worma.js.org/llms.mdx/docs/guide/monorepo.md) || Performance tuning | [Performance](https://worma.js.org/llms.mdx/docs/performance.md) |## Migration Workflow from @alova/wormhole to worma→ [references/migration-wormhole.md](references/migration-wormhole.md)## Predefined Templatesworma 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](https://worma.js.org/llms.mdx/docs/template-system/predefined-templates.md) for usage, options, and examples.> **Using the alova template?** Install the alova skills for better client/server API usage guidance:>> ```bash> npx skills add https://github.com/alovajs/skills --skill alova-client-usage> npx skills add alovajs/skills --skill alova-server-usage> ```## Predefined PluginsAdd these plugins to `generator.plugins` to customize the generation pipeline.| Plugin | Description | Docs || ------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- || `aiDoc()` | Generates AI-readable interface docs for coding assistants. | [aiDoc](https://worma.js.org/llms.mdx/docs/plugin-system/builtin-plugins/aiDoc.md) || `platform()` | Auto-assembles OpenAPI URLs for Swagger, Knife4j, FastAPI, and YApi. | [platform](https://worma.js.org/llms.mdx/docs/plugin-system/builtin-plugins/platform.md) || `apifox()` | Imports OpenAPI documents directly from Apifox. | [apifox](https://worma.js.org/llms.mdx/docs/plugin-system/builtin-plugins/apifox.md) || `rename()` | Renames/transforms API URLs and parameters. | [rename](https://worma.js.org/llms.mdx/docs/plugin-system/builtin-plugins/rename.md) || `tagModifier()` | Modifies the `tags` of APIs in the OpenAPI spec. | [tagModifier](https://worma.js.org/llms.mdx/docs/plugin-system/builtin-plugins/tag-modifier.md) || `payloadModifier()` | Adds, removes, or changes request/response parameter types. | [payloadModifier](https://worma.js.org/llms.mdx/docs/plugin-system/builtin-plugins/payload-modifier.md) || `filterApi()` | Filters APIs by URL or tag with matching rules. | [filterApi](https://worma.js.org/llms.mdx/docs/plugin-system/builtin-plugins/filter-api.md) || `importType()` | Reuses external types and excludes auto-generated types. | [importType](https://worma.js.org/llms.mdx/docs/plugin-system/builtin-plugins/import-type.md) |→ See [Built-in Plugins Overview](https://worma.js.org/llms.mdx/docs/plugin-system/custom-plugin.md) for shared usage patterns and more details.

Frequently asked questions