Skip to content

Commit b61795c

Browse files
committed
docs(agent-tars): tweak quick start
1 parent b2e1271 commit b61795c

File tree

3 files changed

+21
-21
lines changed

3 files changed

+21
-21
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
> **\[2025-03-16\]** We released a **technical preview** version of a new desktop app - [Agent TARS](./apps/agent-tars/README.md), a multimodal AI agent that leverages browser operations by visually interpreting web pages and seamlessly integrating with command lines and file systems.
55
66
<p align="center">
7-
<img alt="UI-TARS" width="260" src="./resources/icon.png">
7+
<img alt="UI-TARS" width="260" src="./apps/ui-tars/resources/icon.png">
88
</p>
99

1010
# UI-TARS Desktop
@@ -67,22 +67,22 @@ You can download the [latest release](https://github.com/bytedance/UI-TARS-deskt
6767
#### MacOS
6868
6969
1. Drag **UI TARS** application into the **Applications** folder
70-
<img src="./images/mac_install.png" width="500px" />
70+
<img src="./apps/ui-tars/images/mac_install.png" width="500px" />
7171
7272
2. Enable the permission of **UI TARS** in MacOS:
7373
- System Settings -> Privacy & Security -> **Accessibility**
7474
- System Settings -> Privacy & Security -> **Screen Recording**
75-
<img src="./images/mac_permission.png" width="500px" />
75+
<img src="./apps/ui-tars/images/mac_permission.png" width="500px" />
7676
7777
3. Then open **UI TARS** application, you can see the following interface:
78-
<img src="./images/mac_app.png" width="500px" />
78+
<img src="./apps/ui-tars/images/mac_app.png" width="500px" />
7979
8080
8181
#### Windows
8282
8383
**Still to run** the application, you can see the following interface:
8484
85-
<img src="./images/windows_install.png" width="400px" />
85+
<img src="./apps/ui-tars/images/windows_install.png" width="400px" />
8686
8787
### Deployment
8888
@@ -122,7 +122,7 @@ python -m vllm.entrypoints.openai.api_server --served-model-name ui-tars --model
122122

123123
##### Input your API information
124124

125-
<img src="./images/settings_model.png" width="500px" />
125+
<img src="./apps/ui-tars/images/settings_model.png" width="500px" />
126126

127127
<!-- If you use Ollama, you can use the following settings to start the server:
128128

apps/agent-tars/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
## Getting Started
3030

31-
<!--TODO-->
31+
See [Quick Start](./docs/quick-start.md).
3232

3333
## Contributing
3434

apps/agent-tars/quick-start.md renamed to apps/agent-tars/docs/quick-start.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,65 @@
1-
# Agent Tars Quick Start
1+
# Getting started with Agent TARS
22

3-
Hello, welcome to Agent Tars!
3+
Hello, welcome to Agent TARS!
44

5-
This guide will walk you through the process of setting up your first Agent Tars project.
5+
This guide will walk you through the process of setting up your first Agent TARS project.
66

77
## Necessary Configuration
88

99
Before you begin, you will need to set some necessary configuration.
1010

1111
You can click the left-bottom button to open the configuration page:
1212

13-
[setting-icon.png](https://lf3-static.bytednsdoc.com/obj/eden-cn/uhbfnupenuhf/agent-tars/setting-icon.jpeg)
13+
![setting-icon.png](https://lf3-static.bytednsdoc.com/obj/eden-cn/uhbfnupenuhf/agent-tars/setting-icon.jpeg)
1414

1515
Then you can set the model config and the search config.
1616

1717
For model config, you can set the model provider and api key:
1818

19-
[model-config.png](https://lf3-static.bytednsdoc.com/obj/eden-cn/uhbfnupenuhf/agent-tars/search-setting.jpeg)
19+
![model-config.png](https://lf3-static.bytednsdoc.com/obj/eden-cn/uhbfnupenuhf/agent-tars/search-setting.jpeg)
2020

2121
> For Azure OpenAI, you can set more params, including apiVersion, deploymentName and endpoint.
2222
2323
For search config, you can set the search provider and api key:
2424

25-
[search-settings.png](https://lf3-static.bytednsdoc.com/obj/eden-cn/uhbfnupenuhf/agent-tars/search-setting.jpeg)
25+
![search-settings.png](https://lf3-static.bytednsdoc.com/obj/eden-cn/uhbfnupenuhf/agent-tars/search-setting.jpeg)
2626

2727
## Start Your First Journey
2828

29-
Now you can start your first journey in Agent Tars!
29+
Now you can start your first journey in Agent TARS!
3030

3131
You can input your first question in the input box, and then press Enter to send your question. Here is an example:
3232

33-
[first-journey.jpeg](https://lf3-static.bytednsdoc.com/obj/eden-cn/uhbfnupenuhf/agent-tars/start-journey.jpeg)
33+
![first-journey.jpeg](https://lf3-static.bytednsdoc.com/obj/eden-cn/uhbfnupenuhf/agent-tars/start-journey.jpeg)
3434

3535
It's working!
3636

3737
We also support **Human In the Loop**, that means you can interact with the agent in the working process by the input box. If you want to change the direction of current agent work, you can insert your thoughts in the special input box on the top position, and then press Enter to send your thoughts. Here is an example:
3838

39-
[human-in-the-loop.jpeg](https://lf3-static.bytednsdoc.com/obj/eden-cn/uhbfnupenuhf/agent-tars/human-in-the-loop.jpeg)
39+
![human-in-the-loop.jpeg](https://lf3-static.bytednsdoc.com/obj/eden-cn/uhbfnupenuhf/agent-tars/human-in-the-loop.jpeg)
4040

4141
## Share Your Thead
4242

4343
You can share your thread with others by the share button on the top menu.
4444

4545
There are two modes to share your thread:
4646

47-
- **Local Html**: Agent Tars will bundle your thread into a html file, and you can share it with others.
48-
- **Remote Server Url**: Agent Tars will generate a url for you to share your thread with others, Agent Tars will upload the html bundle to a remote server.
47+
- **Local Html**: Agent TARS will bundle your thread into a html file, and you can share it with others.
48+
- **Remote Server Url**: Agent TARS will generate a url for you to share your thread with others, Agent TARS will upload the html bundle to a remote server.
4949

5050
### Local Mode
5151

5252
You can click the share button to open the share modal, and then click the **Local Html** button to share your thread.
5353

54-
[local-share](https://lf3-static.bytednsdoc.com/obj/eden-cn/uhbfnupenuhf/agent-tars/local-share.jpeg)
54+
![local-share](https://lf3-static.bytednsdoc.com/obj/eden-cn/uhbfnupenuhf/agent-tars/local-share.jpeg)
5555

5656
### Remote Mode
5757

5858
For the remote share mode, you need to set the remote server url in the share modal:
5959

60-
[remote-share](https://lf3-static.bytednsdoc.com/obj/eden-cn/uhbfnupenuhf/agent-tars/local-share.jpeg)
60+
![remote-share](https://lf3-static.bytednsdoc.com/obj/eden-cn/uhbfnupenuhf/agent-tars/remote-share.jpeg)
6161

62-
Then Agent Tars will post a request to the remote server to upload the html bundle, and then you can share the url with others. The specific request information is as follows:
62+
Then Agent TARS will post a request to the remote server to upload the html bundle, and then you can share the url with others. The specific request information is as follows:
6363

6464
- Method: POST
6565
- Body:

0 commit comments

Comments
 (0)