@ui-tars-test/cli

CLI for GUI Agent - A powerful automation tool for desktop, web, and mobile applications.

Installation

$3

``bash
npm install -g @ui-tars-test/cli
`

$3

`bash
npx @ui-tars-test/cli run [options]
`

$3

`bash
npm install @ui-tars-test/cli
`

Usage

$3

`bash
gui-agent run
`

This will start an interactive prompt where you can:
1. Configure your VLM model settings (provider, base URL, API key, model name)
2. Select the target operator (computer, browser, or android)
3. Enter your automation instruction

$3

#### gui-agent run
Run GUI Agent automation with optional parameters.

#### gui-agent reset
Reset stored configuration (API keys, model settings, etc.).
`bash
gui-agent reset # Reset default configuration file
gui-agent reset -c custom.json # Reset specific configuration file
`

$3

`bash
gui-agent run [options]
`

#### Options:
- -p, --presets - Load model configuration from a remote YAML preset file
- -t, --target - Specify the target operator:
- computer - Desktop automation (default)
- browser - Web browser automation
- android - Android mobile automation
- -q, --query - Provide the automation instruction directly via command line
- -c, --config - Path to a custom configuration file (default: ~/.gui-agent-cli.json)

$3

#### Computer Automation
`bash
gui-agent run -t computer -q "Open Chrome browser and navigate to github.com"
`

#### Android Mobile Automation
Make sure your Android device is connected via USB debugging:

`bash
gui-agent run -t android -q "Open WhatsApp and send a message to John"
`

#### Browser Automation
`bash
gui-agent run -t browser -q "Search for 'GUI Agent automation' on Google"
`

#### Using Remote Presets
`bash
gui-agent run -p "https://example.com/config.yaml" -q "Automate the login process"
`

Configuration

$3

The CLI requires VLM (Vision Language Model) configuration. You can provide this via:

1. Interactive setup - When you first run the CLI, it will prompt for:
- Model provider (volcengine, anthropic, openai, lm-studio, deepseek, ollama)
- Model base URL
- API key
- Model name

2. Configuration file - Settings are saved to ~/.gui-agent-cli.json:
`json
{
"provider": "openai",
"baseURL": "https://api.openai.com/v1",
"apiKey": "your-api-key",
"model": "gpt-4-vision-preview",
"useResponsesApi": false
}
`

3. Remote presets - Load configuration from a YAML file:
`yaml
vlmBaseUrl: "https://api.openai.com/v1"
vlmApiKey: "your-api-key"
vlmModelName: "gpt-4-vision-preview"
useResponsesApi: false
`

#### Supported Providers
- volcengine - VolcEngine (ByteDance) models
- anthropic - Anthropic Claude models
- openai - OpenAI models (default)
- lm-studio - LM Studio local models
- deepseek - DeepSeek models
- ollama - Ollama local models

Operators

$3

#### Using Remote Presets
`bash
gui-agent start -p "https://example.com/config.yaml" -q "Automate the login process"
`

Configuration

$3

The CLI requires VLM (Vision Language Model) configuration. You can provide this via:

1. Interactive setup - When you first run the CLI, it will prompt for:
- Model provider (volcengine, anthropic, openai, lm-studio, deepseek, ollama)
- Model base URL
- API key
- Model name

2. Configuration file - Settings are saved to ~/.gui-agent-cli.json:
`json
{
"provider": "openai",
"baseURL": "https://api.openai.com/v1",
"apiKey": "your-api-key",
"model": "gpt-4-vision-preview",
"useResponsesApi": false
}
`

3. Remote presets - Load configuration from a YAML file:
`yaml
vlmBaseUrl: "https://api.openai.com/v1"
vlmApiKey: "your-api-key"
vlmModelName: "gpt-4-vision-preview"
useResponsesApi: false
`

#### Supported Providers
- volcengine - VolcEngine (ByteDance) models
- anthropic - Anthropic Claude models
- openai - OpenAI models (default)
- lm-studio - LM Studio local models
- deepseek - DeepSeek models
- ollama - Ollama local models

Operators

$3

- Automates desktop applications
- Uses computer vision to identify UI elements
- Supports mouse and keyboard actions
- Works with Windows, macOS, and Linux

$3

- Controls Android devices via ADB
- Requires USB debugging enabled
- Can automate mobile apps and system UI
- Supports touch gestures and device interactions

Configuration Management

$3

To clear all stored configuration and start fresh:
`bash
gui-agent reset
`

This will remove the configuration file (~/.gui-agent-cli.json) and the CLI will prompt you to configure settings again on the next run.

$3


You can specify a custom configuration file location:
`bash
gui-agent run -c /path/to/custom-config.json
`

To reset a specific configuration file:
`bash
gui-agent reset -c /path/to/custom-config.json
`

Development

$3


`bash
npm run build
`

$3

`bash
npm run dev
`

$3

`bash
npm test
``

License

Apache-2.0

Contributing

Contributions are welcome! Please read our contributing guidelines and submit pull requests to our repository.