ktx/examples/orbit-relationship-verification/README.md
Andrey Avtomonov 00cdf2de90
refactor: enforce ktx naming and AGENTS.md compliance sweep (#289)
Align the tree with AGENTS.md/CLAUDE.md conventions:

- Rewrite user-facing strings, docs, and tests to lowercase `ktx`
  (no bare uppercase `KTX` tokens remain outside literal identifiers).
- Drop the legacy `historicSql` migration path and its now-unused
  helpers, per the no-backward-compat rule.
- Remove `as unknown as` / `any` casts: narrow `BaseTool` generics to
  `z.ZodObject`, add a typed `createLookerClient`, and delete the dead
  `getParametersSchema`/`toAnthropicFormat` pre-AI-SDK helpers.
- Use `InvalidArgumentError` for Commander parse failures.
- Finish the adapter→connector prose conversion in the `ktx.yaml` docs
  while keeping the literal `adapters` config key.
2026-06-11 13:49:45 +02:00

33 lines
740 B
Markdown

# Orbit-style relationship discovery verification
This **ktx** project backs the default `relationships:verify-orbit` command. It uses
the checked-in Orbit-style SQLite fixture from the relationship discovery
benchmark corpus, with no declared primary keys or foreign keys in the database
schema.
Run from the **ktx** workspace root:
```bash
pnpm run relationships:verify-orbit
```
Expected relationship summary:
```text
Accepted: 9
Review: 0
Rejected: 0
Skipped: 0
```
The command refreshes:
```text
examples/orbit-relationship-verification/reports/orbit-verification.md
```
Use a real local Orbit project by overriding the project directory:
```bash
KTX_PROJECT_DIR=/path/to/orbit-project pnpm run relationships:verify-orbit
```