Skip to content

m1guelpf/bytebot

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

63 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Bytebot Logo

The computer use container

Documentation | Discord | Twitter

Features

  • Containerized Desktop - Lightweight XFCE4 desktop on Ubuntu 22.04
  • Access Anywhere - VNC and browser-based noVNC remote access
  • Unified API - Control all desktop actions through a simple REST API
  • Pre-installed Tools - Firefox and other essential applications ready to use

Documentation

For full documentation, visit docs.bytebot.ai

Quick Start

Prerequisites

  • Docker installed on your system

Run Bytebot

# Build the image ./scripts/build.sh # Run the container ./scripts/run.sh

More information can be found in the Quickstart Guide.

Access Bytebot

  • VNC Client: Connect to localhost:5900
  • Web Browser: Navigate to http://localhost:9990/vnc

Automation API

Control Bytebot using the unified computer action API:

Available Actions

The unified API supports the following actions:

Action Description Parameters
move_mouse Move the mouse cursor to a specific position coordinates: { x: number, y: number }
click_mouse Perform a mouse click coordinates?: { x: number, y: number }, button: 'left' | 'right' | 'middle', numClicks?: number, holdKeys?: string[]
drag_mouse Click and drag the mouse from one point to another path: { x: number, y: number }[], button: 'left' | 'right' | 'middle', holdKeys?: string[]
scroll Scroll up, down, left, or right coordinates?: { x: number, y: number }, direction: 'up' | 'down' | 'left' | 'right', amount: number, holdKeys?: string[]
press_key Press a keyboard key key: string, modifiers?: string[]
type_text Type a text string text: string, delay?: number
wait Wait for a specified duration duration: number (milliseconds)
screenshot Capture a screenshot of the desktop None
get_cursor_position Get the current cursor position None

Contributing

We welcome contributions from the community!

Guidelines

  1. Fork the repo and create a new branch from the main branch.
  2. Commit your changes to the branch (please keep commits small and focused).
  3. Open a pull request with a clear description of the changes.
  4. Wait for review and address any feedback.
  5. Once approved, your changes will be merged.

Support

For any questions or feedback, please join our community on Discord.

Acknowledgments

Bytebot builds on top of nutjs, and is inspired by Anthropic's original computer use demo.

License

Licensed under the MIT License.

Copyright 2025 Tantl Labs, Inc.

About

Bytebot is the container for computer use agents.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

 

Packages

No packages published

Languages

  • TypeScript 79.7%
  • Dockerfile 7.9%
  • Shell 5.1%
  • CSS 3.4%
  • Scheme 2.9%
  • JavaScript 1.0%