OpenParable
Skip to content
← Back to skills

Webiny API System Catalog

Development
webiny-api-system-catalog

Webiny API System Catalog is an Agent Skill for development published in the webiny/webiny-js repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

API — System — 2 abstractions. System installation event handlers and use cases.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/webiny/webiny-js/blob/HEAD/skills/user-skills/generated/api/system/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/webiny-api-system-catalog, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

API — System

System installation event handlers and use cases.

How to Use

  1. Find the abstraction you need below
  2. You MUST read the source file to get the exact interface and types!
  3. Import: import { Name } from "<importPath>";
  4. See webiny-use-case-pattern or webiny-event-handler-pattern skills for implementation patterns

Abstractions


Name: InstallSystemUseCase Import: import { InstallSystemUseCase } from "webiny/api/system" Source: @webiny/api-core/features/system/InstallSystem/index.ts Description: Run system-wide installation.


Name: SystemInstalledEventHandler Import: import { SystemInstalledEventHandler } from "webiny/api/system" Source: @webiny/api-core/features/system/InstallSystem/index.ts Description: Hook into system lifecycle after the system is installed.