Embabel Agent Documentation/com.embabel.agent.tools.file/FileTools

FileTools

interface FileTools : FileReadTools, FileWriteTools

Read and Write file tools. Extend FileReadTools for safe read only use

Types

object Companion

Properties

fileContentTransformers

abstract val fileContentTransformers: List<StringTransformer>

Provide sanitizers that run on file content before returning it. They must be sure not to change any content that may need to be replaced as this will break editing if editing is done in the same session.

abstract val root: String

Root on host machine

open override val toolCallbacks: List<<Error class: unknown class>>

Tool callbacks referenced or exposed.

Functions

open fun appendFile(path: String, content: String): String

open fun appendToFile(path: String, content: String, createIfNotExists: Boolean)

Append content to a file, creating it if it doesn't exist. If create is true, the file will be created if it doesn't exist. If createIfNotExists is false, an exception will be thrown if the file doesn't exist.

fun <T> ToolCallbackPublisher.asInterface(intf: Class<T>): T

Expose the ToolGroup as an interface

createDirectory

open fun createDirectory(path: String): String

open fun createFile(path: String, content: String): String

Create a file at the relative path under the root

open fun createFile(path: String, content: String, overwrite: Boolean): Path

Create a file with the given content.

open fun delete(path: String): String

open fun editFile(path: String, oldContent: String, newContent: String): String

open fun exists(): Boolean

Does this file exist?

open fun fileCount(): Int

Count the total number of files in the repository (excluding .git directory). Uses FileVisitor for cross-platform compatibility (Windows and Linux).

open fun findFiles(glob: String): List<String>

open fun findFiles(glob: String, findHighest: Boolean): List<String>

Find files using glob patterns.

abstract fun flushChanges()

abstract fun flushReads()

abstract fun getChanges(): List<FileModification>

getPathsAccessed

open override fun getPathsAccessed(): List<String>

open fun getPathsRead(): List<String>

abstract fun getReads(): List<FileReads>

open fun listFiles(path: String): List<String>

open fun readFile(path: String): String

abstract fun recordChange(c: FileModification)

abstract fun recordRead(path: String)

resolveAndValidateFile

open fun resolveAndValidateFile(path: String): Path

open fun resolvePath(path: String): Path

open fun safeReadFile(path: String): String?

Use for safe reading of files. Returns null if the file doesn't exist or is not readable.