Class DevboxFileOps

File operations for a devbox. Provides methods for reading, writing, uploading, and downloading files.

Index

Methods

read write download upload

Methods

read

read(
params: DevboxReadFileContentsParams,
options?: RequestOptions<unknown>,
): Promise<string>
Read file contents from the devbox as a UTF-8 string.
Parameters
- params: DevboxReadFileContentsParams
  Parameters containing the file path
- Optionaloptions: RequestOptions<unknown>
  Request options
Returns Promise<string>
File contents as a string
Example
```
const content = await devbox.file.read({ path: '/app/config.json' });
const config = JSON.parse(content);
```
- Defined in src/sdk/devbox.ts:420

write

write(
params: DevboxWriteFileContentsParams,
options?: RequestOptions<unknown>,
): Promise<DevboxExecutionDetailView>
Write UTF-8 string contents to a file on the devbox.
Parameters
- params: DevboxWriteFileContentsParams
  Parameters containing the file path and contents
- Optionaloptions: RequestOptions<unknown>
  Request options
Returns Promise<DevboxExecutionDetailView>
Execution result
Example
```
await devbox.file.write({
  path: '/app/config.json',
  contents: JSON.stringify({ key: 'value' }, null, 2),
});
```
- Defined in src/sdk/devbox.ts:439

download

download(
params: DevboxDownloadFileParams,
options?: RequestOptions<unknown>,
): Promise<Response>
Download file contents (supports binary files).
Parameters
- params: DevboxDownloadFileParams
  Parameters containing the file path
- Optionaloptions: RequestOptions<unknown>
  Request options
Returns Promise<Response>
Download file response
Example
```
const response = await devbox.file.download({ path: '/app/data.bin' });
const blob = await response.blob();
// Process binary data...
```
- Defined in src/sdk/devbox.ts:457

upload

upload(
params: DevboxUploadFileParams,
options?: RequestOptions<unknown>,
): Promise<unknown>
Upload a file to the devbox.
Parameters
- params: DevboxUploadFileParams
  Parameters containing the file path and file to upload
- Optionaloptions: RequestOptions<unknown>
  Request options
Returns Promise<unknown>
Upload result
Example
```
const file = new File(['content'], 'data.txt');
await devbox.file.upload({
  path: '/app/data.txt',
  file: file,
});
```
- Defined in src/sdk/devbox.ts:477