Learn JSX evaluation
Run basic for deterministic bottom-up evaluation with no model, network, or filesystem effect.
Examples
The examples package is the executable companion to these docs. Each example exports an AML tree; the shared runner creates an AmlRuntime, attaches the console tracer, and evaluates the selected workflow.
Run an example
Section titled “Run an example”From the repository root:
npm run example --npm run example -- reviewnpm run example -- structuredThe first command prints the current filename-derived catalog. Treat that output and examples/run.ts as the source of truth; this page deliberately recommends paths instead of duplicating every filename.
Each maintained example also exports an AML tree, so the experimental CLI can run one source file directly. Build the repository CLI and try the credential-free basic example:
npm run build --workspace=@aml-jsx/clinode apps/cli/dist/index.js run ./examples/src/core/basic.tsxThe shared example runner remains useful for its catalog and common tracer. Use the CLI guide when your own workflow should expose a default or named export without a separate application entry point.
Choose by goal
Section titled “Choose by goal”Run specialists in parallel
Run concurrency to see <Parallel> overlap independent Agents while preserving authored result order.
Validate typed results
Run structured to validate one deterministic <Agent /> result with a Standard Schema before using it later.
Call application Tools
Run programmatic-tool to execute a schema-validated Tool from component code without granting it to an Agent or model.
Build a useful review
Run review for materialized evidence, a real <Skill />, bounded <Include /> content, typed parallel reviewers, application validation, and synthesis. Live Agent providers are an explicit opt-in.
Use disposable execution
Run docker to cross a real container boundary. It uses the Docker daemon and may pull an image; its <Agent /> is deterministic.
Choose a Script directory
Run script to see a portable <Script /> cwd resolve from the active Sandbox root without contacting an external service.
Persist local work
Run workspace-local to write one named file under an OS temporary directory and reuse <Workspace />.
Stop safely from the CLI
Run cli-process-safety.tsx through aml run, interrupt it, and verify that cancellation reaps the tracked local process tree before exit.
Watch a live Agent work
Run observe-agent.tsx with OpenCode to turn Agent spans and captured ACP updates into an ordered activity feed across the initial turn and two FollowUps.
When an example needs infrastructure
Section titled “When an example needs infrastructure”The runner also discovers credentialed Agent examples and resource-backed Sandbox or Workspace examples. List the catalog first, then inspect the selected source before running it.
- Deterministic examples use fixtures from
@aml-jsx/sdk/testing. They demonstrate AML contracts without claiming that a live model behaves identically. - Credentialed examples start a real Agent adapter and can require an executable, model account, network access, and provider-specific environment variables.
- Resource-backed examples use a local directory, Docker daemon, or remote Sandbox. Their source owns the mutation and cleanup notes for that exact workflow.
- Fixture examples model a boundary without contacting the described service. The MCP example, for example, carries descriptor metadata but does not connect to its placeholder URL.
For copyable, task-oriented walkthroughs with prerequisites and expected output, continue to the Cookbook.