@fdekit/connector-k6

Purpose

@fdekit/connector-k6 lets FDEKit agents run governed load-test scenarios through loadtest.run. Local mode returns an explicitly simulated, deterministic result without making HTTP requests. k6 mode invokes the k6 CLI and returns measured evidence.

Who should use this package

• Deployment authors validating customer API readiness with load-test evidence.
• Recipe authors building performance, smoke-test, or rollout readiness workflows.
• Connector contributors maintaining k6 command construction, result parsing, and local-mode parity.

Choose @fdekit/environment-docker or @fdekit/environment-floci when you need to start the customer-like system around the test.

5-minute quick example

import { defineDeployment } from '@fdekit/core';
import { k6Connector } from '@fdekit/connector-k6';

const k6 = k6Connector({
  mode: process.env.FDEKIT_CONNECTOR_MODE === 'k6' ? 'k6' : 'local',
  targetUrl: process.env.CUSTOMER_API_URL ?? 'http://localhost:8787',
  scriptPath: './load-tests/customer-api-smoke.js',
});

export default defineDeployment({
  name: 'customer-api-load-test',
  environment: 'local',
  connectors: { k6 },
  providers: {
    mock: { name: 'mock' },
  },
  agents: {
    // ...
  },
});

Set K6_BINARY only when the k6 executable is not available as k6.

Public API surface

Import from the package root:

import { k6Connector } from '@fdekit/connector-k6';
import type { K6ConnectorOptions, K6RunResult } from '@fdekit/connector-k6';

Root exports include k6Connector, K6ConnectorConfig, K6ConnectorMode, K6ConnectorOptions, K6RunArgs, K6RunEvidenceKind, K6RunResult, K6Scenario, K6CommandInvocation, and K6CommandResult. K6RunResult.evidenceKind is simulated in local mode and measured in k6 mode. The connector family is summarized in the public API index: Public API Reference.

Stability/backward-compat notes

@fdekit/connector-k6 is public but pre-1.0. The package-root factory, option/result types, local/k6 modes, and loadtest.run tool name are compatibility-sensitive.

Subpath imports are internal. Keep local mode deterministic and explicitly simulated so demos and tests do not require the k6 binary or imply real performance evidence.

See also

• Connector authoring contracts: @fdekit/core
• Runtime execution: @fdekit/runtime
• Local environment packages: Docker, Floci
• Connector family: customer API, codebase, GitHub, Slack, Jira, Linear, Postgres, HubSpot, Salesforce