1= KeePassXC - Auto-Type
2:imagesdir: ../images
3
4// tag::content[]
5== Auto-Type
6The Auto-Type feature acts like a virtual keyboard to populate data from your entries directly into the corresponding websites or applications that you use. You can use the Auto-Type feature on a global level or entry level. Each entry can be configured to be associated with a particular window title and multiple Auto-Type sequences can be pre-defined and selected upon use.
7
8NOTE: Auto-Type is a completely separate feature from Browser Integration. You do not need to have the KeePassXC browser extension installed in your browser to use Auto-Type.
9
10WARNING: Auto-Type will be disabled when run with a Wayland compositor on Linux. To use Auto-Type in this environment, you must set `QT_QPA_PLATFORM=xcb` or start KeePassXC with the `-platform xcb` command-line flag.
11
12=== Configure Global Auto-Type
13You can define a global Auto-Type hotkey that starts the Auto-Type process. To configure the hotkey, perform the following steps:
14
151. Navigate to _Tools_ -> _Settings_ -> Auto-Type tab *(1)*. Click into the _Global Auto-Type shortcut_ box and press the desired key combination that will trigger the Auto-Type process *(2)*.
16+
17.Auto-Type settings
18image::autotype_settings.png[]
19+
20You can configure additional Auto-Type settings in this window such as start delay, inter-key typing delay, and matching options. If Auto-Type is not working well for you, try adjusting the default delays.
21
22=== Configure Auto-Type Sequences
23Each entry in your database can have multiple Auto-Type sequences associated with various window titles. Simulated key presses can be sent to any other currently open window of your choice (web browser windows, login dialogs boxes, and so on). When the Global Auto-Type hotkey is pressed, KeePassXC will search your database for entries matching the current selected window title.
24
25NOTE: The default Auto-Type sequence is `{USERNAME}{TAB}{PASSWORD}{ENTER}`. This means that it first types the username of the selected entry, then presses the `Tab` key, then types the password of the entry and finally presses the `Enter` key.
26
27To configure Auto-Type sequences for your entries, perform the following steps:
28
291.	Navigate to the entries list and open the desired entry for editing. Click the _Auto-Type_ item from the left-hand menu bar *(1)*. Press the `+` button *(2)* to add a new sequence entry. Select the desired window using the drop-down menu, or simply type a window title in the box *(3)*. You can use wildcard `*` to match any value (e.g., when a window title contains a filename or website name).
30+
31.Auto-Type entry sequences
32image::autotype_entry_sequences.png[]
33
342. _(Optional)_ Define a custom auto-type sequence for each window title match by selecting the _Use specific sequence for this association_ checkbox. Sequence action codes and field placeholders are detailed in the following table. A complete list of supported actions and placeholders can be found at https://keepass.info/help/base/autotype.html#autoseq[KeePass Auto-Type Action Codes] and https://keepass.info/help/base/placeholders.html[KeePass Placeholders]. Action codes and placeholders are not case sensitive.
35+
36[grid=rows, frame=none, width=70%]
37|===
38|Action Code |Description
39
40|{TAB}, {ENTER}, {SPACE}, {INSERT}, {DELETE}, {HOME}, {END}, {PGUP}, {PGDN}, {BACKSPACE}, {CAPSLOCK}, {ESC}
41|Press the corresponding keyboard key
42
43|{UP}, {DOWN}, {LEFT}, {RIGHT}  |Press the corresponding arrow key
44|{F1}, {F2}, ..., {F16}         |Press F1, F2, etc.
45|{LEFTBRACE}, {RIGHTBRACE}      |Press `{` or `}`, respectively
46|{DELAY=X}     |Set key press delay to X milliseconds
47|{DELAY X}     |Delay typing start by X milliseconds
48|{CLEARFIELD}  |Clear the input field before typing
49|{TOTP}        |Insert calculated TOTP value (if configured)
50|{<ACTION> X}  |Repeat <ACTION> X times (e.g., {SPACE 5} inserts five spaces)
51|===
52+
53[grid=rows, frame=none, width=70%]
54|===
55|Placeholder |Description
56
57|{TITLE}    |Entry Title
58|{USERNAME} |Username
59|{PASSWORD} |Password
60|{URL}      |URL
61|{NOTES}    |Notes
62|{TOTP}     |Current TOTP value (if configured)
63|{DT_SIMPLE} |Current date-time
64|{DB_DIR}   |Absolute directory path for database file
65|{S:<ATTRIBUTE_NAME>}   |Value for the given attribute name
66|{REF:<FIELD>@<SEARCH_IN>:<SEARCH_TEXT>} |Search for a field in another entry using the reference syntax.
67|===
68
69=== Performing Global Auto-Type
70The global Auto-Type keyboard shortcut is used when you have focus on the window you want to type into. To make use of this feature, you must have previously configured an Auto-Type hotkey.
71
72Pressing the global Auto-Type hotkey cause KeePassXC to search the database for entries that match the window title. Multiple matches may be returned and will cause the sequence selection dialog to appear. Click on a sequence line will immediately execute the Auto-Type action. A search box is also available in case numerous matches are returned.
73
74.Auto-Type sequence selection
75image::autotype_selection_dialog.png[,70%]
76
77TIP: The _Sequence_ column will only appear when there are different sequences defined by one or more entries displayed in the selection dialog.
78
79=== Performing Entry-Level Auto-Type
80You can quickly activate the default Auto-Type sequence for a particular entry using Entry-Level Auto-Type. For this operation, the KeePassXC window will be minimized and the Auto-Type sequence occurs in the previously selected window. You can perform Entry-Level Auto-Type from the toolbar icon *(A)*, entry context menu *(B)*, or by pressing `Ctrl+Shift+V`.
81
82WARNING: Be careful when using Entry-Level Auto-Type as you can inadvertently type into the wrong window. For example, a chat window or email.
83
84.Entry-Level Auto-Type
85image::autotype_entrylevel.png[]
86// end::content[]