API Reference

Reference guides, package registries, source entrypoints, and public event contracts.

The public repository is the source of truth for package behavior. Each reference guide below describes the supported public surface and links directly to its implementation.

Reference guides

Guide	Covers
TypeScript API	`@traice/sdk` functions, classes, adapters, integrations, analytics, guardrails, and exported types
Python API	`traice-sdk` functions, client lifecycle, tracker, callback handler, and public data classes
Event contracts	Product transport fields, SDK-local events, internal usage events, and `@traice/protocol` utilities
Collector overview	`@traice/collector` setup, adapters, service lifecycle, delivery, and backfill
Collector configuration	Device configuration, credentials, compatibility, backups, and local state
Collector routing	Per-agent defaults, folder and worktree rules, precedence, status, and route CLI behavior

Packages and source

Package	Registry	Public entrypoint	Package docs	Changelog
`@traice/sdk`	npm	`packages/sdk/src/index.ts`	README	CHANGELOG
`traice-sdk`	PyPI	`packages/python/src/traice/__init__.py`	README	CHANGELOG
`@traice/collector`	npm	`packages/collector/src/index.ts`	README	CHANGELOG
`@traice/protocol`	npm	`packages/protocol/src/index.ts`	README	CHANGELOG

Import names

The npm packages keep the @traice organization scope. Python package indexes do not support npm-style scopes, so the Python distribution is named traice-sdk and its import name is traice.

Text

npm install @traice/sdk
pip install traice-sdk

All currently supported TypeScript SDK exports come from the package root. Python users can import the documented root symbols from traice; TraiceCallbackHandler is also available from traice.integrations.

Version and support policy

Use the registry changelog and the package source from the same released version when exact behavior matters. Main-branch source can include changes that have not reached a registry yet.

The API reference documents public entrypoint exports. Internal helpers that are exported from implementation files but not re-exported by a package entrypoint are not supported as package APIs.

Report package defects in GitHub Issues. Include the package name, installed version, runtime version, minimal reproduction, and sanitized error output.