This guide shows you how to report bugs, generate diagnostic information, and get help from the AskUI team.

​
Before Reporting an Issue

​
1. Gather System Information

# In askui-shell
AskUI-ShowVersions

Save this output - support will need it.

​
2. Check Existing Resources

​
3. Document the Problem

Prepare these details:

  • Steps to reproduce the issue
  • Expected behavior vs actual behavior
  • Error messages (exact text or screenshots)
  • Your code snippet that triggers the issue

​
Generating Error Reports

​
Automatic Error Report

The fastest way to collect diagnostic information:

  1. Open Terminal/PowerShell
  2. Enter askui-shell
  3. Import experimental commands: 
    AskUI-ImportExperimentalCommands
  4. Generate the report: 
    AskUI-NewErrorReport

​
Error Report Process

When you run AskUI-NewErrorReport:

(base) ADE C:\Users\AskUi\> AskUI-NewErrorReport
Info:  Generating a new error report...
Info:  Error description file created at 'C:\Users\AskUi\.askui\ErrorReports\[GUID]\ErrorDescription.md'
Do you want to open the error report directory? (y/n): n
Do you approve the error report content? (y/n): y
Info:  Error report compressed at 'ErrorReport-[GUID]-[DATE].zip'
Info:  Submitting error report...
Info:  Error report was submitted successfully.

​
What’s Included in Error Reports

  • System information and versions
  • AskUI configuration (workspace ID only, no tokens)
  • Recent logs from AskUI processes
  • Error stack traces
  • Environment details

Your access tokens and sensitive data are NOT included in error reports.

​
Manual Diagnostic Collection

If automatic reporting fails, collect manually:

​
1. System Information

# Save all diagnostic info
AskUI-ShowVersions > askui_diagnostics.txt
AskUI-ShowSettings >> askui_diagnostics.txt
AskUI-ShowProcess >> askui_diagnostics.txt
AskUI-ShowControllers >> askui_diagnostics.txt

​
2. Python Environment

# Python and package versions
python --version
pip show askui
pip list | grep askui

​
3. Screenshot of Issue

# Capture what AskUI sees
from askui import VisionAgent

with VisionAgent() as agent:
    agent.save_screenshot("issue_screenshot.png")

​
4. Debug Logs

# Enable debug logging
import logging
logging.basicConfig(level=logging.DEBUG)

# Run your problematic code
# Copy the debug output

​
Contacting Support

​
Email Support

Send reports to: support@askui.com

Include:

  1. Error report ZIP file (from AskUI-NewErrorReport)
  2. Description of the issue
  3. Impact on your work
  4. Any workarounds you’ve tried

​
Discord Community

Join our Discord server:

  • Post in #support channel
  • Share error reports and screenshots
  • Get help from community and AskUI team

​
GitHub Issues

For confirmed bugs:

  1. Visit AskUI GitHub
  2. Check existing issues first
  3. Create new issue with:
    • Clear title
    • Reproduction steps
    • Environment details
    • Error messages

​
Response Times

  • Email: 24-48 business hours
  • Discord: Community responses often within hours
  • Critical Issues: Mark as “URGENT” in email subject

​
Providing Feedback

​
Feature Requests

Send ideas to: feedback@askui.com

Include:

  • Use case description
  • Current workaround (if any)
  • Expected benefit

​
Documentation Improvements

Found an error or unclear section?

  • Email specific page and issue
  • Suggest improvements
  • Share what confused you

​
Common Support Scenarios

​
”It works on my machine but not in CI/CD”

Provide:

  • Local environment details (from AskUI-ShowVersions)
  • CI/CD environment details
  • Differences in configuration
  • CI/CD logs

​
”Element not found” Issues

Include:

  • Screenshot from agent.save_screenshot()
  • Your selector code
  • HTML/UI framework being automated

​
Performance Problems

Share:

  • Time measurements
  • System resources (CPU, RAM)
  • Number of agents running
  • Size of UI being automated

​
Self-Service Resources

Before contacting support, try:

  1. Documentation Search: Use search feature in docs
  2. Discord History: Search previous discussions
  3. YouTube Tutorials: Check AskUI YouTube
  4. Blog Posts: Visit blog.askui.com

​
Enterprise Support

Enterprise customers have additional options:

  • Dedicated support channel
  • Priority response times
  • Direct access to engineering team
  • Custom training sessions

Contact your account manager for details.

​
Next Steps