docs(readme): add local-first path, restructure Quick Start into Local + Cloud#1039
Merged
Conversation
…wo paths Restructure the Quick Start into two clearly-labeled paths so users see both ways to run OpenAdapt: - Path 1: Local (recommended, default). pip install then record -> compile -> replay entirely on the user's own machine, with no account, no upload, and no cloud. Leads with the bundled MockMed loop (no target app), then substrate- aware recording via `openadapt flow record --backend web|windows|macos|linux| rdp` (web uses --url), compile, and local replay/run. Commands verified against openadapt/cli.py (record is a passthrough that forwards --backend) and openadapt-flow __main__.py on main (backend choices web/windows/macos/linux/ rdp). - Path 2: Cloud (optional, managed). Keeps the sanitized-derivative -> approve exact bytes -> upload-with-ingest-token flow, framed as the optional hosted path for teams, with the honest scope note that the public managed subscription runs browser workflows today (desktop/RDP/Citrix run self-hosted/on-prem as scoped design-partner deployments). Also update the CLI reference record line to reflect the substrate-aware backend selector. No em dashes in edited sections. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NyCHrzA1psrKMFfroYbzaM
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Restructures the README Quick Start so users see two clearly-labeled paths instead of only the Cloud ingest flow.
Path 1: Local (recommended, default)
Leads the section and is marked the privacy-preserving default.
pip installthen record -> compile -> replay entirely on the user's own machine: no account, no upload, no cloud. Nothing leaves the machine.openadapt flow record --backend web|windows|macos|linux|rdp(web uses--url), compile, and local replay. Native/remote substrates replay locally viaopenadapt flow run.for-each, andvisualize.Path 2: Cloud (optional, managed)
Keeps the existing sanitized-derivative -> approve exact bytes -> upload-with-ingest-token flow, reframed as the optional hosted path for teams wanting hosting, a dashboard, and governance. Adds the honest scope note that the public managed subscription runs browser workflows today, while desktop/RDP/Citrix run self-hosted/on-prem as scoped design-partner deployments. The Cloud
connectpairing block moved here from the top.Accuracy
Commands verified against:
openadapt/cli.pyin this repo:recorddelegates through the passthrough group so--backend(and--url,--agent-url,--macos-app,--rdp-host, ...) forward verbatim; the explicitreplaywrapper is web-only, so native/remote local replay is documented viaopenadapt flow run(a passthrough command).openadapt-flowopenadapt_flow/__main__.pyon main (v1.19.0):record--backendchoices areweb/windows/macos/linux/rdp; web requires--url. The launcher pinsopenadapt-flow>=1.17.0.No em dashes in edited sections. README is the PyPI long description only; no README content-lint or docs-consistency test gates this change (the docs guard only fires on
docs/**andmkdocs.yml).🤖 Generated with Claude Code
https://claude.ai/code/session_01NyCHrzA1psrKMFfroYbzaM