You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Press Command+Space, type "terminal", and press Enter
@@ -80,7 +78,7 @@ alembic upgrade head
80
78
{% endtab %}
81
79
{% endtabs %}
82
80
83
-
# Permissions(IMPORTANT)
81
+
##Permissions(IMPORTANT)
84
82
85
83
See how to set up system permissions on macOS [here](https://github.com/OpenAdaptAI/OpenAdapt/blob/main/permissions_in_macOS.md).
86
84
@@ -89,9 +87,9 @@ See how to set up system permissions on macOS [here](https://github.com/OpenAdap
89
87
`pytest` to verify that the installation was successful.
90
88
{% endhint %}
91
89
92
-
##Usage
90
+
# Usage
93
91
94
-
# Shell
92
+
##Shell
95
93
96
94
Run this in every new terminal window once (while inside the `OpenAdapt` root directory) before running any `openadapt` commands below. This is required to activate the pythom environment:
97
95
@@ -108,20 +106,21 @@ Using python3.10 (3.10.13)
108
106
109
107
Notice the environment prefix `(openadapt-py3.10)`.
- Recording should be short (i.e. under a minute), as they are somewhat memory intensive, and there is currently an [open issue](https://github.com/OpenAdaptAI/OpenAdapt/issues/5) describing a possible memory leak.
166
165
- The only touchpad and trackpad gestures currently supported are pointing the cursor and left or right clicking, as described in this [open issue](https://github.com/OpenAdaptAI/OpenAdapt/issues/145)
167
166
168
-
# Visualize
167
+
##Visualize
169
168
170
169
- Quickly visualize the latest recording you created by running the following command:
171
170
172
171
`python -m openadapt.visualize`
173
172
174
173
This will generate an HTML file and open a tab in your browser that looks something like this:
See [strategy list](https://github.com/OpenAdaptAI/OpenAdapt/tree/main/openadapt/strategies) for a complete list. More ReplayStrategies coming soon!
215
215
216
-
##Features
216
+
# Features
217
217
218
-
# System Tray Icon and Client GUI App(work-in-progress)
218
+
##System Tray Icon and Client GUI App(work-in-progress)
# Detailed performance monitoring via [pympler](https://pympler.readthedocs.io/en/latest/) and [tracemalloc](https://docs.python.org/3/library/tracemalloc.html):
224
+
##Detailed performance monitoring via [pympler](https://pympler.readthedocs.io/en/latest/) and [tracemalloc](https://docs.python.org/3/library/tracemalloc.html):
Copy file name to clipboardExpand all lines: getting-started/welcome-to-openadapt/user-guide.md
+26-3
Original file line number
Diff line number
Diff line change
@@ -2,8 +2,6 @@
2
2
description: Installing OpenAdapt
3
3
---
4
4
5
-
# User Guide
6
-
7
5
{% hint style="info" %}
8
6
**Experiencing difficulty? Get support on our**[**Discord**](https://discord.gg/QKPuDqhDHF)**.**
9
7
{% endhint %}
@@ -20,11 +18,17 @@ We have builds available for Windows and Mac
20
18
{% endhint %}
21
19
22
20
- Download the OpenAdapt application from [here](https://openadapt.ai/#start)
21
+
23
22
23
+
24
24
- Extract the zip
25
+
25
26
27
+
26
28
- Click on the extracted application
29
+
27
30
- It creates an app-tray on top right. This app tray can be used to control the application.
31
+
28
32
29
33
30
34
@@ -33,8 +37,11 @@ We have builds available for Windows and Mac
33
37
Now after the application is installed, you can start recording following the steps explained.
34
38
35
39
- Click the record button in the app-tray
40
+
36
41
- It opens up a prompt to name your recording
42
+
37
43
44
+
38
45
- Give it a name and click ok. Now the recording starts.
39
46
40
47
@@ -43,6 +50,7 @@ Now after the application is installed, you can start recording following the st
43
50
To end the recording you can simply
44
51
45
52
- Click the stop recording button in the app-tray and the recording is saved.
53
+
46
54
47
55
48
56
@@ -51,7 +59,9 @@ To end the recording you can simply
51
59
To replay the saved recordings
52
60
53
61
- Click on replay in the app-tray. It opens list of all the recordings.
62
+
54
63
64
+
55
65
- Click on the recording you want to replay. This will open up a prompt to choose the **replay strategy** & **replay instructions**
56
66
57
67
@@ -68,9 +78,13 @@ To replay the saved recordings
68
78
You can visualize data about your recording events too.
69
79
70
80
- Click on visualize in the app-tray
81
+
71
82
- Choose the recording you want to visualize
83
+
72
84
85
+
73
86
- It opens an HTML page with extensive details about the events in your recordings
87
+
74
88
75
89
76
90
@@ -79,7 +93,9 @@ You can visualize data about your recording events too.
79
93
If you want to delete any recording from OpenAdapt, you can do it easily.
80
94
81
95
- Click on delete button in app-tray
96
+
82
97
- A list of available recordings appear
98
+
83
99
- Choose the recording to delete
84
100
85
101
@@ -88,18 +104,25 @@ If you want to delete any recording from OpenAdapt, you can do it easily.
88
104
You can now control OpenAdapt from the GUI recently introduced. You can easily see all the **recordings**, **get recording data**, **change setting such as API keys**, choose to **scrubb a recording**, **replays** etc
89
105
90
106
- Click on dashboard in the app-tray
107
+
91
108
- A GUI opens on your browser similar to this
109
+
92
110
111
+
93
112
- On settings page you can change API keys, turn on scrub etc
113
+
94
114
95
115
96
116
97
-
# Scrubbing
117
+
##Scrubbing
98
118
99
119
You can now scrub a recording of your choice and it gets processed.
100
120
101
121
- In the dashboard settings, turn on scrubbing.
122
+
102
123
- Navigate to scrubbing and choose a recording to scrub. Choose the provider
0 commit comments