Skip to content

docs(cua-driver): Windows SSH workflow + autostart concept page - #1583

Merged
f-trycua merged 1 commit into
mainfrom
docs/cua-driver-windows-ssh-autostart
May 19, 2026
Merged

docs(cua-driver): Windows SSH workflow + autostart concept page#1583
f-trycua merged 1 commit into
mainfrom
docs/cua-driver-windows-ssh-autostart

Conversation

@f-trycua

@f-trycua f-trycua commented May 19, 2026

Copy link
Copy Markdown
Collaborator

Summary

Adds two sibling pages under docs/content/docs/cua-driver/guide/getting-started/ to close two gaps in the cua-driver fumadocs, which today is heavily macOS-focused:

  • windows-ssh.mdx — the "daemon in user's interactive Session 1+ → SSH (Session 0) → cua-driver mcp/call proxies through the daemon → real GUI apps respond" workflow. This is the actual ergonomic story for headless / remote Windows automation and nothing in the docs covered it before. Covers the Session 0 problem, the canonical autostart enable && kick recipe, the active-interactive-session prerequisite, opt-outs, and why mcp now proxies the same way call always did (PR fix(cua-driver-rs): proxy MCP through daemon on Windows/Linux when one is up #1580, shipped in v0.2.7).
  • autostart.mdx — concept page for the cua-driver autostart {enable, disable, kick, status} verb family. Documents per-platform mechanics (Windows = Scheduled Task with LogonType: Interactive; macOS/Linux Rust port still TBD — manual recipe via install-local.sh --autostart), the daemon-survives-RDP-disconnect property, and the enable && kick worked example.

Both pages are linked from the existing Windows section of installation.mdx (in the "common fixes for empty arrays" list and as a callout on the manual Scheduled Task block). A small sibling callout was also added under "TCC auto-delegation" to surface that the daemon-proxy mechanism now works on Windows / Linux too, addressing Session 0 rather than TCC.

Decision on placement: new sibling pages under getting-started/, not inline in installation.mdx. The installation page is already 619 lines, the SSH workflow needs its own discoverability (people searching "cua-driver ssh windows" need a page title that matches), and the autostart verb family deserves its own conceptual home as a sibling to the SSH workflow.

Total new content: 292 lines across the two new MDX files + ~25 lines of cross-link edits in installation.mdx. Inside the 300-500 line target.

Scope

Docs-only PR. No code changes. The behaviours described shipped in cua-driver-rs v0.2.7 (PR #1580should_use_daemon_proxy on Windows/Linux) and the autostart verb family already in the Rust port.

Files changed

  • docs/content/docs/cua-driver/guide/getting-started/windows-ssh.mdx (new)
  • docs/content/docs/cua-driver/guide/getting-started/autostart.mdx (new)
  • docs/content/docs/cua-driver/guide/getting-started/meta.json (added the two new page slugs to the ordered list)
  • docs/content/docs/cua-driver/guide/getting-started/installation.mdx (cross-link callouts in 3 places; no content moved out)

Test plan

  • pnpm dev in docs/ renders both new pages with working internal links to each other and to existing installation.mdx anchors
  • meta.json ordering puts windows-ssh and autostart between quickstart and integrations (sidebar reads top-to-bottom in workflow order)
  • All anchor links (#auto-start-at-logon-windows, #windows-interactive-session-requirements, #install-cua-driver-rs-directly-linux--windows--macos, #uninstall) resolve against the current installation.mdx
  • Code blocks render with correct syntax highlighting (PowerShell + bash + text)
  • <Callout> components render in both new pages (already imported from fumadocs-ui/components/callout)

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Added comprehensive guide for the autostart command to keep the daemon running across sessions and reboots
    • Added Windows SSH workflow documentation for proxying commands through an interactive daemon session
    • Updated installation guidance with autostart command reference and daemon proxy capabilities
    • Expanded documentation navigation to include new autostart and SSH setup guides

Review Change Stack

Adds two sibling pages under guide/getting-started/ to close gaps in the
cua-driver fumadocs that are heavily macOS-focused today:

- windows-ssh.mdx: the "daemon in user's interactive Session 1+ → SSH or
  remote shell → cua-driver mcp/call proxies through the daemon → real
  GUI apps respond" workflow that just shipped in cua-driver-rs v0.2.7
  (PR #1580). Covers the Session 0 problem, the canonical
  `autostart enable && kick` recipe, prerequisite (active interactive
  session — Active or Disc), opt-outs, and the v0.2.7 reason `mcp` now
  proxies the same way `call` always did.

- autostart.mdx: concept page for the `cua-driver autostart`
  {enable,disable,kick,status} verb family. Documents what each verb
  does per platform (Windows = Scheduled Task with LogonType:Interactive,
  macOS/Linux still manual via install-local.sh --autostart), the
  daemon-survives-RDP-disconnect property, and the worked example.

Also adds cross-link callouts in installation.mdx so the existing
"Auto-start at logon (Windows)" and "TCC auto-delegation" sections point
at the new pages, plus a sibling daemon-proxy callout for Windows/Linux.

Docs-only; no code touched. Behaviour shipped in cua-driver-rs v0.2.7.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@vercel

vercel Bot commented May 19, 2026

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment May 19, 2026 4:29pm

Request Review

@coderabbitai

coderabbitai Bot commented May 19, 2026

Copy link
Copy Markdown
Contributor

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

This PR adds comprehensive documentation for Windows autostart and SSH-over-daemon-proxy workflows. It introduces a new cua-driver autostart command guide and a Windows SSH guide explaining how to proxy tool calls from SSH (Session 0) to an interactive-session daemon (Session 1+), plus cross-references in existing installation docs.

Changes

Windows Autostart and SSH Daemon Proxy Documentation

Layer / File(s) Summary
Documentation navigation metadata
docs/content/docs/cua-driver/guide/getting-started/meta.json
Navigation entries added for new autostart and windows-ssh guide pages.
Autostart command guide
docs/content/docs/cua-driver/guide/getting-started/autostart.mdx
Complete MDX guide documenting cua-driver autostart purpose, Windows scheduled-task implementation, macOS/Linux manual alternatives, four command verbs (enable, kick, status, disable), worked example, RDP survivability rationale, and uninstall behavior.
Windows SSH over daemon proxy workflow
docs/content/docs/cua-driver/guide/getting-started/windows-ssh.mdx
Guide for running cua-driver over SSH on Windows via daemon proxy: explains Session 0 constraint, interactive-session daemon solution with session flow diagram, setup recipe, prerequisites, proxy decision logic with error handling, Claude Code registration, in-process opt-out mechanism, and diagnostics checklist.
Installation guide updates
docs/content/docs/cua-driver/guide/getting-started/installation.mdx
Adds recommended scheduled-task autostart option to Windows common fixes with info callout and setup one-liner; adds separate callout explaining daemon-proxy behavior for cua-driver-rs v0.2.7+ with opt-out flags and SSH workflow reference.

🎯 2 (Simple) | ⏱️ ~12 minutes


🐰 A daemon wakes at login's first sight,
Sessions dancing—Zero meets One's light,
Named pipes whisper through SSH's stream,
Windows workflows now live the SSH dream!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly matches the main changes: two new documentation pages on Windows SSH workflow and autostart concept, accurately summarizing the PR's primary content additions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/cua-driver-windows-ssh-autostart

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants