apunkt/ktx
1
0
Fork 0
mirror of https://github.com/Kaelio/ktx.git synced 2026-06-10 08:05:14 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: stop advertising adapter-backed example ingest

Browse source
This commit is contained in:
Andrey Avtomonov 2026-05-13 19:34:36 +02:00
parent aa413501ff
commit 7309fbde94
2 changed files with 16 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

16
examples/README.md
View file

@ -2,19 +2,15 @@
## local-warehouse
`local-warehouse/` is a runnable standalone KTX project for local CLI smoke
testing. It uses the fake ingest adapter and does not require a database or
external app server.
`local-warehouse/` is a contributor fixture for local CLI smoke tests. It uses
the internal fake ingest adapter so tests can exercise memory-flow behavior
without a live database or external service.
Copy it before running commands:
For normal context building, use the public connection-centric commands:
```bash
pnpm --filter @ktx/cli run build
EXAMPLE_DIR="$(mktemp -d)/local-warehouse"
cp -R examples/local-warehouse "$EXAMPLE_DIR"
node packages/cli/dist/bin.js knowledge list --project-dir "$EXAMPLE_DIR"
node packages/cli/dist/bin.js sl list --project-dir "$EXAMPLE_DIR" --connection-id warehouse
node packages/cli/dist/bin.js ingest run --project-dir "$EXAMPLE_DIR" --connection-id warehouse --adapter fake --source-dir "$EXAMPLE_DIR/source"
ktx ingest <connectionId>
ktx ingest --all
```
The copied project initializes its own Git repository on first use.

24
examples/local-warehouse/README.md
View file

@ -1,20 +1,16 @@
# Local Warehouse Example
# local-warehouse fixture
This example is a standalone KTX project that can be copied to a temp directory
and used with the local CLI. It uses the `fake` ingest adapter so it does not
require a database or external app server.
This directory is a contributor fixture for KTX CLI smoke tests. It uses the
internal fake ingest adapter so tests can run without a live database or
external service.
Run the example from the repository root after building the CLI:
Normal users should build context with connection-centric ingest:
```bash
pnpm --filter @ktx/cli run build
EXAMPLE_DIR="$(mktemp -d)/local-warehouse"
cp -R examples/local-warehouse "$EXAMPLE_DIR"
node packages/cli/dist/bin.js knowledge list --project-dir "$EXAMPLE_DIR"
node packages/cli/dist/bin.js sl list --project-dir "$EXAMPLE_DIR" --connection-id warehouse
node packages/cli/dist/bin.js ingest run --project-dir "$EXAMPLE_DIR" --connection-id warehouse --adapter fake --source-dir "$EXAMPLE_DIR/source"
ktx ingest <connectionId>
ktx ingest --all
```
The copied project creates its own Git repository on first use. Keep commands
pointed at a copy when experimenting so the checked-in example fixture stays
unchanged.
The public ingest workflow is documented in
`docs-site/content/docs/cli-reference/ktx-ingest.mdx` and
`docs-site/content/docs/guides/building-context.mdx`.