UI-TARS-desktop Documentation

File: README.md Copy Chapter

Introduction Copy Chapter

English | 简体中文

TARS^* is a Multimodal AI Agent stack, currently shipping two projects: Agent TARS and UI-TARS-desktop:

It primarily ships with a [CLI](https://agent-tars.com/guide/basic/cli.html) and [Web UI](https://agent-tars.com/guide/basic/web-ui.html) for usage.
    It aims to provide a workflow that is closer to human-like task completion through cutting-edge multimodal LLMs and seamless integration with various real-world [MCP](https://agent-tars.com/guide/basic/mcp.html) tools. | **UI-TARS Desktop** is a desktop application that provides a native GUI Agent based on the [UI-TARS](https://github.com/bytedance/UI-TARS) model.
    
    
    It primarily ships a
    [local](https://github.com/bytedance/UI-TARS-desktop/blob/main/docs/quick-start.md#get-model-and-run-local-operator) and 
    [remote](https://github.com/bytedance/UI-TARS-desktop/blob/main/docs/quick-start.md#run-remote-operator) computer as well as browser operators. |

Table of Contents Copy Chapter

• News
• Agent TARS
  • Showcase
  • Core Features
  • Quick Start
  • Documentation
• UI-TARS Desktop
  • Showcase
  • Features
  • Quick Start
• Contributing
• License
• Citation

News Copy Chapter

• [2025-11-05] 🎉 We're excited to announce the release of Agent TARS CLI v0.3.0! This version brings streaming support for multiple tools (shell commands, multi-file structured display), runtime settings with timing statistics for tool calls and deep thinking, Event Stream Viewer for data flow tracking and debugging. Additionally, it features exclusive support for AIO agent Sandbox as isolated all-in-one tools execution environment.
• [2025-06-25] We released an Agent TARS Beta and Agent TARS CLI - Introducing Agent TARS Beta, a multimodal AI agent that aims to explore a work form that is closer to human-like task completion through rich multimodal capabilities (such as GUI Agent, Vision) and seamless integration with various real-world tools.
• [2025-06-12] - 🎁 We are thrilled to announce the release of UI-TARS Desktop v0.2.0! This update introduces two powerful new features: Remote Computer Operator and Remote Browser Operator—both completely free. No configuration required: simply click to remotely control any computer or browser, and experience a new level of convenience and intelligence.
• [2025-04-17] - 🎉 We're thrilled to announce the release of new UI-TARS Desktop application v0.1.0, featuring a redesigned Agent UI. The application enhances the computer using experience, introduces new browser operation features, and supports the advanced UI-TARS-1.5 model for improved performance and precise control.
• [2025-02-20] - 📦 Introduced UI TARS SDK, is a powerful cross-platform toolkit for building GUI automation agents.
• [2025-01-23] - 🚀 We updated the Cloud Deployment section in the 中文版: GUI模型部署教程 with new information related to the ModelScope platform. You can now use the ModelScope platform for deployment.

Agent TARS Copy Chapter

[](https://npmjs.com/package/@agent-tars/cli?activeTab=readme)
[](https://npmcharts.com/compare/@agent-tars/cli?minimal=true)
[](https://nodejs.org/en/about/previous-releases)
[](https://discord.gg/HnKcSBgTVx)
[](https://twitter.com/agent_tars)
[](https://applink.larkoffice.com/client/chat/chatter/add_by_link?link_token=deen76f4-ea3c-4964-93a3-78f126f39651)
[](https://deepwiki.com/bytedance/UI-TARS-desktop)

Agent TARS is a general multimodal AI Agent stack, it brings the power of GUI Agent and Vision into your terminal, computer, browser and product.
It primarily ships with a CLI and Web UI for usage.
It aims to provide a workflow that is closer to human-like task completion through cutting-edge multimodal LLMs and seamless integration with various real-world MCP tools.

Showcase Copy Section

Please help me book the earliest flight from San Jose to New York on September 1st and the last return flight on September 6th on Priceline

https://github.com/user-attachments/assets/772b0eef-aef7-4ab9-8cb0-9611820539d8

For more use cases, please check out #842.

Core Features Copy Section

• 🖱️ One-Click Out-of-the-box CLI - Supports both headful Web UI and headless server execution.
• 🌐 Hybrid Browser Agent - Control browsers using GUI Agent, DOM, or a hybrid strategy.
• 🔄 Event Stream - Protocol-driven Event Stream drives Context Engineering and Agent UI.
• 🧰 MCP Integration - The kernel is built on MCP and also supports mounting MCP Servers to connect to real-world tools.

Quick Start Copy Section

# Launch with `npx`.
npx @agent-tars/cli@latest

# Install globally, required Node.js >= 22
npm install @agent-tars/cli@latest -g

# Run with your preferred model provider
agent-tars --provider volcengine --model doubao-1-5-thinking-vision-pro-250428 --apiKey your-api-key
agent-tars --provider anthropic --model claude-3-7-sonnet-latest --apiKey your-api-key

Visit the comprehensive Quick Start guide for detailed setup instructions.

Documentation Copy Section

🌟 Explore Agent TARS Universe 🌟

UI-TARS Desktop Copy Chapter

UI-TARS Desktop is a native GUI agent for your local computer, driven by UI-TARS and Seed-1.5-VL/1.6 series models.

Showcase Copy Section

Features Copy Section

• 🤖 Natural language control powered by Vision-Language Model
• 🖥️ Screenshot and visual recognition support
• 🎯 Precise mouse and keyboard control
• 💻 Cross-platform support (Windows/MacOS/Browser)
• 🔄 Real-time feedback and status display
• 🔐 Private and secure - fully local processing

Quick Start Copy Section

See Quick Start

Contributing Copy Chapter

See CONTRIBUTING.md.

License Copy Chapter

This project is licensed under the Apache License 2.0.

Citation Copy Chapter

If you find our paper and code useful in your research, please consider giving a star :star: and citation :pencil:

@article{qin2025ui,
  title={UI-TARS: Pioneering Automated GUI Interaction with Native Agents},
  author={Qin, Yujia and Ye, Yining and Fang, Junjie and Wang, Haoming and Liang, Shihao and Tian, Shizuo and Zhang, Junda and Li, Jiahao and Li, Yunxin and Huang, Shijue and others},
  journal={arXiv preprint arXiv:2501.12326},
  year={2025}
}

File: docs/archive-1.0/deployment.md Copy Chapter

[!WARNING]
This document has been archived.

Deployment

⚠️ Important Announcement: GGUF Model Performance Copy Section

The GGUF model has undergone quantization, but unfortunately, its performance cannot be guaranteed. As a result, we have decided to downgrade it.

💡 Alternative Solution:
You can use Cloud Deployment or Local Deployment [vLLM](If you have enough GPU resources) instead.

We appreciate your understanding and patience as we work to ensure the best possible experience.

Cloud Deployment Copy Chapter

We recommend using HuggingFace Inference Endpoints for fast deployment.
We provide two docs for users to refer:

English version: GUI Model Deployment Guide

中文版: GUI模型部署教程

Local Deployment [vLLM] Copy Chapter

We recommend using vLLM for fast deployment and inference. You need to use vllm>=0.6.1.

pip install -U transformers
VLLM_VERSION=0.6.6
CUDA_VERSION=cu124
pip install vllm==${VLLM_VERSION} --extra-index-url https://download.pytorch.org/whl/${CUDA_VERSION}

Download the Model Copy Section

We provide three model sizes on Hugging Face: 2B, 7B, and 72B. To achieve the best performance, we recommend using the 7B-DPO or 72B-DPO model (based on your hardware configuration):

• 2B-SFT
• 7B-SFT
• 7B-DPO
• 72B-SFT
• 72B-DPO

Start an OpenAI API Service Copy Section

Run the command below to start an OpenAI-compatible API service:

python -m vllm.entrypoints.openai.api_server --served-model-name ui-tars --model

Input your API information Copy Section

Note: VLM Base Url is OpenAI compatible API endpoints (see OpenAI API protocol document for more details).

File: docs/archive-1.0/preset.md Copy Chapter

[!WARNING]
This document has been archived.

Preset Management Guide

[!IMPORTANT]
Currently, UI-TARS Desktop does not directly provide server-side capabilities, so we do not provide a Preset for the open source community. welcome community developers to contribute your presets here.

A preset is a collection of settings (Introduced at #61), UI-TARS Desktop supports import presets via files or URLs:

graph TD
    A[Import Preset] --> B{Preset Type}
    B -->|File| C[YAML File]
    B -->|URL| D[URL Endpoint]
    C --> E[Manual Updates 🔧]
    D --> F[Auto Sync ⚡]

Preset Types Comparison Copy Chapter

Examples Copy Chapter

Import from file Copy Section

UI-TARS Desktop supports importing presets from files. Once the file is parsed successfully, the settings will be automatically updated.

Import from URL Copy Section

UI-TARS Desktop also supports importing presets from URLs. If automatic updates are set, presets will be automatically pulled every time the application is started.

Preset Example Copy Section

name: UI TARS Desktop Example Preset
language: en
vlmProvider: Hugging Face
vlmBaseUrl: https://your-endpoint.huggingface.cloud/v1
vlmApiKey: your_api_key
vlmModelName: your_model_name
reportStorageBaseUrl: https://your-report-storage-endpoint.com/upload
utioBaseUrl: https://your-utio-endpoint.com/collect

See all example presets.

File: docs/archive-1.0/quick-start.md Copy Chapter

[!WARNING]
This document has been archived.

Quick Start

Download Copy Chapter

You can download the latest release version of UI-TARS Desktop from our releases page.

Note: If you have Homebrew installed, you can install UI-TARS Desktop by running the following command:

bash Copy

brew install --cask ui-tars

Install Copy Chapter

MacOS Copy Section

1. Drag UI TARS application into the Applications folder

2. Enable the permission of UI TARS in MacOS:

• System Settings -> Privacy & Security -> Accessibility
• System Settings -> Privacy & Security -> Screen Recording

3. Then open UI TARS application, you can see the following interface:

Windows Copy Section

Still to run the application, you can see the following interface:

File: docs/archive-1.0/README.md Copy Chapter

UI-TARS Desktop

UI-TARS Desktop is a GUI Agent application based on UI-TARS (Vision-Language Model) that allows you to control your computer using natural language.

Showcases Copy Chapter

News Copy Chapter

• [2025-04-17] - 🎉 We're excited to announce support for UI-TARS-1.5, featuring enhanced performance, precise control, and expanded scenario coverage (using computer and browser as operators). Now compatible with multiple models: UI-TARS-1.0, UI-TARS-1.5, and Doubao-1.5-UI-TARS!
• [2025-02-20] - 📦 Introduced UI TARS SDK, is a powerful cross-platform toolkit for building GUI automation agents.
• [2025-01-23] - 🚀 We updated the Cloud Deployment section in the 中文版: GUI模型部署教程 with new information related to the ModelScope platform. You can now use the ModelScope platform for deployment.

Features Copy Chapter

• 🤖 Natural language control powered by Vision-Language Model
• 🖥️ Screenshot and visual recognition support
• 🎯 Precise mouse and keyboard control
• 💻 Cross-platform support (Windows/MacOS)
• 🔄 Real-time feedback and status display
• 🔐 Private and secure - fully local processing

Quick Start Copy Chapter

See Quick Start.

Deployment Copy Chapter

See Deployment.

Contributing Copy Chapter

See CONTRIBUTING.md.

SDK (Experimental) Copy Chapter

See @ui-tars/sdk

License Copy Chapter

UI-TARS Desktop is licensed under the Apache License 2.0.

Citation Copy Chapter

If you find our paper and code useful in your research, please consider giving a star :star: and citation :pencil:

@article{qin2025ui,
  title={UI-TARS: Pioneering Automated GUI Interaction with Native Agents},
  author={Qin, Yujia and Ye, Yining and Fang, Junjie and Wang, Haoming and Liang, Shihao and Tian, Shizuo and Zhang, Junda and Li, Jiahao and Li, Yunxin and Huang, Shijue and others},
  journal={arXiv preprint arXiv:2501.12326},
  year={2025}
}