Public Guide

Documentation

Task-first documentation for downloads, first-run setup, the Node.js client, the Python client, and the base Go API.

Start Here Getting Started Choose Node.js, Python, or Go and get to a first working script quickly. Install Downloads Pick the right package, binary, or source path for your environment. Base Runtime Golang API Use the core implementation and generated API reference as the base contract.

Choose Your Path

Client Guide Node.js Client Package install flow, scaffolded examples, dashboard startup, and current runtime references. Client Guide Python Client pipx-based setup, example scaffolding, runtime behavior, and current Python-facing references. Support Getting Help Use the issue-reporting checklist, troubleshooting references, and support entry points.
Guide structure Start with the primary sections above. Use Guides, Reference, Strategy, and Benchmarks when you need deeper implementation detail, generated API output, or contributor planning material.

What Lives In Each Layer

  • Downloads is the install chooser for npm, PyPI, GitHub releases, and source builds.
  • Getting Started is the shortest path to the first working automation flow.
  • Node.js Client, Python Client, and Golang API are the language-specific landing areas for the public surface.
  • Getting Help, Contribution, and License hold operational support and project metadata.
  • Reference, Guides, Strategy, and Benchmarks remain the deeper supporting layers.

Deeper Layers

Reference API And Parity Material Generated package docs and parity references for detailed contract work. Guides Implementation Guides Build, OCR, input, app control, and publishing guides that remain valid during the rewrite. Strategy Plans And Ownership Docs plan, source ownership, and architecture strategy for contributors and maintainers. Benchmarks Published Performance Evidence Scenario definitions, benchmark reports, and generated visual artifacts.

Historical References

Use these external references for project background and upstream history:

Generated Reference Note

API reference pages are generated from source using go doc and validated with ./scripts/check-api-docs.sh.