Platform contracts / JSON Schema

Workspai CLI Log Event

NDJSON stream events emitted on stderr when RAPIDKIT_LOG_FORMAT=json or --log-format json

Schema version: cli-log-event-v1
Contract path: contracts/cli-log-event.v1.json
Publication: json-schema
Defined fields: 9
Artifact bindings: 0

Why this contract exists

Architecture role

Defines a versioned interoperability boundary used by Workspai and contract-aware consumers.

Consumption boundary

• Workspai CLI
• Contract-aware integrations

Related commands

Commands are linked only when the runtime contract identifies a direct production relationship. Supporting contracts may be consumed without having a single producer command.

This is a supporting, capability, cache, compatibility, or consumer contract. It has no single direct producer command in the canonical Workspace Intelligence execution registry.

Produced artifacts

These durable files are emitted by registered commands and validated against this contract.

No canonical file artifact is registered for this contract. It may describe capabilities, embedded data, runtime exchange, or supporting state instead of a standalone report.

Field reference

Every declared schema property or published capability path is listed here. Required means the contract declares or publishes that field at the shown boundary.

Field path	Type	Required	Meaning	Constraints
command	array	No	Defines the command value at this contract boundary.	—
component	string	Yes	Defines the component value at this contract boundary.	minLength: 1
event	enum	Yes	Defines the event value at this contract boundary.	enum: log, progress, run.started, run.completed, run.failed
level	enum	Yes	Defines the level value at this contract boundary.	enum: debug, info, warn, error
message	string	Yes	Defines the message value at this contract boundary.	—
metadata	object	No	Defines the metadata value at this contract boundary.	additionalProperties: true
runId	string	Yes	Defines the runid value at this contract boundary.	minLength: 8
schemaVersion	string	Yes	Defines the schemaversion value at this contract boundary.	const: "cli-log-event-v1"
timestamp	string	Yes	Defines the timestamp value at this contract boundary.	format: date-time

Canonical machine-readable definition

The raw synchronized contract remains authoritative. The educational sections above are projections of this definition.

Show raw JSON

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://getrapidkit.com/schemas/cli-log-event.v1.json",
  "title": "Workspai CLI Log Event",
  "description": "NDJSON stream events emitted on stderr when RAPIDKIT_LOG_FORMAT=json or --log-format json",
  "type": "object",
  "required": [
    "schemaVersion",
    "runId",
    "timestamp",
    "level",
    "event",
    "component",
    "message"
  ],
  "properties": {
    "schemaVersion": {
      "const": "cli-log-event-v1"
    },
    "runId": {
      "type": "string",
      "minLength": 8
    },
    "timestamp": {
      "type": "string",
      "format": "date-time"
    },
    "level": {
      "enum": [
        "debug",
        "info",
        "warn",
        "error"
      ]
    },
    "event": {
      "enum": [
        "log",
        "progress",
        "run.started",
        "run.completed",
        "run.failed"
      ]
    },
    "component": {
      "type": "string",
      "minLength": 1
    },
    "message": {
      "type": "string"
    },
    "command": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "metadata": {
      "type": "object",
      "additionalProperties": true
    }
  },
  "additionalProperties": false
}