Skip to content

LTF Documentation

This folder contains the primary user-facing documentation for LTF: CLI usage, project setup, logging, tags, scenarios, hooks, and more.

Core docs

  • Command-Line Interface (CLI)
    How to use the ltf executable (init, test, target, logs, eval, etc.).

  • Project setup
    Single-target vs multi-target layout, initialization, and how test discovery works.

  • Logging
    Log files, log levels, and how to use ltf logs info.

  • Tag system
    Add tags to tests and filter runs with --tags/-t.

  • Test description
    Add optional description text to tests (single-line or multiline).

  • Test teardown with ltf.defer
    Guaranteed cleanup, LIFO order, and conditional teardown behavior.

  • Test variables
    Register variables, override from CLI, validation rules, and examples.

  • Test secrets
    Register secrets, provide values via .secrets, multiline values, and validation.

  • Test overriding behavior
    How duplicate test names override earlier definitions (especially useful for multi-target).

  • Test scenarios
    Describe a run in JSON (vars/tags/log settings/order) and how include/append/remove works.

  • Hooks
    Register lifecycle hooks and understand the hook context types.

Internal libraries (API reference)

The API docs for built-in Lua libraries live under: