generate-adapter

Generieren einer Paperclip-Extension

Argumente

1. name (erforderlich) — Kebab-Case-Name (z.B. linear-sync, custom-claude)
2. kind (erforderlich) — eines von plugin | adapter

Welches?

Bedarf	Verwenden Sie
Features, Integrationen, Jobs, UI-Slots oder ein neues Dashboard-Widget hinzufügen	plugin
Eine neue AI-Runtime-Option hinzufügen (neuer CLI-Agent, neue Remote-Runtime)	adapter

Im Zweifel: Beginnen Sie mit einem Plugin.

---

kind = plugin (empfohlen)

Paperclip liefert einen First-Party-Scaffolder.

# In einem leeren Verzeichnis (oder Monorepo-Root)
npm create paperclip-plugin@latest
# oder
pnpm create paperclip-plugin

Folgen Sie den Prompts. Output:

<plugin-name>/
├── package.json
├── tsconfig.json
├── src/
│   ├── worker.ts          # definePlugin({ setup(ctx) }) + runWorker
│   ├── manifest.ts        # PaperclipPluginManifestV1
│   └── ui/                # optional — React-Teile für UI-Slots
├── tests/
│   └── worker.test.ts     # createTestHarness aus @paperclipai/plugin-sdk/testing
└── README.md

Minimaler Worker:

import { definePlugin, runWorker, z } from "@paperclipai/plugin-sdk";

const configSchema = z.object({
  apiKey: z.string().describe("API-Key-Referenz (ctx.secrets)"),
});

const plugin = definePlugin({
  async setup(ctx) {
    ctx.logger.info(`${ctx.manifest.name} starting`);

    ctx.events.on("issue.created", async (event) => {
      ctx.logger.info("issue.created", { entityId: event.entityId });
      // ...
    });

    ctx.jobs.register("hello", async (job) => {
      ctx.logger.info("hello job", { runId: job.runId });
    });
  },
  async onHealth() {
    return { status: "ok" };
  },
});

export default plugin;
runWorker(plugin, import.meta.url);

Manifest-Essentials

Deklarieren Sie nur die Capabilities, die Sie benötigen:

import type { PaperclipPluginManifestV1 } from "@paperclipai/plugin-sdk";

export const manifest: PaperclipPluginManifestV1 = {
  apiVersion: 1,
  id: "acme-linear-sync",
  name: "Acme Linear Sync",
  version: "0.1.0",
  categories: ["integration"],
  capabilities: ["network.http", "events.subscribe"],  // enger Scope!
  instanceConfigSchema: { /* JSON Schema aus zod */ },
  jobs: [{ key: "full-sync", title: "Full sync" }],
  // webhooks, launchers, ui slots, tools — nur hinzufügen, was Sie ausliefern
};