​

AskUI Agent OS Commands

This page provides a comprehensive overview of all available commands in AskUI Agent OS, organized by category. Each command includes a description and its available parameters.

​

Project Management

​

AskUI-CreateProject

Creates a new AskUI project with your specified configuration.

Parameters:

• ProjectName: Name for your new project
• WorkspaceID: Your AskUI workspace identifier
• Token: Your AskUI authentication token
• AskUINodeJsVersion: Version of AskUI Node.js to install (defaults to latest)
• SkipChangingPathUserPrompt: Skip directory change prompt (true/false)
• TestFramework: Choose ‘jest’ or ‘jasmine’
• UsingProxy: Enable proxy usage (true/false)
• TypeScriptConfig: Overwrite tsconfig.json (true/false)

​

AskUI-RunProject

Executes an existing AskUI project.

​

Controller Management

​

AskUI-StartController

Launches the AskUI Controller with your configuration.

Parameters:

• DisplayNum: Display number to use (default: 0)
• Maximize: Launch in maximized window mode
• Runtime: Select ‘desktop’ or ‘android’ (default: desktop)
• Port: WebSocket server port (default: 6769)
• ActionWaitTime: Milliseconds to wait after each action (default: 1000)
• WebSocketHost: WebSocket server host (default: 127.0.0.1)
• LogFile: Path for log output
• LogLevel: Logging detail level (default: debug)
• RunInBackground: Run in background mode
• ShowOverlay: Display status indicator around selected screen (experimental)
• DeviceId: Android device identifier (e.g., emulator-5554)

​

AskUI-ShowControllers

Displays information about all running AskUI Controllers.

​

AskUI-StopControllers

Terminates running AskUI Controllers.

Parameters:

• DisplayNum: Display number to target (default: 0, with autocompletion)
• Runtime: Target runtime environment (default: desktop, with autocompletion)
• Port: Controller’s WebSocket port (default: 6769, with autocompletion)
• DeviceId: Android device identifier (e.g., emulator-5554)

​

Settings Management

​

AskUI-SetSettings

Configure Agent OS settings.

Parameters:

• HttpProxy: HTTP proxy address
• HttpsProxy: HTTPS proxy address
• Token: AskUI authentication token
• WorkspaceId: AskUI workspace identifier
• LogLevel: Logging detail level
• Location: Settings scope (User or Project, default: User)
• TLSConnectionCertificate: Server identity certificate to accept

​

AskUI-ShowSettings

Displays current Agent OS settings.

​

AskUI-RemoveSettings

Removes specific settings from Agent OS.

Parameters:

• HttpProxy: Remove HTTP proxy setting
• HttpsProxy: Remove HTTPS proxy setting
• Token: Remove authentication token
• WorkspaceId: Remove workspace identifier
• LogLevel: Remove log level setting
• Credentials: Remove all credential settings
• EnvironmentVariables: Remove all environment variables
• Location: Settings scope to modify (User or Project, default: User)

​

Runner Management

​

AskUI-StartRunner

Launches the AskUI Runner with your configuration.

Parameters:

• Token: Authentication token (falls back to settings if not specified)
• WorkspaceId: Workspace identifier (falls back to settings if not specified)
• Port: WebSocket server port (default: 6769)
• WebSocketHost: WebSocket server host (default: 127.0.0.1)
• ForceProjectTemplateUpdate: Force project template update (useful for debugging)
• LogLevel: Runner log level (‘INFO’, ‘DEBUG’, ‘WARNING’, ‘ERROR’, ‘CRITICAL’, default: ‘INFO’)
• Tags: Tags for runner configuration

​

AskUI-GetRunnerVersion

Retrieves version information for the installed AskUI Runner.

​

AskUI-InstallRunner

Installs or updates the AskUI Runner.

Parameters:

• Version: Specific version to install (installs latest if not specified)

​

AskUI-OpenAgent

Opens the specified agent or workspace directory.

Parameters:

• WorkspaceId: Workspace identifier (uses settings value if not specified)
• Token: Authentication token (uses settings value if not specified)

​

AskUI-ShowAgents

Lists all available AskUI Agents in your environment.

Parameters:

• WorkspaceID: Filter agents by workspace identifier

​

AskUI-SyncAgents

Synchronizes agent files between local and remote locations.

Parameters:

• Direction: Synchronization direction (‘Up’ or ‘Down’)
• Dry: Perform a dry run without making changes
• Delete: Remove files in destination that don’t exist in source

​

Process Management

​

AskUI-ShowProcess

Displays all running AskUI processes.

​

AskUI-StopProcess

Terminates running AskUI processes.

Parameters:

• All: Stop all AskUI processes
• ProcessName: Stop process by name (supports autocompletion and wildcards)
• ProcessId: Stop process by ID (supports autocompletion)

​

Error Reporting

​

AskUI-BuildErrorReport

Creates an error report for troubleshooting.

Parameters:

• Project: Project paths to include (default: empty list)
• AdditionalFiles: Additional files to include (default: empty list)
• MaxLogFileAgeInHours: Maximum age of log files to include (default: 96 hours)

​

AskUI-CompressErrorReport

Compresses an error report for sharing.

Parameters:

• ErrorReportGUID: (Required) Error report identifier to compress
• SkipCleanup: Preserve expanded report directory after compression

​

AskUI-NewErrorReport

Creates and prepares a new error report.

Parameters:

• Project: Project paths to include (default: empty list)
• AdditionalFiles: Additional files to include (default: empty list)
• MaxLogFileAgeInHours: Maximum age of log files to include (default: 96 hours)
• SkipCleanup: Preserve expanded report directory after compression
• AutoApprove: Automatically approve report content without confirmation

​

AI and Training

​

AskUI-NewAIElement

Creates a new AI Element for use in AskUI workflows.

​

AskUI-NewAnnotationsForTraining

Creates annotations for training AskUI models.

Parameters:

• WorkspaceId: Workspace identifier (uses settings value if not specified)
• Delay: Seconds to wait before freezing the screen (default: 0)

​

AskUI-StartOCRTeaching

Launches the OCR teaching tool to improve text recognition.

​

Experimental

​

AskUI-ImportDebugCommands

Imports debug commands for advanced troubleshooting.

​

AskUI-ImportExperimentalCommands

Imports experimental commands for testing new features.