Interface PipelinePlugin

Readonlymanifest

execute

• execute(
      stage: {
          id: string;
          type: "analyze" | "validate" | "aggregate" | "execute" | "gate" | "route";
          pluginId: string;
          inputArtifacts: string[];
          outputArtifacts: string[];
          dependencies: string[];
          config: Record<string, unknown>;
          preferredCli?: string;
          maxRetries?: number;
          timeoutMs?: number;
      },
      context: StageContext,
  ): Promise<
      {
          success: boolean;
          outputArtifacts: {
              id: string;
              type: | "code"
              | "plan"
              | "analysis"
              | "review"
              | "test"
              | "spec"
              | "report"
              | "vote";
          }[];
          metadata: Record<string, unknown>;
          error?: string;
      },
  >

  Execute a pipeline stage.

  Parameters

  • stage: {
        id: string;
        type: "analyze" | "validate" | "aggregate" | "execute" | "gate" | "route";
        pluginId: string;
        inputArtifacts: string[];
        outputArtifacts: string[];
        dependencies: string[];
        config: Record<string, unknown>;
        preferredCli?: string;
        maxRetries?: number;
        timeoutMs?: number;
    }

    The stage specification from the PlanContract

  • context: StageContext

    Runtime context with abort signal and task

  Returns Promise<
      {
          success: boolean;
          outputArtifacts: {
              id: string;
              type: | "code"
              | "plan"
              | "analysis"
              | "review"
              | "test"
              | "spec"
              | "report"
              | "vote";
          }[];
          metadata: Record<string, unknown>;
          error?: string;
      },
  >

  Stage result with output artifacts

validateConfig

• validateConfig(config: unknown): Result<void, PluginValidationError>

  Validate plugin configuration at registration time. Called once when the plugin is registered, not per-execution.

  Parameters

  • config: unknown

  Returns Result<void, PluginValidationError>

OptionalonLoad

• onLoad?(): Promise<void>

  Optional lifecycle hook — called when plugin is loaded.

  Returns Promise<void>

OptionalonUnload

• onUnload?(): Promise<void>

  Optional lifecycle hook — called when plugin is unloaded.

  Returns Promise<void>