Getting Started

Create a Vue + Java Worker plugin:

bash

fengyu init ./my-plugin --id com.example.my-plugin
cd my-plugin

Use --no-install to skip npm installation or --ui-only to omit the Java worker. The generated project follows the Toolchain 2 standard layout:

text

my-plugin/
├── manifest.json
├── mvnw, mvnw.cmd
├── .mvn/
├── ui-src/
│   ├── package.json
│   ├── vite.config.ts
│   └── src/
└── worker/
    ├── pom.xml
    ├── src/main/java/…
    └── src/test/java/…/PluginDevMain.java

There is no separate legacy build-config file; the single descriptor is manifest.json. The CLI uses npm's dev, optional test, and build scripts, plus the Maven test and package lifecycle. The worker build must emit one worker/target/*-worker.jar.

Run the UI simulator through the unified command:

bash

fengyu dev

For a Java plugin, also debug PluginDevMain.main() in the IDE. It exposes the same handlers over loopback TCP, so breakpoints fire without the CLI owning the Worker process. Open http://127.0.0.1:5173/__fengyu for the simulator.

Check and package the project:

bash

fengyu check
fengyu build

The package and checksum are written to dist/<id>-<version>.fyp[.sha256]. Install the .fyp through the host marketplace UI. See SDK & CLI and Build & Deploy for the contracts.

Getting Started ​

Getting Started