mirror of
https://github.com/Kaelio/ktx.git
synced 2026-06-07 07:55:13 +02:00
b9e0a746af
* feat(cli): clean up dev command surface * test: align CI expectations with CLI cleanup * test(cli): update slow test command expectations
73 lines
3 KiB
Text
73 lines
3 KiB
Text
---
|
|
title: "ktx ingest"
|
|
description: "Run and inspect local ingest memory-flow output."
|
|
---
|
|
|
|
`ktx ingest` runs adapter-level local ingest and renders stored ingest reports.
|
|
|
|
## Command signature
|
|
|
|
```bash
|
|
ktx ingest <subcommand> [options]
|
|
```
|
|
|
|
## Subcommands
|
|
|
|
| Subcommand | Description |
|
|
|-----------|-------------|
|
|
| `run` | Run local ingest for one configured connection and source adapter |
|
|
| `status [runId]` | Print status for the latest or selected stored local ingest run or report file |
|
|
| `watch [runId]` | Open the latest or selected stored ingest visual report |
|
|
| `replay <runId>` | Replay a stored ingest run or bundle report through memory-flow output |
|
|
|
|
## `ingest run`
|
|
|
|
| Flag | Description | Default |
|
|
|------|-------------|---------|
|
|
| `--connection-id <connectionId>` | KTX connection id | Required |
|
|
| `--adapter <adapter>` | Ingest source adapter name | Required |
|
|
| `--source-dir <path>` | Directory containing source files | — |
|
|
| `--database-introspection-url <url>` | Daemon URL for live-database introspection | — |
|
|
| `--debug-llm-request-file <path>` | Write sanitized LLM request structure to a JSONL file | — |
|
|
| `--plain` | Print plain text output | `true` |
|
|
| `--json` | Print JSON output | `false` |
|
|
| `--viz` | Render memory-flow TUI output | `false` |
|
|
| `--yes` | Install the managed Python runtime without prompting when required | `false` |
|
|
| `--no-input` | Disable interactive terminal input for visualization and runtime installation | — |
|
|
|
|
## `ingest status`, `watch`, and `replay`
|
|
|
|
| Flag | Description | Default |
|
|
|------|-------------|---------|
|
|
| `--report-file <path>` | Bundle ingest report JSON file to render | — |
|
|
| `--plain` | Print plain text output | `true` for `status` and `replay` |
|
|
| `--json` | Print JSON output | `false` |
|
|
| `--viz` | Render memory-flow TUI output | `true` for `watch` |
|
|
| `--no-input` | Disable interactive terminal input for visualization | — |
|
|
|
|
## Examples
|
|
|
|
```bash
|
|
ktx ingest run --connection-id my-dbt-source --adapter dbt
|
|
ktx ingest run --connection-id prod-metabase --adapter metabase --yes
|
|
|
|
ktx ingest status
|
|
ktx ingest status run-abc123
|
|
ktx ingest status --json
|
|
|
|
ktx ingest watch
|
|
ktx ingest watch run-abc123
|
|
|
|
ktx ingest replay run-abc123
|
|
ktx ingest replay run-abc123 --viz
|
|
ktx ingest replay run-abc123 --report-file /tmp/ingest-report.json
|
|
```
|
|
|
|
## Common errors
|
|
|
|
| Error | Cause | Recovery |
|
|
|-------|-------|----------|
|
|
| Ingest needs credentials | The source adapter requires API or git access | Configure the referenced environment variable or secret file |
|
|
| Ingest run cannot find adapter | `--adapter` does not match a supported source adapter | Use a configured adapter such as `dbt`, `metabase`, `looker`, `lookml`, `notion`, or `live-database` |
|
|
| Latest run not found | No ingest run has been started in this project | Run `ktx ingest run --connection-id <id> --adapter <adapter>` first |
|
|
| Report watch fails in a non-interactive shell | Visual report needs a terminal | Use `ktx ingest status --json` for agent and CI workflows |
|