Brief

Parameters and properties

The fields below cover all variants; the signature specifies their allowed combinations.

• textVariant-dependent
  string | undefined
  Literal brief sent to the agent unchanged: no placeholders or commands are expanded.
• fileVariant-dependent
  undefined | string
  Path of a template file, resolved from the process working directory and read before each pass. Its {{NAME}} placeholders are filled and each !`command` fragment is replaced by the command’s stdout, run in the sandbox.
• valuesOptional
  undefined | Readonly<Record<string, string | number | boolean>> | undefined
  Values for the file’s {{NAME}} placeholders, also inserted unquoted into commands. WORK_BRANCH and BASE_BRANCH are reserved; a missing value fails with code prompt and unused values reach warn.

Signature

export type Brief =
  | {
      readonly text: string;
      readonly file?: never;
      readonly values?: never;
    }
  | {
      readonly file: string;
      readonly text?: never;
      readonly values?: PromptVariables;
    };

Related contracts

• PromptVariables