Skip to content
Uncage
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Select language
English
简体中文
日本語
Menu
Start here
How it works
Choose a deployment mode
Quickstart: Connected Mode
Quickstart: Local Mode
Try the demo
Install on your computer
For coding agents
Deploy
Node (traditional mode)
Next.js on Vercel (FaaS mode)
Cloudflare Workers (FaaS mode)
Other Fetch platforms (FaaS mode)
Concepts
Concepts
Trust model
Glossary
Guides
Mount the hub
Auth and device approval
React Native apps
Authenticate apps
Push notifications
Browser extensions
One agent, every site
Define tools
Write skills
Choose tools and skills per run
Site storage
Multi-node (Postgres, Redis)
Custom UI with hooks
Local policy and the user's computer
Use any ACP agent
Contributing, CI and releases
Reference
CLI reference
Local Mode in depth
HTTP API
Error codes
Security
Troubleshooting
Migrate from 0.2
Changelog
API (generated)
@uncage/hub
hub
Interfaces
ActiveRunRecord
AttachmentRecord
ClusterAdapter
DeviceCodeRecord
ExpoPushNotifierOptions
FilePull
Hub
HubLogger
HubOptions
HubStore
HubUser
InstallScriptExtension
InstallScriptOptions
MachineRecord
MaintenanceReport
OutboxItem
PgClientLike
PgPoolLike
PostgresClusterOptions
PulledFile
RedisLike
ReplicaSnapshot
SessionRecord
SiteTool
SkippedFile
SqlClient
SqlQueryable
ToolCallRecord
ToolCallRequest
ToolContext
Type Aliases
AttentionEvent
CreatedHub
DeviceCodeStatus
InstallLocale
InstallMessageKey
LinkState
OnAttention
ResourceKind
RouteHandler
SessionPatch
ToolCallClaim
ToolCallFinish
ToolCallStatus
ToolResultFrame
Variables
CLUSTER_MIGRATIONS
DEFAULT_HEARTBEAT
DEFAULT_PULL_MAX_BYTES
DEFAULT_READ_MAX_BYTES
EXPO_PUSH_ENDPOINT
HUB_ATTACHMENT_MAX_BYTES
HUB_MIGRATIONS
HUB_VERSION
INSTALL_MESSAGES
INSTALL_MESSAGES_PS1
SINGLE_FRAME_ATTACHMENT_BYTES
USER_CODE_ALPHABET
Functions
assertScriptUrl
createHub
defaultPushMessage
defineTool
expoPushNotifier
fetchOnce
installScript
installScriptPs1
memoryCluster
migrateHubStore
normalizeToolResult
postgresCluster
postgresHubStore
redisCluster
sqlCluster
sqlHubStore
toNextHandlers
toToolSpec
node
Type Aliases
UncageNodeHandler
Functions
attachWebSocket
pgliteHubStore
toNodeHandler
@uncage/react-ui
Interfaces
AgentChatProps
ApproveDeviceProps
ChatComponents
ConnectMachineProps
DeviceLookupInfo
MachineStatusProps
RuntimeIconProps
RuntimeSelectorProps
SessionSidebarProps
UncageUIProviderProps
Type Aliases
ApproveDeviceState
Locale
Variables
CONNECT_POLL_MS
Markdown
Functions
AgentChat
AgentOutdatedNotice
ApprovalCard
ApproveDevice
AssistantMessage
Composer
ConnectionBanner
ConnectMachine
ConversationHeader
CopyCommand
EmptyState
MachineStatus
MessageList
RunStatusBar
RuntimeIcon
RuntimeSelector
SessionSidebar
ToolSteps
UncageProvider
UncageUIProvider
UserMessage
@uncage/react
Interfaces
AttachmentRejection
AttachmentsState
ChunkCursor
DeviceLookup
DraftAttachment
DraftState
InstallInfo
MachinesState
MessageView
SessionState
StoreState
ToolView
UncageProviderProps
UncageStore
Type Aliases
AttachmentFile
ConnectionState
DeviceApprovalState
DeviceCodeSource
DeviceDecision
PersistSessionMode
PersistSessionStorage
TimelineItem
Variables
DEFAULT_SETTINGS
PERSIST_SESSION_PARAM
PERSIST_SESSION_STORAGE_KEY
UPLOAD_FAILED_REASON
Functions
applyEvent
checkAttachment
createUncageStore
deviceCodeTail
initialSessionState
isDraft
isWellFormedDeviceCode
maskDeviceCode
matchesDeviceCodeTail
mergeSnapshot
newestFirst
UncageProvider
useApprovalActions
useApprovals
useAttachments
useAttachmentUrl
useConnection
useDeviceApproval
useMachines
useMessages
usePersistSession
useReconnect
useRun
useRunningSessions
useRuntimeCapabilities
useRuntimes
useSession
useSessions
useSessionSettings
useSpeechInput
useStoreSelector
useUncageError
useUncageStore
@uncage/client
Classes
UncageClientError
Interfaces
DeviceLookup
EventEnvelope
InstallInfo
RNFile
SSEFrame
SubscribeHandlers
UncageClient
UncageClientOptions
Type Aliases
ActiveRunInfo
ApprovalCategory
ApprovalDecision
ApprovalRequest
ApprovalState
ApprovalTarget
Attachment
ConnectionState
CreateSessionBody
CreateSessionRequest
DeviceDecision
EffortLevel
ErrorBody
ErrorCode
EventType
HealthResponse
MachineInfo
ModelOption
PermissionMode
Run
RunState
RuntimeCapabilities
RuntimeInfo
RuntimeStatus
Session
SessionSettings
SessionSnapshot
StartRunBody
ToolInfo
UncageEvent
UncageEventMap
UpdateSessionSettingsBody
Variables
ERROR_REASONS
STREAM_RECONNECT_EVENT
Functions
createUncageClient
isErrorBody
isUncageEvent
parseSSE
uploadContentType
@uncage/server
daemon
Interfaces
ServerOptions
UncageServer
Variables
DEFAULT_PORT
Functions
createUncageServer
proxy
Interfaces
ProxyOptions
UncageHandler
Type Aliases
UncageNodeHandler
Functions
createUncageHandler
createUncageNodeHandler
@uncage/protocol
node
Classes
UnsafeCommandError
Interfaces
MaterializedSkill
ResolvedCommand
ResolveOptions
Type Aliases
SystemToolName
Functions
cmdLine
findCommand
isCmdLine
isSystemTool
materializeSkills
parseNpmCmdShim
resolveCommand
safeExecFile
systemCmd
systemTool
protocol
Classes
ProtocolFrameError
Interfaces
AdapterRunContext
ErrorCatalogEntry
EventEnvelope
RuntimeAdapter
Type Aliases
ActiveRunInfo
AdapterRunInput
AgentFrame
AgentInfo
ApprovalCategory
ApprovalDecision
ApprovalOutcome
ApprovalRequest
ApprovalState
ApprovalTarget
Attachment
CreateSessionBody
DeviceCodeRequest
DeviceCodeResponse
DeviceTokenResponse
EffortLevel
ErrorBody
ErrorCode
EventType
HealthResponse
HttpConnectResponse
HttpEventsRequest
HttpEventsResponse
HubCommandArgs
HubCommandOp
HubCommandResults
HubFrame
IdPrefix
MachineInfo
ModelOption
NativeApprovalInput
PermissionMode
RelativePath
ResolvedAttachment
Run
RunState
RuntimeCapabilities
RuntimeEvent
RuntimeIcon
RuntimeInfo
RuntimeProbe
RuntimeStatus
RunTool
RunWarning
Session
SessionManifest
SessionSettings
SessionSnapshot
SkillSpec
StartRunBody
StreamLine
ToolCallResult
ToolInfo
ToolSpec
TransportKind
TransportOffer
UncageEvent
UncageEventMap
UpdateSessionSettingsBody
UpstreamMessage
Variables
ActiveRunInfoSchema
AdapterRunInputSchema
AgentFrameSchema
AgentInfoSchema
ApprovalAvailableDecisionSchema
ApprovalCategorySchema
ApprovalDecisionSchema
ApprovalOutcomeSchema
ApprovalRequestSchema
ApprovalStateSchema
ApprovalTargetSchema
ATTACHMENT_LIMITS
AttachmentSchema
CONNECTED_PROTOCOL
CreateSessionBodySchema
DeviceCodeRequestSchema
DeviceCodeResponseSchema
DeviceTokenResponseSchema
EffortLevelSchema
ERROR_CATALOG
ErrorBodySchema
ErrorCodeSchema
EventEnvelopeSchemas
EventPayloadSchemas
FILE_CHUNK_BYTES
HealthResponseSchema
HTTP_STREAM_CONTENT_TYPE
HttpConnectResponseSchema
HttpEventsRequestSchema
HttpEventsResponseSchema
HubCommandArgsSchemas
HubCommandOpSchema
HubCommandResultSchemas
HubFrameSchema
LenientRuntimeIconSchema
LINK_ID
MachineInfoSchema
MAX_ATTACHMENT_TRANSFER_BYTES
MAX_FRAME_BYTES
MAX_HTTP_BODY_BYTES
MAX_MANIFEST_SKILLS
MAX_MANIFEST_TOOLS
MAX_READ_EVENTS
MAX_RUN_WARNINGS
MAX_RUNTIME_ICON_BYTES
MIN_AGENT_VERSION
ModelOptionSchema
NativeApprovalInputSchema
PermissionModeSchema
RelativePathSchema
ResolvedAttachmentSchema
RunSchema
RunStateSchema
RuntimeCapabilitiesSchema
RuntimeEventSchema
RuntimeIconSchema
RuntimeInfoSchema
RuntimeProbeSchema
RuntimeStatusSchema
RunWarningSchema
SessionManifestSchema
SessionSchema
SessionSettingsSchema
SessionSnapshotSchema
SkillSpecSchema
StartRunBodySchema
StreamLineSchema
ToolCallResultSchema
ToolInfoSchema
ToolSpecSchema
TransportKindSchema
TransportOfferSchema
UncageEventSchema
UpdateSessionSettingsBodySchema
UPSTREAM_ID
UpstreamMessageSchema
Functions
classifyAttachment
displayFileName
formatEventId
isImageDataUri
neutralizeSkillMarkdown
newId
parseAgentFrame
parseEventId
parseHttpEventsRequest
parseHubFrame
parseStreamLine
sanitizeRuntimeIcon
siteApprovalRequest
@uncage/core
Classes
UncageError
Interfaces
SessionHandle
StartRunOptions
Store
Uncage
UncageOptions
Type Aliases
AttachmentBody
CallTool
StoredAttachment
Functions
createUncage
openPgliteStore
redactForExport
resolveWorkspace
sanitizeFileName
@uncage/agent
Classes
ActivityLog
FrameTooLargeError
Interfaces
ActivityEntry
Agent
AgentConfig
AgentLink
AgentLogger
AgentTiming
CreateAgentOptions
DialOptions
PermsOptions
ResolvedCommand
ResolveOptions
Type Aliases
AcpAgentEntry
AcpRuntimesConfig
ActivityKind
AgentSite
DeviceGrant
ExecFn
LinkEnd
PermsExec
SiteStatus
Variables
ACP_AGENT_ID
AcpAgentEntrySchema
AcpRuntimesSchema
AGENT_REDACT_PATHS
AGENT_VERSION
DEFAULT_ACP_RUNTIMES
DEFAULT_HUB_PATH
DEFAULT_TIMING
defaultExec
HUB_CLOSE
MAX_PULL_FILE_BYTES
MAX_PULL_TOTAL_BYTES
MAX_UPSTREAM_MESSAGE_BYTES
PULL_CHUNK_BYTES
SELF_UPGRADE
UPGRADE_EXIT_CODE
UPGRADE_RETRY_MS
Functions
activityLogPath
agentConfigLockPath
agentConfigPath
agentDir
agentHttpUrl
agentWsUrl
backoffDelay
checkUserOnly
chooseTransport
compareVersions
createAgent
createAgentLogger
dialHttp
dialWs
ensureAgentDir
execTarget
fetchAgentInfo
formatActivity
isHubUnauthorized
loadAgentConfig
newMachineKey
normalizeHubUrl
openUrlCommand
parseActivityLines
parseIcacls
parseNpmCmdShim
pollDeviceToken
readActivity
readUpgradeState
replaceFile
requestDeviceCode
resolveCommand
restrictToUser
selfUpgradeCommand
siteDir
siteHost
updateAgentAcp
updateAgentSites
upgradeStatePath
windowsUser
withAgentConfigLock
GitHub
Select theme
Dark
Light
Auto
Select language
English
简体中文
日本語
Session
View as Markdown
type
Session
=
z
.
infer
<
typeof
SessionSchema>;
Defined in: protocol/dist/index.d.ts:376