bytebot README

The project's README from github.com/bytebot-ai/bytebot. As one markdown file: README.md.

Bytebot Logo

Bytebot: Open-Source AI Desktop Agent

bytebot-ai%2Fbytebot | Trendshift

An AI that has its own computer to complete tasks for you

Deploy on Railway

Docker License Discord

🌐 Website • 📚 Documentation • 💬 Discord • 𝕏 Twitter

Deutsch | Español | français | 日本語 | 한국어 | Português | Русский | 中文


https://github.com/user-attachments/assets/f271282a-27a3-43f3-9b99-b34007fdd169

https://github.com/user-attachments/assets/72a43cf2-bd87-44c5-a582-e7cbe176f37f

What is a Desktop Agent?

A desktop agent is an AI that has its own computer. Unlike browser-only agents or traditional RPA tools, Bytebot comes with a full virtual desktop where it can:

Think of it as a virtual employee with their own computer who can see the screen, move the mouse, type on the keyboard, and complete tasks just like a human would.

Why Give AI Its Own Computer?

When AI has access to a complete desktop environment, it unlocks capabilities that aren't possible with browser-only agents or API integrations:

Complete Task Autonomy

Give Bytebot a task like "Download all invoices from our vendor portals and organize them into a folder" and it will:

Process Documents

Upload files directly to Bytebot's desktop and it can:

Use Real Applications

Bytebot isn't limited to web interfaces. It can:

Quick Start

Deploy in 2 Minutes

Option 1: Railway (Easiest) Deploy on Railway

Just click and add your AI provider API key.

Option 2: Docker Compose

git clone https://github.com/bytebot-ai/bytebot.git
cd bytebot

# Add your AI provider key (choose one)
echo "ANTHROPIC_API_KEY=sk-ant-..." > docker/.env
# Or: echo "OPENAI_API_KEY=sk-..." > docker/.env
# Or: echo "GEMINI_API_KEY=..." > docker/.env

docker-compose -f docker/docker-compose.yml up -d

# Open http://localhost:9992

Full deployment guide →

How It Works

Bytebot consists of four integrated components:

  1. Virtual Desktop: A complete Ubuntu Linux environment with pre-installed applications
  2. AI Agent: Understands your tasks and controls the desktop to complete them
  3. Task Interface: Web UI where you create tasks and watch Bytebot work
  4. APIs: REST endpoints for programmatic task creation and desktop control

Key Features

Example Tasks

Basic Examples

"Go to Wikipedia and create a summary of quantum computing"
"Research flights from NYC to London and create a comparison document"
"Take screenshots of the top 5 news websites"

Document Processing

"Read the uploaded contracts.pdf and extract all payment terms and deadlines"
"Process these 5 invoice PDFs and create a summary report"
"Download and analyze the latest financial report and answer: What were the key risks mentioned?"

Multi-Application Workflows

"Download last month's bank statements from our three banks and consolidate them"
"Check all our vendor portals for new invoices and create a summary report"
"Log into our CRM, export the customer list, and update records in the ERP system"

Programmatic Control

Create Tasks via API

import requests

# Simple task
response = requests.post('http://localhost:9991/tasks', json={
    'description': 'Download the latest sales report and create a summary'
})

# Task with file upload
files = {'files': open('contracts.pdf', 'rb')}
response = requests.post('http://localhost:9991/tasks',
    data={'description': 'Review these contracts for important dates'},
    files=files
)

Direct Desktop Control

# Take a screenshot
curl -X POST http://localhost:9990/computer-use \
  -H "Content-Type: application/json" \
  -d '{"action": "screenshot"}'

# Click at specific coordinates
curl -X POST http://localhost:9990/computer-use \
  -H "Content-Type: application/json" \
  -d '{"action": "click_mouse", "coordinate": [500, 300]}'

Full API documentation →

Setting Up Your Desktop Agent

1. Deploy Bytebot

Use one of the deployment methods above to get Bytebot running.

2. Configure the Desktop

Use the Desktop tab in the UI to:

3. Start Giving Tasks

Create tasks in natural language and watch Bytebot complete them using the configured desktop.

Use Cases

Business Process Automation

Development & Testing

Research & Analysis

Architecture

Bytebot is built with:

Why Self-Host?

Advanced Features

Multiple AI Providers

Use any AI provider through our LiteLLM integration:

Enterprise Deployment

Deploy on Kubernetes with Helm:

# Clone the repository
git clone https://github.com/bytebot-ai/bytebot.git
cd bytebot

# Install with Helm
helm install bytebot ./helm \
  --set agent.env.ANTHROPIC_API_KEY=sk-ant-...

Enterprise deployment guide →

Community & Support

Contributing

We welcome contributions! Whether it's:

Please:

  1. Check existing issues first
  2. Open an issue to discuss major changes
  3. Submit PRs with clear descriptions
  4. Join our Discord to discuss ideas

License

Bytebot is open source under the Apache 2.0 license.


Give your AI its own computer. See what it can do.

Deploy on Railway

Built by Tantl Labs and the open source community

bytebot (bytebot-ai/bytebot)

Searching Database…

11.1K ·GitHub
archived
这是什么?Bytebot 是一个可自托管的 AI 智能体,它会在容器中拥有一台完整的 Linux 桌面(包括应用、文件系统和浏览器),并像真人一样实际操作这台桌面来完成任务。
这是云服务,还是需要我自己运行的软件?它是完全自托管的:你需要在自己的基础设施(Docker/Kubernetes)上运行,并自备 AI 服务商的 API 密钥,没有托管的 Bytebot 云服务。
我该如何让 Bytebot 运行起来?大约两分钟即可部署完成,可以选择一键部署到 Railway(只需添加你的 AI 服务商 API 密钥),或使用 Docker Compose;另外还提供适用于 Kubernetes/企业部署的 Helm chart。
我可以使用哪些 AI 服务商?开箱即可使用 Anthropic Claude、OpenAI GPT 和 Google Gemini;通过其 LiteLLM 集成,还可以使用 Azure OpenAI、AWS Bedrock、本地 Ollama 模型以及其他 100 多家服务商。
这个项目还在维护吗?不再维护。该仓库已归档,因此虽然代码和自托管说明仍可使用,但它已不再积极开发或更新。
我的数据会离开我自己的服务器吗?不会。Bytebot 完全运行在你掌控的基础设施上,所有桌面活动、文件和任务数据都保留在你自己的服务器上。
Bytebot 部署包含哪些主要部分?四个部分:一个预装应用的虚拟 Ubuntu/XFCE 桌面、一个驱动桌面的智能体服务、一个用于创建和查看任务的网页任务界面,以及用于程序化控制的 REST API。
它能用我保存的密码登录网站吗?可以。你可以在它的虚拟桌面上安装 1Password 或 Bitwarden 等密码管理器,这样 Bytebot 就能自动完成身份验证,包括处理 2FA。
为什么要用完整桌面的智能体,而不是只能操作浏览器的智能体?只能操作浏览器的智能体无法使用本地应用和本地文件,也无法跨多个程序完成多步骤工作流;Bytebot 自带的桌面让它能像真人一样使用 VS Code、邮件客户端、办公工具和文件系统。
桌面环境在任务之间会保留吗?会。你安装的程序和登录过的账号会在桌面上保持配置,供后续任务使用,因此只需设置一次。
Creator
bytebot-ai
Size
18.6 MB
Stars
11.1K
Updated
CommitSep 11
Age
1y
Commits · 90 Days