Quick Start

Two ways in, both on this page: the CLI — a natural-language task as a shell command, no code — and the Python SDK. Start with the CLI even if you came for the SDK: it proves your setup in one line. (No model API keys to configure — the vision models are hosted server-side.)

Two commands — log in once (opens your browser to authorize; on a headless box, open the printed URL from any device), then hand the AI a task:

qirabot login      # browser authorization; verified, stored, picked up by every later run
qirabot browser "Search for SpaceX and get the first sentence of the article" --url wikipedia.org

That's a complete run: the browser opens, the AI does the task, and the result (plus an HTML report) lands in your terminal. All commands and options are in the CLI Reference. (Prefer environment variables? QIRA_API_KEY and a project .env still work and take precedence.)

The browser command assumes you took the one-line installer or pip install "qirabot[browser]" path — if you installed bare qirabot for a device backend, see Installation for the extras.

The same task in Python

bot.ai() is the same engine the CLI command runs: the AI looks at the screen, decides the next action, and loops until the task is done:

from qirabot import Qirabot

bot = Qirabot()
page = bot.open("https://www.wikipedia.org")

result = bot.ai(page, "Search for SpaceX and get the first sentence of the article")
print(f"Success: {result.success}")
print(f"Result: {result.output}")

bot.close()

Deterministic steps

When you want to drive each step yourself instead of delegating the whole task, the same natural-language targeting is available as single-step calls — fast, low-cost, and under your control flow:

from qirabot import Qirabot

bot = Qirabot()
page = bot.open("https://www.saucedemo.com")

# Describe each element in natural language (any language works);
# AI vision locates it, your code stays in control:
bot.type_text(page, "the Username field", "standard_user")
bot.type_text(page, "the Password field", "secret_sauce")
bot.click(page, "the Login button")

# Gate on visual state — wait_for polls until true, raises on timeout
bot.wait_for(page, "the Products page is shown")

# Pull structured data straight off the screen — no scraping, no selectors
count = bot.extract(page, "the number on the cart badge as an integer")

bot.close()

The core calls:

Call	What it does
bot.ai(target, task)	Autonomous multi-step task — see, decide, act, loop until done
bot.click(target, "desc")	AI-located click (also double_click, type_text)
bot.extract(target, "desc")	Pull structured data from the screen
bot.verify(target, "assertion")	Visual assertion — truthy/falsy result, a failed check doesn't raise
bot.wait_for(target, "condition")	Poll until a visual condition holds, else raise

target is whatever surface you're driving — the page returned by bot.open(), a Playwright/Selenium/Appium object of your own, or the pyautogui module for the desktop. The full call list and per-platform behavior is in the API reference.

How a run ends

result.success is the pass/fail verdict; result.status says why: "completed", "goal_failed" (login wall, captcha), "max_steps" (budget truncation — retry with more steps), or "error". Details and the exception hierarchy are in Error Handling.

result = bot.ai(page, "Find the cheapest flight and hold it")
if result.status == "max_steps":
    # not a real failure — the budget was too small; retry with headroom
    result = bot.ai(page, "Find the cheapest flight and hold it", max_steps=50)

Reports

Every run writes a self-contained HTML report with per-step screenshots to ./qira_runs/<date>/<time-id>/ — including on error or Ctrl+C, so you can see where it stopped. Pass record=True (or --record on the CLI) to also capture a video of the run.

Next steps

• Pick your backend: Browser · Android · iOS · Windows & Games · Desktop
• Bolting onto an existing Playwright / Selenium / Appium suite? See Custom Adapters & Bolt-On
• CLI Reference