Ducky Script API

REM

Similar to the REM command in Basic and other languages, lines beginning with REM will not be processed. REM is a comment.

Command and parameters

| REM |

 Example

REM The next three lines execute a command prompt in Windows
GUI r
STRING cmd
ENTER

DEFAULT_DELAY or DEFAULTDELAY

DEFAULT_DELAY or DEFAULTDELAY is used to define how long (in milliseconds * 10) to wait between each subsequent command. DEFAULT_DELAY must be issued at the beginning of the ducky script and is optional. Not specifying the DEFAULT_DELAY will result in faster execution of ducky scripts. This command is mostly useful when debugging.

Command and parameters

| DEFAULT_DELAY | //n * 10 ms// |
| DEFAULTDELAY | //n * 10 ms// |

Example

DEFAULT_DELAY 10
REM delays 100ms between each subsequent command sequence

DELAY

DELAY creates a momentary pause in the ducky script. It is quite handy for creating a moment of pause between sequential commands that may take the target computer some time to process. DELAY time is specified in milliseconds from 1 to 10000. Multiple DELAY commands can be used to create longer delays.

Command and parameters

| DELAY | //n * 10 ms// |

Example

DELAY 50
REM will wait 500ms before continuing to the next command.

STRING

STRING processes the text following taking special care to auto-shift. STRING can accept a single or multiple characters.

Command and parameters

| STRING | a…z A…Z 0..9 !…) `~ += _- "' :; <, >. ?/ \ and pipe |

Example

GUI r
DELAY 50
STRING notepad.exe
ENTER
DELAY 100
STRING Hello World!

WINDOWS or GUI

Emulates the Windows-Key, sometimes referred to as the Super-key.

Command and parameters

| GUI | Single Char |
| WINDOWS | Single Char |

Example

GUI r
REM will hold the Windows-key and press r, on windows systems resulting in the Run menu.

MENU or APP

Emulates the App key, sometimes referred to as the menu key or context menu key. On Windows systems this is similar to the SHIFT F10 key combo, producing the menu similar to a right-clic.

Command and parameters

| APP |
| MENU |

Example

GUI d
MENU
STRING v
STRING d

 
//Switch to desktop, pull up context menu and choose actions v, then d toggles displaying Windows desktop icons//

SHIFT

Unlike CAPSLOCK, cruise control for cool, the SHIFT command can be used when navigating fields to select text, among other functions.

Command and parameters

| SHIFT | DELETE, HOME, INSERT, PAGEUP, PAGEDOWN, WINDOWS, GUI, UPARROW, DOWNARROW, LEFTARROW, RIGHTARROW, TAB |

Example

SHIFT INSERT
REM this is paste for most operating systems

ALT

Found to the left of the space key on most keyboards, the ALT key is instrumental in many automation operations. ALT is envious of CONTROL.

Command and parameters

| ALT |END, ESC, ESCAPE, F1…F12, Single Char, SPACE, TAB |

Example

GUI r
DELAY 50
STRING notepad.exe
ENTER
DELAY 100
STRING Hello World
ALT f
STRING s
REM alt-f pulls up the File menu and s saves. This two keystroke combo is why ALT is jealous of CONTROL's leetness and CTRL+S

CONTROL or CTRL

The king of key-combos, CONTROL is all mighty.

Command and parameters

| CONTROL | BREAK, PAUSE, F1…F12, ESCAPE, ESC, Single Char |
| CTRL | BREAK, PAUSE, F1…F12, ESCAPE, ESC, Single Char |

Example

CONTROL ESCAPE
REM this is equivalent to the GUI key in Windows

Arrow Keys

Command and parameters

| DOWNARROW or DOWN |
| LEFTARROW or LEFT |
| RIGHTARROW or RIGHT |
| UPARROW or UP |

Extended Commands

Command and notes

| BREAK or PAUSE | For the infamous combo CTRL BREAK |
| CAPSLOCK | Cruise control for cool. Toggles |
| DELETE | |
| END | When will it ever |
| ESC or ESCAPE | You can never |
| HOME | There's no place like |
| INSERT | |
| NUMLOCK | Toggles number lock |
| PAGEUP | |
| PAGEDOWN | |
| PRINTSCREEN | Typically takes screenshots |
| REPEAT X | Repeat previous command X times |
| SCROLLLOCK | Hasn't been nearly as useful since the GUI was invented |
| SPACE | the final frontier | 
| TAB | not just a cola.