system

Functions

screenshot

screenshot(filepath: string, x: number, y: number, width: number, height: number)

A tool for taking a screenshot and saving it to a file. Optionally specify x, y, width, and height to capture a specific region.

@param filepath - Path to save the screenshot @param x - X coordinate of capture region @param y - Y coordinate of capture region @param width - Width of capture region @param height - Height of capture region

Parameters:

Name	Type	Default
filepath	string
x	number	-1
y	number	-1
width	number	-1
height	number	-1

Throws: std::screenshot

(source)

exit

exit(code: number)

Terminate the process immediately with the given exit code. Use with caution — this skips any cleanup or pending operations. @param code - Exit code (0 for success, non-zero for failure)

Parameters:

Name	Type	Default
code	number	0

Throws: std::exit

(source)

args

args(): string[]

Return the command-line arguments passed to the Agency program (excluding the node executable and script path).

Returns: string[]

(source)

cwd

cwd(): string

Return the absolute path of the current working directory of the Agency process.

Returns: string

(source)

env

env(name: string): string | null

Read an environment variable. Returns null if the variable is not set.

Parameters:

Name	Type	Default
name	string

Returns: string | null

(source)

setEnv

setEnv(name: string, value: string): Result

Set an environment variable in the current process. Fails if the name is empty or contains '='. The change is visible to child processes spawned afterward but does not persist outside the current process.

@param name - The environment variable name @param value - The value to set

Parameters:

Name	Type	Default
name	string
value	string

Returns: Result

Throws: std::setEnv

(source)

openUrl

openUrl(url: string): Result

Open a URL in the user's default browser. Currently macOS-only.

Parameters:

Name	Type	Default
url	string

Returns: Result

Throws: std::openUrl

(source)