--- title: "FileSystem" hideTitleOnPage: true --- ## FileSystem Provides file system operations within a Sandbox. ### Constructors #### new FileSystem() ```ts new FileSystem( clientConfig: Configuration, apiClient: FileSystemApi, ensureToolboxUrl: () => Promise): FileSystem ``` **Parameters**: - `clientConfig` _Configuration_ - `apiClient` _FileSystemApi_ - `ensureToolboxUrl` _ =\> Promise\_ **Returns**: - `FileSystem` ### Methods #### createFolder() ```ts createFolder(path: string, mode: string): Promise ``` Create a new directory in the Sandbox with specified permissions. **Parameters**: - `path` _string_ - Path where the directory should be created. Relative paths are resolved based on the sandbox working directory. - `mode` _string_ - Directory permissions in octal format (e.g. "755") **Returns**: - `Promise` **Example:** ```ts // Create a directory with standard permissions await fs.createFolder('app/data', '755'); ``` *** #### deleteFile() ```ts deleteFile(path: string, recursive?: boolean): Promise ``` Deletes a file or directory from the Sandbox. **Parameters**: - `path` _string_ - Path to the file or directory to delete. Relative paths are resolved based on the sandbox working directory. - `recursive?` _boolean_ - If the file is a directory, this must be true to delete it. **Returns**: - `Promise` **Example:** ```ts // Delete a file await fs.deleteFile('app/temp.log'); ``` *** #### downloadFile() ##### Call Signature ```ts downloadFile(remotePath: string, timeout?: number): Promise> ``` Downloads a file from the Sandbox. This method loads the entire file into memory, so it is not recommended for downloading large files. **Parameters**: - `remotePath` _string_ - Path to the file to download. Relative paths are resolved based on the sandbox working directory. - `timeout?` _number_ - Timeout for the download operation in seconds. 0 means no timeout. Default is 30 minutes. **Returns**: - `Promise>` - The file contents as a Buffer. **Example:** ```ts // Download and process a file const fileBuffer = await fs.downloadFile('tmp/data.json'); console.log('File content:', fileBuffer.toString()); ``` ##### Call Signature ```ts downloadFile( remotePath: string, localPath: string, timeout?: number): Promise ``` Downloads a file from the Sandbox and saves it to a local file. This method uses streaming to download the file, so it is recommended for downloading larger files. **Parameters**: - `remotePath` _string_ - Path to the file to download in the Sandbox. Relative paths are resolved based on the sandbox working directory. - `localPath` _string_ - Path to save the downloaded file. - `timeout?` _number_ - Timeout for the download operation in seconds. 0 means no timeout. Default is 30 minutes. **Returns**: - `Promise` **Example:** ```ts // Download and save a file await fs.downloadFile('tmp/data.json', 'local_file.json'); ``` *** #### downloadFiles() ```ts downloadFiles(files: FileDownloadRequest[], timeoutSec?: number): Promise ``` Downloads multiple files from the Sandbox. If the files already exist locally, they will be overwritten. **Parameters**: - `files` _FileDownloadRequest\[\]_ - Array of file download requests. - `timeoutSec?` _number = ..._ - Timeout for the download operation in seconds. 0 means no timeout. Default is 30 minutes. **Returns**: - `Promise` - Array of download results. **Throws**: If the request itself fails (network issues, invalid request/response, etc.). Individual file download errors are returned in the `FileDownloadResponse.error` field. **Example:** ```ts // Download multiple files const results = await fs.downloadFiles([ { source: 'tmp/data.json' }, { source: 'tmp/config.json', destination: 'local_config.json' } ]); results.forEach(result => { if (result.error) { console.error(`Error downloading ${result.source}: ${result.error}`); } else if (result.result) { console.log(`Downloaded ${result.source} to ${result.result}`); } }); ``` *** #### findFiles() ```ts findFiles(path: string, pattern: string): Promise ``` Searches for text patterns within files in the Sandbox. **Parameters**: - `path` _string_ - Directory to search in. Relative paths are resolved based on the sandbox working directory. - `pattern` _string_ - Search pattern **Returns**: - `Promise` - Array of matches with file and line information **Example:** ```ts // Find all TODO comments in TypeScript files const matches = await fs.findFiles('app/src', 'TODO:'); matches.forEach(match => { console.log(`${match.file}:${match.line}: ${match.content}`); }); ``` *** #### getFileDetails() ```ts getFileDetails(path: string): Promise ``` Retrieves detailed information about a file or directory. **Parameters**: - `path` _string_ - Path to the file or directory. Relative paths are resolved based on the sandbox working directory. **Returns**: - `Promise` - Detailed file information including size, permissions, modification time **Example:** ```ts // Get file details const info = await fs.getFileDetails('app/config.json'); console.log(`Size: ${info.size}, Modified: ${info.modTime}`); ``` *** #### listFiles() ```ts listFiles(path: string): Promise ``` Lists contents of a directory in the Sandbox. **Parameters**: - `path` _string_ - Directory path to list. Relative paths are resolved based on the sandbox working directory. **Returns**: - `Promise` - Array of file and directory information **Example:** ```ts // List directory contents const files = await fs.listFiles('app/src'); files.forEach(file => { console.log(`${file.name} (${file.size} bytes)`); }); ``` *** #### moveFiles() ```ts moveFiles(source: string, destination: string): Promise ``` Moves or renames a file or directory. **Parameters**: - `source` _string_ - Source path. Relative paths are resolved based on the sandbox working directory. - `destination` _string_ - Destination path. Relative paths are resolved based on the sandbox working directory. **Returns**: - `Promise` **Example:** ```ts // Move a file to a new location await fs.moveFiles('app/temp/data.json', 'app/data/data.json'); ``` *** #### replaceInFiles() ```ts replaceInFiles( files: string[], pattern: string, newValue: string): Promise ``` Replaces text content in multiple files. **Parameters**: - `files` _string\[\]_ - Array of file paths to process. Relative paths are resolved based on the sandbox working directory. - `pattern` _string_ - Pattern to replace - `newValue` _string_ - Replacement text **Returns**: - `Promise` - Results of the replace operation for each file **Example:** ```ts // Update version number across multiple files const results = await fs.replaceInFiles( ['app/package.json', 'app/version.ts'], '"version": "1.0.0"', '"version": "1.1.0"' ); ``` *** #### searchFiles() ```ts searchFiles(path: string, pattern: string): Promise ``` Searches for files and directories by name pattern in the Sandbox. **Parameters**: - `path` _string_ - Directory to search in. Relative paths are resolved based on the sandbox working directory. - `pattern` _string_ - File name pattern (supports globs) **Returns**: - `Promise` - Search results with matching files **Example:** ```ts // Find all TypeScript files const result = await fs.searchFiles('app', '*.ts'); result.files.forEach(file => console.log(file)); ``` *** #### setFilePermissions() ```ts setFilePermissions(path: string, permissions: FilePermissionsParams): Promise ``` Sets permissions and ownership for a file or directory. **Parameters**: - `path` _string_ - Path to the file or directory. Relative paths are resolved based on the sandbox working directory. - `permissions` _FilePermissionsParams_ - Permission settings **Returns**: - `Promise` **Example:** ```ts // Set file permissions and ownership await fs.setFilePermissions('app/script.sh', { owner: 'daytona', group: 'users', mode: '755' // Execute permission for shell script }); ``` *** #### uploadFile() ##### Call Signature ```ts uploadFile( file: Buffer, remotePath: string, timeout?: number): Promise ``` Uploads a file to the Sandbox. This method loads the entire file into memory, so it is not recommended for uploading large files. **Parameters**: - `file` _Buffer_ - Buffer of the file to upload. - `remotePath` _string_ - Destination path in the Sandbox. Relative paths are resolved based on the sandbox working directory. - `timeout?` _number_ - Timeout for the upload operation in seconds. 0 means no timeout. Default is 30 minutes. **Returns**: - `Promise` **Example:** ```ts // Upload a configuration file await fs.uploadFile(Buffer.from('{"setting": "value"}'), 'tmp/config.json'); ``` ##### Call Signature ```ts uploadFile( localPath: string, remotePath: string, timeout?: number): Promise ``` Uploads a file from the local file system to the Sandbox. This method uses streaming to upload the file, so it is recommended for uploading larger files. **Parameters**: - `localPath` _string_ - Path to the local file to upload. - `remotePath` _string_ - Destination path in the Sandbox. Relative paths are resolved based on the sandbox working directory. - `timeout?` _number_ - Timeout for the upload operation in seconds. 0 means no timeout. Default is 30 minutes. **Returns**: - `Promise` **Example:** ```ts // Upload a local file await fs.uploadFile('local_file.txt', 'tmp/file.txt'); ``` *** #### uploadFiles() ```ts uploadFiles(files: FileUpload[], timeout?: number): Promise ``` Uploads multiple files to the Sandbox. If files already exist at the destination paths, they will be overwritten. **Parameters**: - `files` _FileUpload\[\]_ - Array of files to upload. - `timeout?` _number = ..._ - Timeout for the upload operation in seconds. 0 means no timeout. Default is 30 minutes. **Returns**: - `Promise` **Example:** ```ts // Upload multiple text files const files = [ { source: Buffer.from('Content of file 1'), destination: '/tmp/file1.txt' }, { source: 'app/data/file2.txt', destination: '/tmp/file2.txt' }, { source: Buffer.from('{"key": "value"}'), destination: '/tmp/config.json' } ]; await fs.uploadFiles(files); ``` *** ## DownloadMetadata Represents metadata for a file download operation. **Properties**: - `destination?` _string_ - Destination path in the local filesystem where the file content will be streamed to. - `error?` _string_ - Error message if the download failed, undefined if successful. - `result?` _string \| Buffer\ \| Uint8Array\_ - The download result - file path (if destination provided in the request) or bytes content (if no destination in the request), undefined if failed or no data received. ## FileDownloadRequest Represents a request to download a single file from the Sandbox. **Properties**: - `destination?` _string_ - Destination path in the local filesystem where the file content will be streamed to. If not provided, the file will be downloaded in the bytes buffer (might cause memory issues if the file is large). - `source` _string_ - Source path in the Sandbox. Relative paths are resolved based on the user's root directory. ## FileDownloadResponse Represents the response to a single file download request. **Properties**: - `error?` _string_ - Error message if the download failed, undefined if successful. - `result?` _string \| Buffer\_ - The download result - file path (if destination provided in the request) or bytes content (if no destination in the request), undefined if failed or no data received. - `source` _string_ - The original source path requested for download. ## FilePermissionsParams Parameters for setting file permissions in the Sandbox. **Properties**: - `group?` _string_ - Group owner of the file - `mode?` _string_ - File mode/permissions in octal format (e.g. "644") - `owner?` _string_ - User owner of the file **Example:** ```ts const permissions: FilePermissionsParams = { mode: '644', owner: 'daytona', group: 'users' }; ``` ## FileUpload Represents a file to be uploaded to the Sandbox. **Properties**: - `destination` _string_ - Absolute destination path in the Sandbox. Relative paths are resolved based on the sandbox working directory. - `source` _string \| Buffer\_ - File to upload. If a Buffer, it is interpreted as the file content which is loaded into memory. Make sure it fits into memory, otherwise use the local file path which content will be streamed to the Sandbox.

file-system