Search documentation

Search the Fumadocs-backed documentation index.

Setup checks

Preflight checks that fail a variant fast, before the agent burns tokens.

setup_checks verify that setup produced a usable sandbox before the agent starts. A failed setup check stops that variant before any agent work happens. Setup checks receive resolved environment_variables, AX_VARIANT_ID, and AX_RUN_CONTEXT_PATH; they do not receive trace or agent-log paths because the agent has not run yet.

setup_checks:
  - name: cli-on-path
    script: my-cli --version

Setup check object

FieldRequiredType / valuesNotes
nameYesKebab-case stringAppears in setup-checks/<name>.json.
scriptYesStringBash check streamed over stdin and hidden from the agent. A non-zero exit aborts the variant before the agent runs.