Skip to content

docs: sync CLI features and agent documentation #48

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mark-e-deyoung merged 1 commit into from
Apr 12, 2026
+14 −1
Merged

docs: sync CLI features and agent documentation #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ WineBot is a containerized Windows application runtime (Wine 10.0) with an X11 d
| `docker/entrypoint.sh` | Container boot logic. Handles Xvfb, Openbox, Wine init. | `Xvfb`, `wineserver`, `tint2` |
| `docker/openbox/rc.xml` | Window Manager config. Controls input focus/decorations. | `<applications>`, `<mouse>` |
| `scripts/bin/` | Primary user-facing tools (`winebotctl`, `run-app.sh`). | |
| `scripts/diagnostics/` | System validation suite (`diagnose-master.sh`, `health-check.sh`). | `Environment Health` |
| `scripts/diagnostics/` | System validation suite (`diagnose-master.sh`, `health-check.sh`). | `diagnose-master.sh` |
| `scripts/setup/` | Installation and fix logic (`install-theme.sh`, `fix-wine-input.sh`). | |
| `automation/bin/` | Standalone automation tools (`x11.sh`, `screenshot.sh`). | |
| `automation/examples/` | Demo and verification scripts (`notepad_create_and_verify.py`). | |
Expand Down Expand Up @@ -70,6 +70,12 @@ scripts/winebotctl config set KEY VALUE
scripts/winebotctl config apply
```

### How to trace input?
```bash
scripts/winebotctl input trace start --layer windows
scripts/winebotctl input trace events --source client --limit 50
```

### How to debug input issues?
1. Enable traces: `WINEBOT_INPUT_TRACE=1` etc.
2. Check `logs/input_events_*.jsonl` in session dir.
Expand Down
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,16 @@ Use this for project maintenance and verification:
- `./scripts/wb test`: Run unit and E2E tests.
- `./scripts/wb build [intent]`: Build local images (e.g., `slim`, `dev`, `rel`).
- `./scripts/wb vuln`: Run vulnerability scans.
- `./scripts/wb ctl`: Alias for scripts/winebotctl.

### 2. Operator Tool (`scripts/winebotctl`)
Use this to automate applications:
- `scripts/winebotctl health`: Check API status.
- `scripts/winebotctl screenshot`: Capture the virtual desktop.
- `scripts/winebotctl apps run "/path/to/app.exe"`: Launch a Windows app.
- `scripts/winebotctl input click 100 200`: Perform a mouse click.
- `scripts/winebotctl lifecycle shutdown --yes`: Shutdown the instance.
- `scripts/winebotctl config profile set human-desktop`: Set a profile.

## Configuration

Expand Down
4 changes: 4 additions & 0 deletions docs/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ Examples:
- `scripts/winebotctl sessions list`
- `scripts/winebotctl recording start --session-root /artifacts/sessions`
- `scripts/winebotctl api POST /sessions/suspend --json '{"shutdown_wine":true}'`
- `scripts/winebotctl tail`
- `scripts/winebotctl config profile set human-desktop`
- `scripts/winebotctl lifecycle shutdown --yes`
- `scripts/winebotctl input trace start --layer windows`

Idempotent mode is supported (see `--idempotent` / `--no-idempotent`) so repeat invocations can safely reuse the same response when desired.

Expand Down
Loading