Skip to content

Kernel Wire Protocol (KWP)

The Kernel Wire Protocol is the IPC format used between the kernel daemon and its clients.

Transports

TransportDefaultUse case
Unix domain socket/tmp/designlint-kernel.sockPrimary; same-host Node.js clients
HTTP + SSEPort 7341Browser clients; cross-machine access

Frame format (Unix socket)

Frames over the Unix socket are length-prefixed MessagePack:

text
[ 4-byte uint32BE length ][ MessagePack-encoded KWPFrame ]

The length field counts only the MessagePack payload bytes, not itself.

Frame format (HTTP)

  • POST /kwp — request/response for DSQL queries and write operations
  • GET /kwp/events — SSE stream for kernel push events
  • GET /kwp/status — kernel status endpoint (plain JSON)

HTTP frames are JSON-encoded KWPFrame objects.

KWPFrame

ts
interface KWPFrame {
  readonly type: 'request' | 'response' | 'event' | 'error';
  readonly id: string;           // UUID v4
  readonly method?: string;      // e.g. 'dsql.tokens.closest'
  readonly payload?: unknown;    // method params or response data
  readonly error?: {
    readonly code: string;
    readonly message: string;
  };
}

Methods

DSQL queries (read-only)

MethodParametersReturns
dsql.tokens.closestrawValue, property, type?RankedToken[]
dsql.tokens.forPropertycssProperty, type?DtifFlattenedToken[]
dsql.tokens.byPointerpointerDtifFlattenedToken | null
dsql.tokens.deprecatedtype?DeprecatedToken[]
dsql.tokens.withReplacementpointerstring | null
dsql.rules.allcategory?RuleDefinition[]
dsql.rules.enabledcategory?RuleDefinition[]
dsql.rules.byIdruleIdRuleDefinition | null
dsql.rules.categoriesstring[]
dsql.rules.fixablecategory?RuleDefinition[]
dsql.components.allComponentDefinition[]
dsql.components.byNamenameComponentDefinition | null
dsql.components.byPackagepackageNameComponentDefinition[]
dsql.components.deprecatedComponentDefinition[]
dsql.entropyEntropyState

Write operations

MethodParameters
write.addTokenpointer, token
write.deprecateTokenpointer, replacement?
write.removeTokenpointer
write.configureRuleruleId, partial
write.registerComponentname, definition
write.loadPluginmanifest
write.recordDeprecationEntryentry
write.updateEntropyscore
kernel.snapshotpath
kernel.status

Error codes

CodeDescription
UNKNOWN_METHODThe requested method is not recognised by the kernel

Released under the MIT License.