For AI agents: the complete documentation index is available at /next/llms.txt, the full documentation bundle is available at /next/llms-full.txt, and this page is available as Markdown at /next/ai/agent-lynx/index.md.
AI logo
AI
  • English
  • agent-lynx

    agent-lynx — Lynx for your agent: the knowledge and tools to build, debug, and verify Lynx apps.

    It combines a CLI, a typed Connector API, and bundled skills. Agents can inspect and operate a running page, diagnose performance and memory issues, record page runtime state for replay, and use runtime feedback to verify code changes.

    How It Connects to Your App

    The agent issues CLI commands on your computer. A shared local daemon keeps the connection to the Lynx app, routes commands to the selected page, and returns runtime feedback. The app exposes a client; its pages expose sessions.

    From an agent command to a running Lynx appInspect → act → verify
    COMPUTER RUNNING YOUR AGENT
    Your agentagent-lynx CLIRun a task, return the result
    agent-lynx daemonKeep connections and page refs across calls@e1 · @e2 · @e3
    DevTool protocol
    DEVICE OR DESKTOP
    Lynx appA client is an app process
    Sessions · Lynx pages
    Page 1Page 2

    Device commands start the local daemon automatically. Each command ends; the daemon keeps the device connection and snapshot refs ready for the next call.

    Get Started

    Follow Getting Started to install agent-lynx, give your agent the bundled instructions, and inspect your first page. For scripts and integrations, use the programmatic APIs.

    Explore by Function

    TaskGuide
    Discover apps and sessions, open pages, and manage connectionsConnections
    Read the element tree, inspect text and styles, interact, and waitPage Inspection and Interaction
    Capture annotated, fullscreen, or scrollable-content imagesScreenshots
    Read logs and sources, evaluate code, and send protocol requestsLogs and Runtime Debugging
    Inspect, find, link, and update componentsReactLynx Components
    Record and analyze traces, inspect memory, and capture JS heapsPerformance and Memory
    Record page runtime state for deterministic replayRecorder
    Read and change runtime switchesRuntime Settings
    Automate with CLI subprocesses or the Connector APIProgrammatic APIs

    The CLI reference lists all public commands, output controls, and environment settings. For connection and inspection issues, see Troubleshooting.

    Skills and Project Context

    The bundled skills provide instructions for using agent-lynx; the CLI and APIs execute the operations. Discover them with agent-lynx skills list, then load the relevant instructions with agent-lynx skills get <name>. Agent Skills also provide Lynx development knowledge, and AGENTS.md gives agents project-specific context.

    Except as otherwise noted, this work is licensed under a Creative Commons Attribution 4.0 International License, and code samples are licensed under the Apache License 2.0.