examples/README.md

# Examples

Runnable demos (not workspaces) that showcase how the harness is wired.

## echo-agent

A mock model + echo tool + stdio UI + JSONL persistence demo. Demonstrates:

- Loading plugins from a `cordis.yml` via `@cordisjs/plugin-loader` + `@cordisjs/plugin-include`
- Registering a mock `LlmAdapter` (streaming scripted responses)
- Registering a tool via `ctx.tools.register()`
- Persisting session events to JSONL via the `session/event` + `session/flush` pattern
- A minimal stdio UI consuming `agent/stream-chunk` and session events

Run with: `pnpm run demo:echo`

When prompted, type "echo <something>" to trigger a tool call round-trip.

## coding-agent

The real thing: DeepSeek V4 + the bash tool suite + stdio chat + JSONL persistence, wired from `cordis.yml`. Where echo-agent proves the skeleton with mocks, this is a usable coding assistant.

Run with: `pnpm run demo:coding` (needs `DEEPSEEK_API_KEY` in the environment or a gitignored repo-root `.env`). See [coding-agent/README.md](coding-agent/README.md) for details.
Document the codebase thoroughly and tighten type safety 2026-06-11 12:39:27 +08:00			`# Examples`

			`Runnable demos (not workspaces) that showcase how the harness is wired.`

			`## echo-agent`

			`A mock model + echo tool + stdio UI + JSONL persistence demo. Demonstrates:`

			- Loading plugins from a `cordis.yml` via `@cordisjs/plugin-loader` + `@cordisjs/plugin-include`
			- Registering a mock `LlmAdapter` (streaming scripted responses)
			- Registering a tool via `ctx.tools.register()`
			- Persisting session events to JSONL via the `session/event` + `session/flush` pattern
			- A minimal stdio UI consuming `agent/stream-chunk` and session events

feat: migrate to pnpm 2026-06-16 14:55:37 +08:00			Run with: `pnpm run demo:echo`
Document the codebase thoroughly and tighten type safety 2026-06-11 12:39:27 +08:00
			`When prompted, type "echo <something>" to trigger a tool call round-trip.`
docs: accuracy sweep, architecture restructure, two ADRs, review skill 2026-06-13 18:50:13 +08:00
			`## coding-agent`

			The real thing: DeepSeek V4 + the bash tool suite + stdio chat + JSONL persistence, wired from `cordis.yml`. Where echo-agent proves the skeleton with mocks, this is a usable coding assistant.

feat: migrate to pnpm 2026-06-16 14:55:37 +08:00			Run with: `pnpm run demo:coding` (needs `DEEPSEEK_API_KEY` in the environment or a gitignored repo-root `.env`). See [coding-agent/README.md](coding-agent/README.md) for details.