Glossary
Definitions used across the docs (the backend schema).
| Term | Definition |
|---|---|
| Agent | The @vibecontrols/agent process running on a target. Has hostname, platform, architecture, version, apiVersion, isActive, lastHeartbeat, tunnelUrl, agentApiKey, appId. |
| Target | A connection destination. Types: DIRECT, SSH, RDP, VNC. Has host, port, username, connectionConfig (type-specific). |
| Vibe | A project context. Types: PROJECT, WORKSPACE, REPOSITORY, MONOREPO, PACKAGE, CUSTOM. Statuses: ACTIVE, INACTIVE, ARCHIVED, ERROR. Has path, gitBranch, gitRemote, environmentVariables, hierarchical (parent/children). |
| Session | A live terminal. Types: TMUX, WEZTERM, ZELLIJ, SSH, TERMINAL, SCRIPT, CUSTOM. Statuses: PENDING, STARTING, RUNNING, STOPPED, ERROR, TERMINATED. Has command, workingDirectory, environmentVariables, ttydUrl (browser access), accumulatedSeconds. |
| VibeDeck | A Stream-Deck-style grid of action buttons. Has gridColumns, gridRows, buttonSize, colorTheme. Contains VibeDeckButton[]. |
| VibeDeckButton | A single tile on a VibeDeck. Has label, icon, color, row, column, rowSpan, colSpan, actionType (COMMAND, SCRIPT, or WEBHOOK), targetAgentId, confirmationRequired. |
| Action | A reusable command/script/webhook/workflow. Types: COMMAND, SCRIPT, WEBHOOK, WORKFLOW. Trigger types: MANUAL, SCHEDULED, EVENT. |
| ActionExecution | A single run of an Action. Statuses: PENDING, RUNNING, SUCCESS, FAILURE, TIMEOUT, CANCELLED. Captures output, exitCode, startedAt, completedAt, durationMs. |
| Note | Markdown content attached to a vibe (optional). Has title, content, tags, isPinned. |
| AiPrompt | A reusable prompt template. Categories: GENERAL, CODING, DEBUGGING, REVIEW, DOCUMENTATION, TESTING, DEPLOYMENT, RUNBOOK, CUSTOM. Statuses: DRAFT, ACTIVE, ARCHIVED. Supports variables for templating. |
| Configuration | Scoped key-value store. Scopes: WORKSPACE, VIBE, SESSION, AGENT, USER, GLOBAL. Can be marked isSecret (encrypted). |
| Webhook | Outbound HTTP delivery. Has url, events[], encrypted secret, retryPolicy, deliveryCount, failureCount. Scoped to specific agentIds[] if needed. |
| AiToolEvent | Telemetry from external AI tools (opencode, claude-code, gemini-cli, cursor) running inside the agent's environment. |
| SessionShare | Direct share of a session with another user. Permission: VIEW or INTERACT. Status: PENDING, ACTIVE, EXPIRED, REVOKED. |
| SessionShareLink | Token-based share link. Has token, permission, optional passwordHash (bcrypt), expiresAt, maxUses. |
| SessionCollaborator | Active participant on a shared session. Roles: OWNER, EDITOR, VIEWER. Has hasControl for live takeover. |
| VibeDeckShareLink | Token-based share for a VibeDeck. Permissions: VIEW or EXECUTE. Visibility: SIGNED_LINK, PUBLIC, RESTRICTED. |
| Tunnel | Outbound HTTP tunnel via Cloudflare quick tunnel or VibeTunnels (frp). |
| Profile | Per-agent named environment ("default", "alpha", "prod"). Lets one machine host multiple agent instances with different backends. |
| ttyd | The web terminal binary the session-tmux plugin uses to expose sessions over HTTP. |