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:
| Name | Type | Description |
|---|---|---|
port | number |
Methods
CuaBotClient.for
for(): Promise<Returns: Promise<
CuaBotClient.request
request(): Promise<number | null>Returns: Promise<number | null>
CuaBotClient.status
status(): Promise<Returns: Promise<
CuaBotClient.request
request(): Promise<string>Returns: Promise<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): voidParameters:
| Name | Type | Description |
|---|---|---|
name | `string | null` |
getSessionName
function getSessionName(): string | nullReturns: string | null
isServerRunning
async function isServerRunning(): Promise<Returns: Promise<
ensureServerRunning
async function ensureServerRunning(): Promise<number>Returns: Promise<number>
settings
CuaBot Settings Management
Settings
interface Settings {
defaultAgent?: string;
telemetryEnabled?: boolean;
aliasIgnored?: boolean;
}| Property | Type | Description |
|---|---|---|
defaultAgent | string | (optional) |
telemetryEnabled | boolean | (optional) |
aliasIgnored | boolean | (optional) |
AGENTS
const AGENTS: constloadSettings
function loadSettings(): SettingsReturns: Settings
saveSettings
function saveSettings(settings: Settings): voidParameters:
| Name | Type | Description |
|---|---|---|
settings | Settings |
getDefaultAgent
function getDefaultAgent(): string | undefinedReturns: string | undefined
setDefaultAgent
function setDefaultAgent(agent: string): voidParameters:
| Name | Type | Description |
|---|---|---|
agent | string |
getTelemetryEnabled
function getTelemetryEnabled(): booleanReturns: boolean
isTelemetryConfigured
function isTelemetryConfigured(): booleanReturns: boolean
setTelemetryEnabled
function setTelemetryEnabled(enabled: boolean): voidParameters:
| Name | Type | Description |
|---|---|---|
enabled | boolean |
getAliasIgnored
function getAliasIgnored(): booleanReturns: boolean
setAliasIgnored
function setAliasIgnored(ignored: boolean): voidParameters:
| Name | Type | Description |
|---|---|---|
ignored | boolean |
Was this page helpful?