Skip to content

Latest commit

 

History

History
45 lines (32 loc) · 2.33 KB

File metadata and controls

45 lines (32 loc) · 2.33 KB

Remo CLI Docs

This file is the repository-maintainer guide for Remo CLI documentation.

Source of Truth

The distributed, user-facing CLI guidance lives in the per-skill references:

There is no longer a single shared skills/cli-reference.md. This is intentional so every distributed skill folder stays self-contained.

What This File Covers

Use this file when maintaining the repository to keep the CLI docs surface aligned across:

Update Checklist

Whenever the CLI changes, update all of the following as needed:

  1. Command list and examples for any newly added, removed, or renamed command
  2. Option names, defaults, and flag spellings
  3. Connection semantics for --addr and --device
  4. Output behavior for screenshot, tree, watch, and mirror
  5. Daemon-related behavior for dashboard, start, stop, and status
  6. Known caveats, especially user-visible ones such as mirror --save timing limitations

Current Known Caveat Worth Preserving

remo mirror --save currently writes fixed per-frame sample durations in the MP4 muxer, which compresses idle periods and can make the saved video shorter than wall-clock time. Keep this caveat documented in the distributed CLI reference and any skill that recommends mirror --save.