1.7 KiB
AGENTS.md — Examples
Runnable harness compositions. Examples are NOT workspaces: their private package.json files are dependency-free stubs, and the cordis Loader boots each cordis.yml unbuilt through tsx plus the root tsconfig paths.
Extract reusable logic into packages/, where per-file coverage and README gates apply. Examples keep only cordis.yml wiring, demo artifacts, and e2e/snapshot scenarios; app package bins own boot glue.
E2E smokes
Each example has both:
- Keyless: boot the real
cordis.ymlthrough the Loader, drive it, and assert output and clean exit. Catches Loader/export-shape failures hand-mounted tests miss (postmortem). - With-key: send a live-model prompt and verify external state, not the model's claim. Self-skip without
DEEPSEEK_API_KEY; see testing.md.
Mock-only examples require only the keyless tier; state that exception in the test.
Keyless stdio smokes use @deepseek-ai/dsh-loader-smoke for isolation, root-tsconfig loading, subprocess lifecycle, diagnostics, EOF, and cleanup; tests supply paths, environment, input, and assertions.
Do not inventory example tests here; the tests/ trees and root scripts are authoritative.
In cordis.yml, comment only non-obvious wiring, load-order consequences, replay, security boundaries, and configuration scope. Do not narrate visible entries; use dsh-prose-standard for required coverage and editorial judgment.
See the root AGENTS.md for repo-wide conventions and docs/architecture.md for the design.