Skip to content

README.md

Latest commit

 

History

History
65 lines (49 loc) · 3.01 KB

README.md

File metadata and controls

65 lines (49 loc) · 3.01 KB
Raw

Koru examples (Docker E2E)

Each runnable sample lives under examples/<category>/<name>/ and ships:

  • README.md — what is being demonstrated and known limits
  • e2e.sh — non-interactive smoke (copied into the image at build time)
  • docker-compose.yml — isolated build (context = koru repo root)
  • run-docker.sh — local wrapper around docker compose build && run

Shared image layers are defined once in examples/docker/koru-e2e.Dockerfile ( python:3.12-slim, editable pip install -e ., plus planfile and uvicorn).

The large flat pipeline sample examples/bootstrap.planfile.yaml stays at its historic path (referenced from CLI help and docs).

These examples are runtime smoke tests, not whole-project discovery passes. They intentionally validate bounded CLI / protocol / server slices inside Docker. For code2llm refreshes, semcod ticket generation, and idle-queue discovery, use the root README section Idle queue discovery with code2llm and the manual discovery commands documented there.

Index

Path One-line purpose
examples/ci/headless-autonomous-jsonl CI-style koru autonomous up with --no-autopilot + NDJSON events
examples/env/autopilot-ide-auto KORU_AUTOPILOT_IDE=auto does not override explicit --autopilot-ide
examples/env/autopilot-ide-cursor KORU_AUTOPILOT_IDE=cursor overrides CLI when CLI uses auto
examples/protocol/autopilot-socket-smoke Autopilot daemon + status + shutdown on a Unix socket (no IDE)
examples/planfile/queue-cli-dryrun koru --queue --dry-run + planfile --version (no HTTP server)
examples/planfile/http-api-curl uvicorn planfile.api.server:app + curl /health (skips if API layout missing)
examples/runtime/koru-serve-health koru serve --no-open + curl /health
examples/nlp2uri-testql-browser nlp2uri NL→URI + TestQL scenarios on TARGET_URL (Docker runs --dry-run; live DOM stays native)

Run all (from repo root)

./examples/run-e2e.sh

This runs every example that ships a run-docker.sh — all of the above. examples/nlp2uri-testql-browser runs its dry-run smoke in Docker; the live DOM / native-browser mode still needs a host with playwright and a display (run its run.sh with DRY_RUN=0 directly).

If docker is not installed, the script exits 0 so optional CI jobs can reuse it without failing non-Docker hosts.

Examples do not mutate your real project backlog. They build an isolated image, run a bounded smoke scenario, and exit. Ticket generation workflows such as koru scan --apply --semcod-artifacts should be run from the real repo root, not inside these Docker E2E samples.

Run one example

./examples/ci/headless-autonomous-jsonl/run-docker.sh

Equivalent manual invocation:

docker compose -f examples/ci/headless-autonomous-jsonl/docker-compose.yml build
docker compose -f examples/ci/headless-autonomous-jsonl/docker-compose.yml run --rm e2e