Class Execution

Execution object for tracking async command execution with streaming support.

Remarks

Overview

The Execution class represents an asynchronous command execution on a devbox. It provides methods to track the execution state, wait for completion, and control the execution (e.g., kill it if needed).

Quickstart

Executions are typically created via devbox.cmd.execAsync():

import { RunloopSDK } from '@runloop/api-client-ts';

const runloop = new RunloopSDK();
const devbox = runloop.devbox.fromId('devbox-123');

// Start async execution with streaming
const execution = await devbox.cmd.execAsync('npx http-server -p 8080', {
  stdout: (line) => console.log(`[LOG] ${line}`),
  stderr: (line) => console.error(`[ERROR] ${line}`),
});

// Do other work while command runs...

// End the process early
const excution.kill();

Index

Accessors

executionId devboxId

Methods

sendStdIn closeStdIn result getState kill

Accessors

executionId

get executionId(): string
Get the execution ID.

Returns string
- Defined in src/sdk/execution.ts:211

devboxId

get devboxId(): string
Get the devbox ID.

Returns string
- Defined in src/sdk/execution.ts:218

Methods

sendStdIn

sendStdIn(input: string, options?: RequestOptions<unknown>): Promise<void>
Send nonempty input to the execution's stdin. Start it with attach_stdin: true. Await each send before the next send or closeStdIn(). Concurrent requests are not ordered. The generated client's retry policy is preserved: a retry after an ambiguous connection failure can replay input; delivery is not exactly once.
Parameters
- input: string
  The text to write to stdin
- Optionaloptions: RequestOptions<unknown>
  Request options
Returns Promise<void>
Promise that resolves once the input has been delivered
Example
```
const execution = await devbox.cmd.execAsync('cat', { attach_stdin: true });
await execution.sendStdIn('Hello from stdin!\n');
await execution.closeStdIn();
const result = await execution.result();
```
Throws
If the API reports that the input was not delivered
- Defined in src/sdk/execution.ts:88

closeStdIn

closeStdIn(options?: RequestOptions<unknown>): Promise<void>
Close the execution's stdin by sending EOF, so commands that read until end of input can finish.
Parameters
- Optionaloptions: RequestOptions<unknown>
  Request options
Returns Promise<void>
Promise that resolves once EOF has been delivered

Throws
If the API reports that EOF was not delivered
- Defined in src/sdk/execution.ts:99

result

result(
options?: LongPollRequestOptions<DevboxAsyncExecutionDetailView>,
): Promise<RunloopSDK.Devbox.ExecutionResult>
Wait for the execution to complete and return the result. If streaming callbacks were provided, also waits for all streams to finish.
Parameters
- Optionaloptions: LongPollRequestOptions<DevboxAsyncExecutionDetailView>
  Request options with optional long-poll configuration
Returns Promise<RunloopSDK.Devbox.ExecutionResult>
ExecutionResult with stdout, stderr, and exit code
Example
```
const runloop = new RunloopSDK();
const devbox = runloop.devbox.fromId('devbox-123');
const execution = await devbox.cmd.execAsync('npm install');

// Other work while command runs...

const result = await execution.result();

if (result.success) {
  console.log('Installation successful!');
  console.log(await result.stdout());
} else {
  console.error('Installation failed:', await result.stderr());
}
```
- Defined in src/sdk/execution.ts:143

getState

getState(
options?: RequestOptions<unknown>,
): Promise<DevboxAsyncExecutionDetailView>
Get the current state of the execution.
Parameters
- Optionaloptions: RequestOptions<unknown>
Returns Promise<DevboxAsyncExecutionDetailView>
Example
```
const execution = await devbox.cmd.execAsync('npx http-server -p 8080');
const state = await execution.getState();
console.log(`Status: ${state.status}`);
```
- Defined in src/sdk/execution.ts:194

kill

kill(options?: RequestOptions<unknown>): Promise<void>
Kill the execution if it's still running.
Parameters
- Optionaloptions: RequestOptions<unknown>
  Request options
Returns Promise<void>
Promise that resolves when the execution is killed
- Defined in src/sdk/execution.ts:204

Class Execution

Remarks

Overview

Quickstart

Index

Accessors

Methods

Accessors

executionId

Returns string

devboxId

Returns string

Methods

sendStdIn

Parameters

Returns Promise<void>

Example

Throws

closeStdIn

Parameters

Returns Promise<void>

Throws

result

Parameters

Returns Promise<RunloopSDK.Devbox.ExecutionResult>

Example

getState

Parameters

Returns Promise<DevboxAsyncExecutionDetailView>

Example

kill

Parameters

Returns Promise<void>

Settings

On This Page