<!-- SPDX-License-Identifier: Apache-2.0 -->
**Status:** stable · **Owner:** Developer Relations · **License:** Apache-2.0

# `byo-ontology` — cross-map your ontology to a regulatory framework

Starter that takes a sample customer ontology (your own terms) and cross-maps
each term to a regulatory framework control using the public KYE
taxonomy-mapping schema shape — then runs the mapping inside a self-governing
KYE agent so the cross-map itself is evidenced.

This ties to the KYE **bring-your-own-ontology** feature: you keep your existing
vocabulary; KYE resolves it onto its taxonomy + framework controls rather than
forcing you to re-tag everything.

## Run

```bash
kye agent new my-agent --template byo-ontology
cd my-agent && npm install && npm start
```

`ontology/sample-ontology.json` holds the BYO terms; `ontology/crossmap.json`
holds the cross-map records (one taxonomy-mapping record per term). Replace
both with your own.

## The mapping shape

Each cross-map record follows the public KYE taxonomy-mapping example —
see [`public/examples/taxonomy-mapping.json`](../../../examples/taxonomy-mapping.json)
and [`public/examples/ontology-mapping.json`](../../../examples/ontology-mapping.json).
A mapping that is *related but not identical* MUST say so (`mapping_type`) and
MUST list the additional KYE objects still required to prove authority — never
inflate a loose mapping to an identity.

## Files

- `src/agent.ts` — the KYE-wrapped cross-mapper.
- `ontology/sample-ontology.json` — sample BYO terms.
- `ontology/crossmap.json` — the term → framework cross-map records.
- `package.json` — depends on `@kye/agent-dev-kit`.
