Sync README Usage block with current --help
The static usage example in README.md was added in milestone 1 and hand-maintained. When -C/--config landed in the JSON-config-file commit, printHelp() was updated but this block wasn't. This commit brings them back in sync and adds the precedence line.
This commit is contained in:
@@ -75,17 +75,23 @@ Usage: move [options]
|
||||
Options:
|
||||
-h, --help Show this help and exit.
|
||||
-v, --version Print version and exit.
|
||||
-C, --config <path> Load defaults from a JSON config file.
|
||||
Default path: see the Configuration section.
|
||||
-m, --move-interval <seconds> Idle time before a sweep fires. Default: 240.
|
||||
-c, --check-interval <seconds> Cursor poll cadence. Default: 10.
|
||||
-d, --step-delay <ms> Pause between synthetic steps. Default: 50.
|
||||
-n, --step-count <pixels> Steps per sweep. Default: 250.
|
||||
-V, --verbose Log every sweep, interrupt, and bounds event
|
||||
(default prints only the startup banner).
|
||||
|
||||
Precedence (highest wins): CLI flags > config file > built-in defaults.
|
||||
```
|
||||
|
||||
Numeric overrides are layered onto the defaults via `resolveConfig` in
|
||||
`src/config.ts`; time-valued inputs (`-m`, `-c`) are expressed in seconds
|
||||
at the CLI boundary and converted to milliseconds internally.
|
||||
Run `move --help` for the resolved default config-file path on your
|
||||
system. Numeric overrides are layered onto the defaults via
|
||||
`resolveConfig` in `src/config.ts`; time-valued inputs (`-m`, `-c`) are
|
||||
expressed in seconds at the CLI boundary and converted to milliseconds
|
||||
internally.
|
||||
|
||||
Logging is **quiet by default**: only the startup banner ("Teams Status
|
||||
Keeper started…") and any error from an unhandled rejection print on a
|
||||
|
||||
Reference in New Issue
Block a user