Skip to content

docs(skills): document observe --ttl and --full-screen in cu-automation skill - #6

Merged
mapleluvr merged 1 commit into
mainfrom
docs/skill-observe-ttl-fullscreen
Sep 3, 2026
Merged

mapleluvr merged 1 commit into
mainfrom
docs/skill-observe-ttl-fullscreen

Conversation

@mapleluvr

Copy link
Copy Markdown
Owner

Summary

Completes the cu-automation skill (added in #5) with the two observe options introduced in #4 that Step 2 did not yet cover:

  • Capture selectors: Step 2 now documents both --region and --full-screen <display_id[,display_id...]> — verbatim IDs from cu displays, mutually exclusive with --region/--display, no implicit current-desktop target.
  • TTL: the expiry note documents --ttl <positive-whole-seconds|unlimited> (expiresAt: null for unlimited), checkpoint TTL inheritance, and the retryable: true recovery for observation_expired.
  • Checkpoint branch: notes the checkpoint observation inherits the replaced observation's TTL and capture selection, so coordinates stay relative to checkpoint.imagePath.

Contract And Safety Impact

  • No public CLI, receipt, error-code, durable-record, or safety-boundary change.
  • Public or versioned contracts were updated for every observable change.
  • Typed text, helper paths, process IDs, window handles, captures, and local .cu/ state are absent from the diff.
  • No automatic replay or unproved-success behavior was introduced.

Contracts need no update: every statement added here mirrors cu help observe, docs/design/cli-contract.md, and cli-receipts.md from #4 (verified against parseObservationTtl, parseDisplayIdList, and the checkpoint path in src/act.ts passing ttlMs: source.observationTtlMs with a rebuilt same-kind selector).

Verification

  • npm run typecheck (clean)
  • npm run build (clean)
  • Focused automated tests: observe-cli.test.js + init-help.e2e.test.js — 23 pass, 0 fail
  • Installed public CLI test, when the public surface changed (not applicable — docs only)
  • Controlled native-input test (not applicable — docs only)
  • Isolated Sandbox/VM test (not applicable — docs only)

Effects Performed

None — read-only change and verification were side-effect free apart from the local build output (dist/, ignored).

Documentation

  • CHANGELOG.md updated for user-visible behavior.
  • README/help examples remain copyable and parser-valid.
  • Narrow versioned contracts and design decisions remain authoritative.

CHANGELOG not updated: preview changelog tracks released behavior; this only aligns skill guidance with already-shipped #4 behavior.

Residual Risk

  • Skill examples use placeholder IDs (dsp_…, obs_…); agents must copy real IDs from receipts.
  • Skill loads from the repo path only where the consumer registers skills/ (e.g. pi settings.json skills entry).

…on skill

- Step 2 covers both capture selectors: --region and --full-screen
  <display_id[,display_id...]> with verbatim IDs from cu displays,
  mutually exclusive, no implicit current-desktop target
- TTL note documents --ttl <positive-whole-seconds|unlimited>,
  expiresAt null for unlimited, checkpoint TTL inheritance, and the
  retryable:true recovery for observation_expired
- Checkpoint branch notes TTL + capture-selection inheritance so
  agents keep reading coordinates off checkpoint.imagePath
@mapleluvr
mapleluvr merged commit 6153fc9 into main Sep 3, 2026
4 checks passed
@mapleluvr
mapleluvr deleted the docs/skill-observe-ttl-fullscreen branch September 3, 2026 13:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant