mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-07 07:55:13 +02:00
42b688e934
* docs: align docs with current KTX behavior * fix: generate valid agent sl query command * docs: clarify KTX product mechanics * fix: use <ol> for runtime pipeline steps in product mechanics The PipelineStep component renders <li> elements, but the RuntimeDiagram wrapper was a plain <div> instead of a list element. This produced invalid HTML and accessibility warnings. IngestionDiagram already used <ol>. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * Add docs favicon * docs: add semantic layer internals concept * docs: refine documentation source label * docs: clarify company documentation examples --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
71 lines
3.1 KiB
Text
71 lines
3.1 KiB
Text
---
|
|
title: Integrations
|
|
description: Connect KTX to warehouses, analytics tools, and coding agents.
|
|
---
|
|
|
|
KTX integrations bring trusted context into an analytics project and make that
|
|
context available to coding agents through the CLI. Start with `ktx setup` when
|
|
you want the guided flow, then use the integration reference pages for exact
|
|
configuration fields, generated files, and manual setup.
|
|
|
|
## Integration types
|
|
|
|
| Type | What it connects | Start here |
|
|
|------|------------------|------------|
|
|
| Primary sources | Warehouses and databases that KTX scans for schemas, constraints, row counts, and optional query history | [Primary Sources](/docs/integrations/primary-sources) |
|
|
| Context sources | Existing analytics and knowledge tools such as dbt, MetricFlow, LookML, Metabase, Looker, and Notion | [Context Sources](/docs/integrations/context-sources) |
|
|
| Agent clients | Claude Code, Codex, Cursor, OpenCode, and universal `.agents` consumers | [Agent Clients](/docs/integrations/agent-clients) |
|
|
|
|
## Recommended setup flow
|
|
|
|
Use this order for a new project:
|
|
|
|
1. Run `ktx setup` from the analytics project directory.
|
|
2. Configure an LLM backend and embeddings so KTX can enrich and search context.
|
|
3. Add at least one primary source connection.
|
|
4. Add optional context sources that describe the same warehouse or business domain.
|
|
5. Build context during setup, or run `ktx ingest <connectionId>` later.
|
|
6. Install agent integration with `ktx setup --agents` when the context is ready.
|
|
|
|
For repeatable setup, pass `--project-dir`, `--no-input`, and the relevant
|
|
automation flags documented in [`ktx setup`](/docs/cli-reference/ktx-setup).
|
|
|
|
## What setup writes
|
|
|
|
| Path | Purpose |
|
|
|------|---------|
|
|
| `ktx.yaml` | Main project configuration for providers, embeddings, connections, source mappings, and query history |
|
|
| `.ktx/secrets/*` | Local file-backed secrets when you choose file references during setup |
|
|
| `.ktx/setup/*` | Local setup progress and context-build state |
|
|
| `semantic-layer/<connection-id>/` | YAML semantic sources generated by database and source ingestion |
|
|
| `wiki/` | Markdown business context, definitions, and ingested knowledge |
|
|
| `.ktx/agents/install-manifest.json` | Manifest of agent integration files installed by `ktx setup --agents` |
|
|
| Agent client files | Skills, rules, or commands that teach agents when and how to call KTX |
|
|
|
|
## Common commands
|
|
|
|
```bash
|
|
# Start or resume the guided flow
|
|
ktx setup
|
|
|
|
# Add or refresh every configured integration
|
|
ktx ingest --all
|
|
|
|
# Refresh one configured warehouse, source, or knowledge integration
|
|
ktx ingest warehouse
|
|
|
|
# Install one project-scoped agent target
|
|
ktx setup --agents --target codex
|
|
|
|
# Check whether integrations are ready
|
|
ktx status
|
|
```
|
|
|
|
## Choosing docs
|
|
|
|
Read [Primary Sources](/docs/integrations/primary-sources) when you need
|
|
database driver fields, authentication formats, query history support, or
|
|
warehouse-specific notes. Read [Context Sources](/docs/integrations/context-sources)
|
|
when you need source adapter fields, repository authentication, BI tool mapping,
|
|
or Notion crawl options. Read [Agent Clients](/docs/integrations/agent-clients)
|
|
when you need generated file locations or manual agent configuration.
|