webiny-cli-command-catalog

Implements custom CLI commands for the Webiny CLI using the CliCommandFactory abstraction.

8.0k|673|Updated Jan 9, 2018
One-click install
npx skills add https://github.com/webiny/webiny-js --skill webiny-cli-command-catalog
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: webiny-cli-command-catalog
Source: https://github.com/webiny/webiny-js/tree/main/skills/user-skills/generated/cli/command
Command: npx skills add https://github.com/webiny/webiny-js --skill webiny-cli-command-catalog

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Developers extending Webiny projects often need custom command-line commands, but discovering the correct abstraction, its interface, and its import path requires digging through the Webiny monorepo source code.

Core Features & Use Cases

  • Abstraction Catalog: Lists the CliCommandFactory abstraction with its exact import path and source file location in @webiny/cli-core.
  • Source-Grounded Guidance: Directs you to read the actual source file to obtain the exact interface and types before implementing.
  • Use Case: When building a Webiny extension that needs a new CLI command (for example, a custom deployment or migration command), use this Skill to locate the CliCommandFactory contract and implement it correctly.

Quick Start

Ask the assistant to show how to implement a custom Webiny CLI command using the CliCommandFactory abstraction.

Frequently Asked Questions about webiny-cli-command-catalog

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I create a custom CLI command in Webiny?

Implement the CliCommandFactory abstraction from webiny/cli/command. First read the source file at @webiny/cli-core/abstractions/features/CliCommand.ts to get the exact interface and types, then import CliCommandFactory and provide your implementation.

Where is the CliCommandFactory interface defined in Webiny?

The CliCommandFactory interface is defined in @webiny/cli-core at abstractions/features/CliCommand.ts. You import it in your code via the path webiny/cli/command.

What package contains the Webiny CLI command abstraction?

The abstraction lives in the @webiny/cli-core package, specifically in the abstractions/features directory. The public import path exposed for consumers is webiny/cli/command.

Do I need to read the source file before implementing a Webiny CLI command?

Yes. The catalog instructs you to read the source file to obtain the exact interface and types, since the abstraction listing only provides the name, import path, and source location rather than the full type definition.