ExploreOptions
Namespace: E2E
public sealed class ExploreOptionsWhat CancellationToken) explores, as, and with.
Inheritance: object
Properties
Section titled “Properties”public string? Agent { get; init; }The agent (agents.<name>) the exploration runs as. Defaults to default.
Value: string
Agents
Section titled “Agents”public IReadOnlyDictionary<string, AgentOptions>? Agents { get; init; }Agents given in code, by name, replacing the config’s entry of the same name. Upstream’s config file is code, so its agents carry
models and tools; e2e.config.json names a provider and a model id only, so a model of your own or a project tool is set here.
Value: IReadOnlyDictionary<string, AgentOptions>
AiTrace
Section titled “AiTrace”public bool AiTrace { get; init; }Upstream’s --ai-trace: records every model call to ai-trace-<process id>.json next to the results directory
(.e2e by default). E2E_AI_TRACE=1 turns it on too.
Value: bool
ConfigPath
Section titled “ConfigPath”public string? ConfigPath { get; init; }The config file, instead of the nearest e2e.config.json above Cwd.
Value: string
Credentials
Section titled “Credentials”public IReadOnlyDictionary<string, UserCredential>? Credentials { get; init; }The accounts the explorer can sign in with, by name. Each travels into every step as the username and a password secret
named <name>.password, which the explorer fills with fill_secret; the password never reaches a model.
Upstream reads them from the config’s credentials, which the port rejects; User(string) reads one from the environment.
Value: IReadOnlyDictionary<string, UserCredential>
public string? Cwd { get; init; }Where the config is looked for, and the project root when RawConfig is set. Defaults to the working directory.
Value: string
public bool Debug { get; init; }Upstream’s --debug: prints the phase timings and the agent step table to stderr. E2E_DEBUG=1 turns it on too.
Value: bool
Engine
Section titled “Engine”public IEngine? Engine { get; init; }The engine to drive. Defaults to the engine of the target’s platform: a WebEngine for web.
Value: IEngine
public string? Goal { get; init; }What to explore for. Blank is DefaultGoal. At most MaxGoalChars characters once its secret values are redacted.
Value: string
Headed
Section titled “Headed”public bool Headed { get; init; }Shows the browser window. Has no effect on an Engine of your own.
Value: bool
MaxSteps
Section titled “MaxSteps”public int? MaxSteps { get; init; }Exploration steps, StepBounds.
Value: int?
Notice
Section titled “Notice”public Action<string>? Notice { get; init; }Notices decided before the run starts: the agent chosen, a replaced executor.
Value: Action<string>
OnProgress
Section titled “OnProgress”public ExploreListener? OnProgress { get; init; }Receives the exploration’s progress as it happens. Upstream’s onEvent sink for the explore run events.
Value: ExploreListener
Output
Section titled “Output”public string? Output { get; init; }The results directory, over the default .e2e/results under the project root. Finding screenshots are kept under it.
Value: string
RawConfig
Section titled “RawConfig”public E2EConfig? RawConfig { get; init; }A config value instead of a discovered file, for a host that builds one in code. Cwd is the project root then.
Value: E2EConfig
Target
Section titled “Target”public string? Target { get; init; }The target to explore. The config declares one; a name that is not it is UNKNOWN_TARGET.
Value: string
Timeout
Section titled “Timeout”public TimeSpan? Timeout { get; init; }The run’s wall clock, TimeoutBounds.
Value: TimeSpan?
public RecordingMode? Trace { get; init; }Which attempts keep a trace page, upstream’s --trace [mode]; over the target’s and the config’s trace. The exploration is
one attempt, so a retry mode keeps none. Defaults to the target’s mode, retain-on-failure unless the config says otherwise.
An exploration’s own verdict, the issues its findings tell, gets no page.
Value: RecordingMode?
public RecordingMode? Video { get; init; }Which attempts record a video, upstream’s --video [mode]; over the target’s and the config’s video. The exploration is
one attempt, so a retry mode records none. Defaults to the target’s mode, off unless the config says otherwise.
Value: RecordingMode?