WorkspaceAgentInterfaceRemote

org.llm4s.shared.WorkspaceAgentInterfaceRemote
See theWorkspaceAgentInterfaceRemote companion object

Remote implementation of WorkspaceAgentInterface that converts method calls to commands, processes them through a handler, and converts responses back to appropriate return types.

Value parameters

handler

A function that processes WorkspaceAgentCommands and returns WorkspaceAgentResponses

Attributes

Companion
object
Graph
Supertypes
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

override def executeCommand(command: String, workingDirectory: Option[String], timeout: Option[Int], environment: Option[Map[String, String]]): ExecuteCommandResponse

Execute a shell command in the workspace.

Execute a shell command in the workspace.

Value parameters

command

Command to execute

environment

Environment variables

timeout

Timeout in milliseconds

workingDirectory

Working directory (default: workspace root)

Attributes

Returns

Response with command execution result

Definition Classes
override def exploreFiles(path: String, recursive: Option[Boolean], excludePatterns: Option[List[String]], maxDepth: Option[Int], returnMetadata: Option[Boolean]): ExploreFilesResponse

List files and directories in a specified path, optionally recursively.

List files and directories in a specified path, optionally recursively.

Value parameters

excludePatterns

Glob patterns to exclude

maxDepth

Maximum recursion depth

path

Path to explore

recursive

Whether to explore recursively

returnMetadata

Whether to include file metadata

Attributes

Returns

Response with list of files and directories

Definition Classes

Retrieve information about the workspace, including default settings and limits.

Retrieve information about the workspace, including default settings and limits.

Attributes

Returns

Response with workspace information

Definition Classes
override def modifyFile(path: String, operations: List[FileOperation]): ModifyFileResponse

Perform targeted modifications to a file without rewriting the entire content.

Perform targeted modifications to a file without rewriting the entire content.

Value parameters

operations

List of operations to perform

path

Path to file

Attributes

Returns

Response with modification result

Definition Classes
override def readFile(path: String, startLine: Option[Int], endLine: Option[Int]): ReadFileResponse

Read the content of a file, with options to read specific line ranges.

Read the content of a file, with options to read specific line ranges.

Value parameters

endLine

Optional end line (1-indexed)

path

Path to file

startLine

Optional start line (1-indexed)

Attributes

Returns

Response with file content and metadata

Definition Classes
override def searchFiles(paths: List[String], query: String, searchType: String, recursive: Option[Boolean], excludePatterns: Option[List[String]], contextLines: Option[Int]): SearchFilesResponse

Search for content in files across the workspace.

Search for content in files across the workspace.

Value parameters

contextLines

Number of context lines to include

excludePatterns

Glob patterns to exclude

paths

Paths to search in

query

Search query

recursive

Whether to search recursively

searchType

Search type ("regex" or "literal")

Attributes

Returns

Response with search results

Definition Classes
override def writeFile(path: String, content: String, mode: Option[String], createDirectories: Option[Boolean]): WriteFileResponse

Write content to a file, creating the file if it doesn't exist.

Write content to a file, creating the file if it doesn't exist.

Value parameters

content

Content to write

createDirectories

Create parent directories if they don't exist

mode

Write mode (default: "overwrite")

path

Path to file

Attributes

Returns

Response with write operation result

Definition Classes