khulnasoft commited on
Commit
2a08eda
·
verified ·
1 Parent(s): c791701

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +8 -331
README.md CHANGED
@@ -1,331 +1,8 @@
1
- # GPT Computer Agent
2
-
3
- <p align="center">
4
-
5
- <a href="https://docs.gca.dev">
6
- <img src="https://github.com/user-attachments/assets/c60562bf-540e-47d9-b578-994285071128" width="250">
7
- </a>
8
- .
9
- <a href="https://github.com/KhulnaSoft/gpt-computer-agent/releases/latest/download/gpt-computer-agent-openai.dmg">
10
- <img src="https://github.com/user-attachments/assets/a0475f31-9dfd-4a0c-91b0-7ae128c3c773" width="250">
11
- </a>
12
- .
13
- <a href="https://github.com/KhulnaSoft/gpt-computer-agent/releases/latest/download/gpt-computer-agent-openai.exe">
14
- <img src="https://github.com/user-attachments/assets/c94139fd-609c-4780-9541-6e9e01dd0e47" width="250">
15
- </a>
16
-
17
- </p>
18
-
19
- <p align="center">
20
- <a href="https://www.producthunt.com/posts/gpt-computer-agent?embed=true&utm_source=badge-top-post-badge&utm_medium=badge&utm_souce=badge-gpt&#0045;computer&#0045;assistant" target="_blank"><img src="https://api.producthunt.com/widgets/embed-image/v1/top-post-badge.svg?post_id=465468&theme=dark&period=daily" alt="GPT&#0032;Computer&#0032;Assistant - Create&#0032;intelligence&#0032;for&#0032;your&#0032;products | Product Hunt" style="width: 250px; height: 54px;" width="250" height="54" /></a>
21
- .
22
- <a href="https://discord.gg/qApFmWMt8x"><img alt="Static Badge" src="https://img.shields.io/badge/Discord-Join?style=social&logo=discord" width=150></a>
23
- .
24
- <a href="https://x.com/GPTCompAsst"><img alt="Static Badge" src="https://img.shields.io/badge/X_App-Join?style=social&logo=x" width=150></a>
25
- </p>
26
-
27
-
28
- <p align="center">
29
- <br />
30
- Intelligence development framework
31
- <br />
32
- </p>
33
- <br>
34
-
35
- <p align="center">
36
- <a href="https://www.python.org/">
37
- <img src="https://img.shields.io/badge/Made%20with-Python-1f425f.svg" alt="Made_with_python">
38
- </a>
39
- .
40
- <img src="https://static.pepy.tech/personalized-badge/gpt-computer-agent?period=total&units=international_system&left_color=grey&right_color=blue&left_text=PyPI%20Downloads" alt="pypi_downloads">
41
- </p>
42
-
43
-
44
-
45
-
46
- |ENGLISH|[简体中文](README.zh_CN.md)|[正體中文](README.zh_TW.md)|[TÜRKÇE](README.TR.md)
47
-
48
- Hi, this is an alternative work for providing ChatGPT MacOS app to Windows and Linux. In this way this is a fresh and stable work. You can easily install as Python library for this time but we will prepare a pipeline for providing native install scripts (.exe).
49
-
50
- Powered by <a href="https://github.com/KhulnaSoft/Tiger"><strong>KhulnaSoft Tiger 🐅</strong></a> A function hub for llm agents.
51
-
52
-
53
-
54
-
55
- ## 1. Install and run
56
- **Python 3.10 or 3.11 is required**
57
-
58
- ```console
59
- pip install 'gpt-computer-agent[base]'
60
- pip install 'gpt-computer-agent[api]'
61
- ```
62
-
63
- To run gpt-computer-agent, simply type
64
-
65
- ```console
66
- computeragent --api
67
- ```
68
-
69
-
70
- <p align="center">
71
-
72
- <a href="#">
73
- <img src="https://github.com/user-attachments/assets/890b4e0a-4484-4870-a158-2d365b0d969e" >
74
- </a>
75
-
76
- </p>
77
-
78
-
79
-
80
-
81
- <p align="center">
82
- <br>
83
- <br>
84
- <br>
85
- <br>
86
- <br>
87
- </p>
88
-
89
-
90
-
91
-
92
-
93
-
94
- ## 2. LLM Settings
95
-
96
- ```python
97
- from gpt_computer_agent.remote import remote
98
-
99
- remote.save_models("gpt-4o")
100
- remote.save_openai_api_key("sk-**")
101
- ```
102
-
103
- <p align="start">
104
-
105
- <a href="https://docs.upsonic.co/gca/dev_guides/llm_settings">
106
- <img src="https://github.com/user-attachments/assets/a75c8ddf-f9df-436b-9dc8-c5220211e15e" width="150">
107
- </a>
108
-
109
- </p>
110
-
111
-
112
-
113
- <p align="center">
114
- <br>
115
- <br>
116
- <br>
117
- </p>
118
-
119
-
120
-
121
- ## 3. Characteristic API
122
-
123
-
124
- ```python
125
- # Name of the assitant:
126
- remote.change_name("X Intelligence")
127
-
128
- #Developer personna of the assistant:
129
- remote.change_developer("X Company")
130
- ```
131
-
132
- <p align="start">
133
-
134
- <a href="https://docs.upsonic.co/gca/dev_guides/characteristic">
135
- <img src="https://github.com/user-attachments/assets/d7e02ac6-e40c-4b35-8e65-4621bf3fb9a1" width="150">
136
- </a>
137
-
138
- </p>
139
-
140
-
141
-
142
- <p align="center">
143
- <br>
144
- <br>
145
- <br>
146
- </p>
147
-
148
-
149
-
150
- ## 4. Connect Your Functions API
151
-
152
-
153
- ```python
154
- # Installing an library:
155
- remote.install_library("numpy")
156
-
157
-
158
-
159
- # Adding functianility as python functions:
160
- @remote.custom_tool
161
- def my_server_status() -> bool:
162
- """
163
- Check the server status.
164
- """
165
- return True
166
- ```
167
-
168
-
169
-
170
- <p align="center">
171
- <br>
172
- <br>
173
- <br>
174
- </p>
175
-
176
-
177
-
178
- ## 5. Interact with User API
179
-
180
-
181
- ### remote.input
182
-
183
- Talk with assistant, about user and computer. With this api you can create an consulting process.
184
-
185
- ```markdown
186
- `Hi, look to user window and return which app using now`
187
-
188
- `Ask user to is user need any kind of supoprt`
189
-
190
- `Extract the user redis config file.`
191
- ```
192
-
193
- With this questions you will make a shortcut for your needs.
194
- **You can collect informations from user computer or directly from user or user computer.**
195
-
196
- ```python
197
- output = remote.input("Extract the user redis config file.", screen=False)
198
- print(output)
199
- ```
200
-
201
-
202
- <p align="start">
203
-
204
- <a href="https://docs.upsonic.co/gca/dev_guides/interact">
205
- <img src="https://github.com/user-attachments/assets/81614347-ab85-4965-9b77-225d0f2961e9" width="150">
206
- </a>
207
- .
208
- <a href="https://docs.upsonic.co/gca/dev_guides/interact">
209
- <img src="https://github.com/user-attachments/assets/ecaa7590-f4c5-4eda-9482-462cef54aeff" width="150">
210
- </a>
211
- .
212
- <a href="https://docs.upsonic.co/gca/dev_guides/interact">
213
- <img src="https://github.com/user-attachments/assets/0f35df10-b32e-4fa1-936e-b336be46b1bd" width="150">
214
- </a>
215
-
216
- </p>
217
-
218
-
219
-
220
- <p align="start">
221
-
222
- <a href="https://docs.upsonic.co/gca/dev_guides/interact">
223
- <img src="https://github.com/user-attachments/assets/a893c50c-3ede-4b42-90ee-92e2fea82120" width="150">
224
- </a>
225
-
226
- </p>
227
-
228
-
229
- <p align="center">
230
- <br>
231
- <br>
232
- <br>
233
- </p>
234
-
235
-
236
- ## Usage
237
- ![options](https://github.com/khulnasoft/gpt-computer-agent/assets/41792982/37d34745-ae4b-4b37-9bfa-aec070c97897)
238
-
239
-
240
-
241
- ### Use cases
242
-
243
-
244
- <img alt="Screenshot 2024-08-13 at 18 33 52" src="https://github.com/user-attachments/assets/8f994160-893a-4f56-bbf0-4a7aa87af650">
245
-
246
-
247
-
248
-
249
- ## Roadmap
250
- | Feature | Status | Target Release |
251
- |---------------------------------|--------------|----------------|
252
- | Clear Chat History | Completed | Q2 2024 |
253
- | Long Audios Support (Split 20mb) | Completed | Q2 2024 |
254
- | Text Inputs | Completed | Q2 2024 |
255
- | Just Text Mode (Mute Speech) | Completed | Q2 2024 |
256
- | Added profiles (Different Chats) | Completed | Q2 2024 |
257
- | More Feedback About Assistant Status | Completed | Q2 2024 |
258
- | Local Model Vision and Text (With Ollama, and vision models) | Completed | Q2 2024 |
259
- | **Our Customizable Agent Infrastructure** | Completed | Q2 2024 |
260
- | Supporting Groq Models | Completed | Q2 2024 |
261
- | **Adding Custom Tools** | Completed | Q2 2024 |
262
- | Click on something on the screen (text and icon) | Completed | Q2 2024 |
263
- | New UI | Completed | Q2 2024 |
264
- | Native Applications, exe, dmg | Completed | Q3 2024 |
265
- | **Collaborated Speaking Different Voice Models on long responses.** | Completed | Q2 2024 |
266
- | **Auto Stop Recording, when you complate talking** | Completed | Q2 2024 |
267
- | **Wakeup Word** | Completed | Q2 2024 |
268
- | **Continuously Conversations** | Completed | Q2 2024 |
269
- | **Adding more capability on device** | Completed | Q2 2024 |
270
- | **Local TTS** | Completed | Q3 2024 |
271
- | **Local STT** | Completed | Q3 2024 |
272
- | Tray Menu | Completed | Q3 2024 |
273
- | **Global Hotkey** | On the way | Q3 2024 |
274
- | DeepFace Integration (Facial Recognition) | Planned | Q3 2024 |
275
-
276
-
277
-
278
-
279
-
280
-
281
-
282
- ## Capabilities
283
- At this time we have many infrastructure elements. We just aim to provide whole things that already in ChatGPT app.
284
-
285
- | Capability | Status |
286
- |------------------------------------|----------------------------------|
287
- | **Local LLM with Vision (Ollama)** | OK |
288
- | Local text-to-speech | OK |
289
- | Local speech-to-text | OK |
290
- | **Screen Read** | OK |
291
- | **Click to and Text or Icon in the screen** | OK |
292
- | **Move to and Text or Icon in the screen** | OK |
293
- | **Typing Something** | OK |
294
- | **Pressing to Any Key** | OK |
295
- | **Scrolling** | OK |
296
- | **Microphone** | OK |
297
- | **System Audio** | OK |
298
- | **Memory** | OK |
299
- | **Open and Close App** | OK |
300
- | **Open a URL** | OK |
301
- | **Clipboard** | OK |
302
- | **Search Engines** | OK |
303
- | **Writing and running Python** | OK |
304
- | **Writing and running SH** | OK |
305
- | **Using your Telegram Account** | OK |
306
- | **Knowledge Management** | OK |
307
- | **[Add more tool](https://github.com/khulnasoft/gpt-computer-agent/blob/master/gpt_computer_agent/standard_tools.py)** | ? |
308
-
309
- ### Predefined Agents
310
- If you enable it your assistant will work with these teams:
311
-
312
- | Team Name | Status |
313
- |------------------------------------|----------------------------------|
314
- | **search_on_internet_and_report_team** | OK |
315
- | **generate_code_with_aim_team_** | OK |
316
- | **[Add your own one](https://github.com/khulnasoft/gpt-computer-agent/blob/master/gpt_computer_agent/teams.py)** | ? |
317
-
318
-
319
-
320
- <a href="#">
321
- <img src="https://github.com/khulnasoft/gpt-computer-agent/assets/41792982/ba590bf8-6059-4cb6-8c4e-6d105ce4edd2" alt="Logo" >
322
- </a>
323
-
324
-
325
-
326
-
327
- ## Contributors
328
-
329
- <a href="https://github.com/khulnasoft/gpt-computer-agent/graphs/contributors">
330
- <img src="https://contrib.rocks/image?repo=khulnasoft/gpt-computer-agent" />
331
- </a>
 
1
+ ---
2
+ license: mit
3
+ title: gpt-computer-agent
4
+ sdk: streamlit
5
+ emoji: 🚀
6
+ colorFrom: blue
7
+ colorTo: green
8
+ ---