Skip to content

xeel-dev/create-xeel-cli-plugin

Repository files navigation

Xeel CLI / Create Xeel CLI Plugin

A simple scaffolding tool to create plugins for the Xeel CLI. This tool generates a boilerplate project with all the necessary files and configurations to start building your own Xeel CLI plugin.

CLI plugins can add support for new ecosystems to Xeel.

Features

  • Preconfigured structure for Xeel CLI plugins.
  • Includes example commands and configurations.
  • Easily customizable to suit your needs.

Usage

Using pnpm (recommended)

  1. Run the scaffolding tool with the desired plugin name:
pnpm create xeel-cli-plugin my-plugin
  1. Navigate to your new plugin directory:
cd my-plugin
  1. Install dependencies
pnpm install
  1. Start building your plugin by editing the example ecosystem support in src/ecosystem.ts

  2. Link your local plugin to the Xeel CLI using npx xeel plugins link ./my-plugin; see https://github.com/oclif/plugin-plugins?tab=readme-ov-file#mycli-plugins-link-path

  3. You can now test your plugin using the Xeel CLI. 🚀

About

Xeel CLI Plugin Boilerplate

Resources

License

Stars

Watchers

Forks