SessionOptions

works.iterative.claude.core.model.SessionOptions
See theSessionOptions companion object
case class SessionOptions(cwd: Option[String] = ..., executable: Option[String] = ..., executableArgs: Option[List[String]] = ..., pathToClaudeCodeExecutable: Option[String] = ..., maxTurns: Option[Int] = ..., allowedTools: Option[List[String]] = ..., disallowedTools: Option[List[String]] = ..., systemPrompt: Option[String] = ..., appendSystemPrompt: Option[String] = ..., mcpTools: Option[List[String]] = ..., permissionMode: Option[PermissionMode] = ..., continueConversation: Option[Boolean] = ..., resume: Option[String] = ..., model: Option[String] = ..., maxThinkingTokens: Option[Int] = ..., timeout: Option[FiniteDuration] = ..., inheritEnvironment: Option[Boolean] = ..., environmentVariables: Option[Map[String, String]] = ..., strictMcpConfig: Option[Boolean] = ..., mcpConfigPath: Option[String] = ..., settingSources: List[String] = ...)

Configuration options for a Claude Code streaming session.

Contains all fields from QueryOptions except prompt, which is sent per-turn during the session. Fields that are process-level configuration (timeout, inheritEnvironment, environmentVariables, executable, executableArgs, pathToClaudeCodeExecutable) are consumed by the session runner and not translated to CLI flags.

Attributes

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def withAllowedTools(tools: List[String]): SessionOptions
def withAppendSystemPrompt(prompt: String): SessionOptions
def withContinueConversation(continue: Boolean): SessionOptions
def withCwd(cwd: String): SessionOptions
def withDisallowedTools(tools: List[String]): SessionOptions
def withEnvironmentVariables(vars: Map[String, String]): SessionOptions
def withExecutable(executable: String): SessionOptions
def withExecutableArgs(args: List[String]): SessionOptions
def withInheritEnvironment(inherit: Boolean): SessionOptions
def withMaxTurns(turns: Int): SessionOptions
def withMcpConfigPath(path: String): SessionOptions
def withMcpTools(tools: List[String]): SessionOptions
def withModel(model: String): SessionOptions
def withResume(sessionId: String): SessionOptions
def withSettingSources(sources: List[String]): SessionOptions
def withStrictMcpConfig(flag: Boolean): SessionOptions
def withSystemPrompt(prompt: String): SessionOptions
def withTimeout(timeout: FiniteDuration): SessionOptions

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product