Skip to main content

Type Reference

Field names are shown in Go style. Rust uses snake_case, AssemblyScript uses camelCase or snake_case depending on the type.

File System

DirEntry

Returned by fs_ls / FsLs / fsLs.

FieldTypeConditionDescription
NamestringalwaysFile or directory name
Sizeint64alwaysSize in bytes (0 for directories)
IsDirboolalwaysIs a directory
ModTimeint64long=trueUnix timestamp (seconds)
Modeuint32long=truePermission bits
ModeStrstringlong=trueHuman-readable, e.g. "drwxr-xr-x"

TextFileContent

Returned by fs_read_lines / FsReadLines / fsReadLines.

FieldTypeDescription
Lines[]stringLines of text
TotalLinesintTotal lines in file
OffsetintStarting line offset
IsTruncatedboolWhether the result was truncated

GrepFileMatch

Returned by fs_grep / FsGrep / fsGrep.

FieldTypeDescription
PathstringFile path
Matches[]GrepLineMatchMatching lines

GrepLineMatch

FieldTypeDescription
LineNumintLine number (1-based)
LinestringLine content

GlobEntry

Returned by fs_glob / FsGlob / fsGlob.

FieldTypeDescription
PathstringFile path
IsDirboolIs a directory
Sizeint64Size in bytes

HTTP

FieldTypeDescription
NamestringHeader name
ValuestringHeader value
FieldTypeDescription
NamestringCookie name
ValuestringCookie value
DomainstringDomain
PathstringPath
Expiresint64Expiration timestamp
SecureboolSecure flag
HTTPOnlyboolHTTPOnly flag

HttpResponse

FieldTypeSDKDescription
StatusintallHTTP status code
Body[]byteallResponse body
Headers[]HeaderGo, RustResponse headers
Cookies[]CookieGo, RustSet-Cookie values

Shell

ShellExecResult

FieldTypeDescription
OutputstringCombined stdout + stderr
ExitCodeintProcess exit code (0 = success)
PidintProcess ID (daemon mode, Go/AS only)
LogFilestringLog file path (daemon mode, Go/AS only)

TCP

TcpRequestResult

Returned by tcp_request / TcpRequest / tcpRequest.

FieldTypeDescription
Data[]byteResponse data
ErrorstringError message (empty = success)

System

SysInfoResult

FieldTypeDescription
OSstringOperating system (linux, darwin, windows)
ArchstringCPU architecture (amd64, arm64, riscv64)
HostnamestringMachine hostname
NumCPUintNumber of logical CPUs

TimeNowResult

FieldTypeDescription
Unixint64Seconds since Unix epoch
UnixNanoint64Nanoseconds since Unix epoch
RFC3339stringFormatted time string
TimezonestringIANA timezone name

Cluster

ClusterNodeInfo

FieldTypeDescription
NodeIDstringNode identifier
Rolestringmaster or slave
Skills[]stringSkill IDs on the node

Archive

ArchiveEntry

Returned by archive_list / ArchiveList / archiveList.

FieldTypeDescription
NamestringFile path within archive
Sizeint64Uncompressed size in bytes
IsDirboolIs a directory entry