@flowcraft.systems/sdk

File-watcher SDK for flowcraft — streams AI agent telemetry spans to your ingest endpoint.

After running @flowcraft.systems/cli init in your workspace, start the watcher with:

npx @flowcraft.systems/sdk

The watcher reads .flowcraft/config.yaml for configuration (written by flowcraft init).

Requirements

• Node.js ≥ 22
• .flowcraft/config.yaml in the current directory (created by flowcraft init)

Usage

# Run from the root of any instrumented repository
npx @flowcraft.systems/sdk

# One-shot mode (process existing files and exit)
npx @flowcraft.systems/sdk --once

What it does

Watches the file patterns defined in .flowcraft/config.yaml, converts matching markdown artefacts to OpenTelemetry spans, and posts them to your configured ingest endpoint with your PAT.

Configuration

.flowcraft/config.yaml (created by flowcraft init):

org_slug: "your-org"
api_key:  "fc_pat_..."
otlp_endpoint: "https://ingest.flowcraft.systems"

watch_patterns:
  - "docs/feature/**/*.md"
  - "docs/research/**/*.md"

roi_baselines:
  - agent_name: "default"
    manual_hours: 3.0

Programmatic API

import { WatcherAdapter } from "@flowcraft/sdk";

See flowcraft.systems for full documentation.

License

MIT