Browser automation CLI reference

Usage: okyra [OPTIONS] <COMMAND>

Options:
  -p, --page <PAGE>  Page label. Pages open on first use and stay open between calls [default: p1]
  -h, --help         Print help
  -V, --version      Print version

okyra --page p2 goto https://example.com
okyra pages                # ["p1", "p2"]

Run the daemon in the foreground. Clients start it on their own

Usage: okyra daemon [OPTIONS]

Options:
      --headful                Show the browser window
      --chrome <CHROME>        Chromium based browser binary. Defaults to OKYRA_CHROME or a known install
      --connect <CONNECT>      Attach to a running browser instead: brave, chrome, edge, chromium, a user data folder or a ws:// URL. Defaults to OKYRA_CONNECT
      --idle-secs <IDLE_SECS>  Exit after this many idle seconds. Default 1800, or a day when attached, since each new attach asks the user to allow it again

okyra daemon --headful --idle-secs 600

Serve MCP over stdio for AI agents: `claude mcp add okyra -- okyra mcp`

Usage: okyra mcp [OPTIONS]

claude mcp add okyra -- okyra mcp

Check the daemon answers. Does not start the browser

Usage: okyra ping [OPTIONS]

okyra ping                 # pong

Daemon pid, uptime and whether the browser is running

Usage: okyra status [OPTIONS]

okyra status               # {"browser_started": false, "connect": null, "pid": 30205, "uptime_ms": 13}

Browser name and protocol version. Starts the browser if needed

Usage: okyra version [OPTIONS]

okyra version              # {"product": "Chrome/151.0.7922.173", "protocolVersion": "1.3", ...}

Stop the daemon and its browser

Usage: okyra stop [OPTIONS]

okyra stop                 # stopping   (or: not running)

List open pages

Usage: okyra pages [OPTIONS]

okyra pages                # ["p1", "p2"]

Close a page

Usage: okyra close [OPTIONS]

okyra --page p2 close

Open a URL and wait for it to load

Usage: okyra goto [OPTIONS] <URL>

Arguments:
  <URL>

okyra goto https://news.ycombinator.com
{
  "settled": true,
  "title": "Hacker News",
  "url": "https://news.ycombinator.com/"
}

Click an element: a snapshot ref, role and name, x,y point, or CSS selector

Usage: okyra click [OPTIONS] <TARGET>

Arguments:
  <TARGET>

okyra click 'button "Log in"'

Replace the text in a field

Usage: okyra type [OPTIONS] <TARGET> <TEXT>

Arguments:
  <TARGET>
  <TEXT>

okyra type 'textbox "Email"' ana@example.com
okyra type 'textbox "Delivery time:"' 18:30   # date and time inputs too

Attach files to a file input, or its label or a box holding it

Usage: okyra upload [OPTIONS] <TARGET> <FILES>...

Arguments:
  <TARGET>
  <FILES>...

okyra upload '#cv-button' cv.pdf      # a label for a hidden file input works
{
  "files": ["/home/ana/cv.pdf"]
}

Move the mouse over an element and print the text that appeared, such as a tooltip

Usage: okyra hover [OPTIONS] <TARGET>

Arguments:
  <TARGET>

okyra hover 'circle.dot'    # Lisbon: 24 °C

Pick a dropdown option by value or visible text

Usage: okyra select [OPTIONS] <TARGET> <VALUE>

Arguments:
  <TARGET>
  <VALUE>

okyra select 'combobox "Crust"' "Deep pan"    # prints the option picked: Deep pan

Press a key: Enter, Tab, Escape, arrows, or one character

Usage: okyra press [OPTIONS] <KEY>

Arguments:
  <KEY>

okyra press Enter

Scroll the window by pixels, or an element into view with --to

Usage: okyra scroll [OPTIONS] [DY]

Arguments:
  [DY]  [default: 0]

Options:
      --dx <DX>      [default: 0]
      --to <TO>

okyra scroll 600                       # down 600 px; prints where it ended, {"x": 0, "y": 430}
okyra scroll --to 'button "Next"'       # into view

Text outline of the page; refs like @e7 work as click and type targets

Usage: okyra snapshot [OPTIONS]

Options:
  -i, --interactive            Only interactive elements
      --max-lines <MAX_LINES>

okyra snapshot -i
page "Bank login" file:///…/login.html
scroll 0 of 819
form:
  textbox "Email" @e1
  textbox "Password" @e2 (password)
  button "Log in" @e3

Print the visible text of an element

Usage: okyra text [OPTIONS] <TARGET>

Arguments:
  <TARGET>

okyra text .balance        # €1,240

Print every match as JSON: table rows as cell arrays, list items as text

Usage: okyra extract [OPTIONS] <TARGET>

Arguments:
  <TARGET>

Options:
      --limit <LIMIT>

okyra extract '#rows tr' --limit 2
[
  ["item 1", "10"],
  ["item 2", "11"],
  "… 8 more, raise limit to see them"
]

Run JavaScript in the page and print the result

Usage: okyra eval [OPTIONS] <EXPRESSION>

Arguments:
  <EXPRESSION>

okyra eval 'document.title'    # Dashboard

Save a PNG screenshot and print its path. Image pixels are CSS pixels, so a point on it (420,260) works as a target

Usage: okyra screenshot [OPTIONS] [PATH]

Arguments:
  [PATH]

Options:
      --annotate     Draw each visible element's ref on the image and list the refs

okyra screenshot --annotate /tmp/order.png
{
  "path": "/tmp/order.png",
  "refs": [
    "@e1 textbox \"Customer name:\" at 194,27",
    "@e5 combobox \"Crust\" at 87,238",
    "@e7 button \"Submit order\" at 54,314"
  ]
}

Run a plan: a JSON file (or - for stdin) with many steps, one call

Usage: okyra run [OPTIONS] <PLAN>

Arguments:
  <PLAN>

okyra run login.json
cat login.json | okyra run -

Wait until no requests run and the DOM is quiet, or sleep --ms

Usage: okyra wait [OPTIONS]

Options:
      --ms <MS>
      --quiet-ms <QUIET_MS>
      --timeout-ms <TIMEOUT_MS>

okyra wait                               # {"waited_ms": 502}
okyra wait --quiet-ms 800 --timeout-ms 5000
okyra wait --ms 250                      # plain sleep

Plan, company, runners and expiry of this machine's key

Usage: okyra license status [OPTIONS]

okyra license status
licence: none
okyra: free for personal and noncommercial use and 30 day evaluation. Business use needs a licence: okyra.sthlabs.net/pricing

Check a key file (or - for stdin) and save it to ~/.config/okyra/license

Usage: okyra license install [OPTIONS] <FILE>

Arguments:
  <FILE>

okyra license install key.txt
okyra license install - < key.txt

Write SKILL.md to ~/.claude/skills/okyra, or $CLAUDE_CONFIG_DIR/skills/okyra

Usage: okyra skill install [OPTIONS]

Options:
      --dir <DIR>    Folder to write SKILL.md into, for other agents or a project
      --force        Replace a SKILL.md that differs from this version's

okyra skill install
okyra skill install --dir .claude/skills/okyra

Print SKILL.md, for agents without a skills folder

Usage: okyra skill print [OPTIONS]

okyra skill print