Core Concepts
Single-Step Actions
Welcome to the home of your new documentation
Single-Step Actions in AskUI
AskUI provides a comprehensive set of single-step actions that allow you to interact with any UI element on your screen. These actions range from basic mouse clicks to complex keyboard combinations and system operations.
Core Interaction Commands
Description | Models | Example (Python) | |
---|---|---|---|
click() | Clicks on an element described by text | All | agent.click('Login button') |
type() | Types text into a focused element | All | agent.type('username@example.com', "Username input field") |
mouse_move() | Moves the mouse over located element | All | agent.mouse_move('red button') |
Detailed usage on how to use click can be found here.
Tools
AskUI provides several built-in tools to interact with the operating system and applications:
Description | Example (Python) | |
---|---|---|
os | Provides OS-level operations | agent.tools.os.keyboard_release() |
webbrowser | Controls web browser operations | agent.tools.webbrowser.open_new("https://askui.com") |
clipboard | Manages clipboard operations | agent.tools.clipboard.copy("Text to copy") |
Assertion and Information Commands
Description | Models | Example (Python) | |
---|---|---|---|
get() | Extracts text or information from the screen | sonnet-3.5-latest | text = agent.get('What is the value in the total field?') |
Was this page helpful?