Back to UI-TARS-desktop

Preset Management Guide

docs/preset.md

0.3.02.5 KB
Original Source

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:

mermaid
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

FeatureLocal PresetsRemote Presets
StorageDevice-localCloud-hosted
Update MechanismManualAutomatic
Access ControlRead/WriteRead-Only
VersioningManualGit-integrated

Examples

Import from file

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

FunctionSnapshot
Open Setting
Import Success
Exception: Invalid Content

Import from URL

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.

FunctionSnapshot
Open Setting
Import Success (Default)

Preset Example

yaml
name: UI TARS Desktop Example Preset
language: en
vlmProvider: Hugging Face for UI-TARS-1.5
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.