Skip to main content

Client Tools Cheat Sheet

Use this page as a quick lookup for TeaQL client tooling. Exact flags may differ by version, so prefer the command help output for final verification before automating a new pipeline.

Cargo CLI​

Typical Rust workflow:

cargo teaql --help
cargo teaql generate
cargo teaql eval

Use the Cargo CLI when you need to:

  • Generate a Rust workspace from a TeaQL model.
  • Evaluate a modeling or coding task.
  • Produce Markdown diagnostics when generation fails.
  • Exercise provider-backed examples in a Rust project.

When a command fails, read the Markdown report before editing code.

Maven Plugin​

Typical Java workflow:

mvn teaql:help
mvn teaql:generate
mvn teaql:eval

Use the Maven plugin when you need to:

  • Generate Java packages from a TeaQL model.
  • Integrate generated APIs into a Spring Boot project.
  • Run evaluation or generation commands in a Java build.
  • Capture Markdown diagnostics in CI output.

CI Guidance​

For CI pipelines:

  • Run generation before compile/test.
  • Treat generation errors as build failures.
  • Preserve Markdown error reports as CI artifacts.
  • Keep model changes and generated API usage in the same review.
  • Do not manually patch generated files to make CI pass.

Error Handling​

Common failures:

SymptomAction
Missing generated methodRead generated source and use the exact method name.
Missing query intentAdd comment and purpose before execution.
Missing audit metadataAdd audit_as / auditAs before save or update.
Invalid KSMLFix the model, then regenerate.
Depth exceededReduce nested references or use a scalar field.