Class ShellService

Shell service for executing commands

Index

Constructors

Methods

addReadRoot addWriteRoot checkSecurity execute listDirectory readFile readFileBuffer runScript writeFile

Constructors

constructor

new ShellService(config?: ShellConfig): ShellService
Parameters
- config: ShellConfig = {}
Returns ShellService
- Defined in system/cli-executor/src/services/shellService.ts:55

Methods

addReadRoot

addReadRoot(rootPath: string): void
Dynamically grant read access to an additional root directory. Used by the runtime when folder access is approved at the guardrails layer.
Parameters
- rootPath: string
Returns void
- Defined in system/cli-executor/src/services/shellService.ts:69

addWriteRoot

addWriteRoot(rootPath: string): void
Dynamically grant write access to an additional root directory. Used by the runtime when folder access is approved at the guardrails layer.
Parameters
- rootPath: string
Returns void
- Defined in system/cli-executor/src/services/shellService.ts:86

checkSecurity

checkSecurity(command: string): SecurityCheckResult
Check if a command is safe to execute
Parameters
- command: string
Returns SecurityCheckResult
- Defined in system/cli-executor/src/services/shellService.ts:195

execute

execute(
command: string,
options?: { cwd?: string; env?: Record<string, string>; timeout?: number },
): Promise<ExecutionResult>
Execute a shell command
Parameters
- command: string
- Optionaloptions: { cwd?: string; env?: Record<string, string>; timeout?: number }
Returns Promise<ExecutionResult>
- Defined in system/cli-executor/src/services/shellService.ts:278

listDirectory

listDirectory(
dirPath: string,
options?: ListDirectoryOptions,
): Promise<ListDirectoryResult>
List directory contents
Parameters
- dirPath: string
- Optionaloptions: ListDirectoryOptions
Returns Promise<ListDirectoryResult>
- Defined in system/cli-executor/src/services/shellService.ts:482

readFile

readFile(filePath: string, options?: FileReadOptions): Promise<FileReadResult>
Read a file
Parameters
- filePath: string
- Optionaloptions: FileReadOptions
Returns Promise<FileReadResult>
- Defined in system/cli-executor/src/services/shellService.ts:379

readFileBuffer

readFileBuffer(
filePath: string,
): Promise<{ buffer: Buffer; path: string; size: number }>
Read a file as a raw Buffer (for binary document formats). Enforces the same filesystem security policy as readFile.
Parameters
- filePath: string
Returns Promise<{ buffer: Buffer; path: string; size: number }>
- Defined in system/cli-executor/src/services/shellService.ts:427

runScript

runScript(scriptPath: string, options?: ScriptOptions): Promise<ScriptResult>
Run a script file
Parameters
- scriptPath: string
- Optionaloptions: ScriptOptions
Returns Promise<ScriptResult>
- Defined in system/cli-executor/src/services/shellService.ts:340

writeFile

writeFile(
    filePath: string,
    content: string,
    options?: FileWriteOptions,
): Promise<FileWriteResult>
Write to a file
Parameters
- filePath: string
- content: string
- Optionaloptions: FileWriteOptions
Returns Promise<FileWriteResult>
- Defined in system/cli-executor/src/services/shellService.ts:441