Skip to content

Agents and JSON

Use the build's own command model to discover what it accepts and what it will run.

Inspect before execution

dotnet run --project Build.fsproj -- build --help
dotnet run --project Build.fsproj -- build --schema --json
dotnet run --project Build.fsproj -- build --explain --json

--help describes registered inputs. --schema --json returns the command schema. --explain --json returns a static execution plan without running steps or effectful conditions. Text --explain may evaluate conditions such as a Git branch check.

Consume a run result

dotnet run --project Build.fsproj -- build --json

A JSON run ends with one result document containing the outcome, exit code, reports, failures, and timings. Child processes may still print output before that document.

Detected AI environments default --json to true. Detection happens per invocation. PARTAS_BUILD_DISABLE_AI=true disables that automatic default; explicit --json still works. Use --json false to request text for an individual invocation.

Handle exit codes

  • 0: success, including help and inspection.
  • 1: execution failed.
  • 2: invalid command or input; execution did not start.
  • 130: cancelled.

In an F# host, invoke a reusable root to receive a RunResult directly.

Read these docs as Markdown

The site publishes llms.txt, llms-full.txt, and Markdown copies beside guide pages. Each HTML guide advertises its Markdown URL with an alternate link.

Copy the agent instructions into a consumer repository to document how its build should be inspected.

Edit this page