Cua-Bot

API Reference

TypeScript API reference for the Cua-Bot sandboxed agent framework

v1.0.13npm install -g cuabot

client

CuaBot Server Client Connects to the CuaBot server via HTTP

CuaBotClient

Constructor

new CuaBotClient(port: number)

Parameters:

NameTypeDescription
portnumber

Methods

CuaBotClient.for
for(): Promise<

Returns: Promise&lt;

CuaBotClient.request
request(): Promise<number | null>

Returns: Promise&lt;number | null>

CuaBotClient.status
status(): Promise<

Returns: Promise&lt;

CuaBotClient.request
request(): Promise<string>

Returns: Promise&lt;string>

CuaBotClient.request
request(): Promise<void>
CuaBotClient.request
request(): Promise<void>
CuaBotClient.request
request(): Promise<void>
CuaBotClient.request
request(): Promise<void>
CuaBotClient.request
request(): Promise<void>
CuaBotClient.request
request(): Promise<void>
CuaBotClient.request
request(): Promise<void>
CuaBotClient.request
request(): Promise<void>
CuaBotClient.request
request(): Promise<void>
CuaBotClient.request
request(): Promise<void>
CuaBotClient.request
request(): Promise<void>

setSessionName

function setSessionName(name: string | null): void

Parameters:

NameTypeDescription
name`stringnull`

getSessionName

function getSessionName(): string | null

Returns: string | null

isServerRunning

async function isServerRunning(): Promise<

Returns: Promise&lt;

ensureServerRunning

async function ensureServerRunning(): Promise<number>

Returns: Promise&lt;number>


settings

CuaBot Settings Management

Settings

interface Settings {
  defaultAgent?: string;
  telemetryEnabled?: boolean;
  aliasIgnored?: boolean;
}
PropertyTypeDescription
defaultAgentstring(optional)
telemetryEnabledboolean(optional)
aliasIgnoredboolean(optional)

AGENTS

const AGENTS: const

loadSettings

function loadSettings(): Settings

Returns: Settings

saveSettings

function saveSettings(settings: Settings): void

Parameters:

NameTypeDescription
settingsSettings

getDefaultAgent

function getDefaultAgent(): string | undefined

Returns: string | undefined

setDefaultAgent

function setDefaultAgent(agent: string): void

Parameters:

NameTypeDescription
agentstring

getTelemetryEnabled

function getTelemetryEnabled(): boolean

Returns: boolean

isTelemetryConfigured

function isTelemetryConfigured(): boolean

Returns: boolean

setTelemetryEnabled

function setTelemetryEnabled(enabled: boolean): void

Parameters:

NameTypeDescription
enabledboolean

getAliasIgnored

function getAliasIgnored(): boolean

Returns: boolean

setAliasIgnored

function setAliasIgnored(ignored: boolean): void

Parameters:

NameTypeDescription
ignoredboolean

Was this page helpful?