docs: document pretend quiet and dry-run flags

This commit is contained in:
Micheal Wilkinson
2026-03-20 18:10:06 +00:00
parent ad8ec1bd6c
commit bbc64eb756
2 changed files with 8 additions and 1 deletions

View File

@@ -45,6 +45,12 @@ Implemented commands:
- `rc [--force] [CASTLE]` - `rc [--force] [CASTLE]`
- `version` - `version`
Global options:
- `--pretend` simulates command execution without running shell/git commands.
- `--dry-run` is an alias for `--pretend`.
- `--quiet` suppresses status output.
### rc behavior ### rc behavior
- Runs executable scripts in `<castle>/.homesick.d/` in lexicographic order. - Runs executable scripts in `<castle>/.homesick.d/` in lexicographic order.
@@ -77,7 +83,7 @@ Historical flag/behavior parity:
- [x] `pull --all` - [x] `pull --all`
- [x] `rc --force` - [x] `rc --force`
- [ ] Evaluate whether global `pretend`/`quiet` modes should be restored - [x] Global `pretend`/`quiet` modes (`--pretend`, `--dry-run`, `--quiet`)
## Behavior Suite ## Behavior Suite

View File

@@ -19,6 +19,7 @@ A `### Breaking` section is used in addition to Keep a Changelog's standard sect
- `exec_all` command: runs a shell command inside each cloned castle root directory in sorted order. - `exec_all` command: runs a shell command inside each cloned castle root directory in sorted order.
- `pull --all` support: pulls updates for every cloned castle in sorted order. - `pull --all` support: pulls updates for every cloned castle in sorted order.
- `rc --force` support: legacy `.homesickrc` compatibility hooks now require explicit force mode before execution. - `rc --force` support: legacy `.homesickrc` compatibility hooks now require explicit force mode before execution.
- Global command flags restored: `--pretend` (with `--dry-run` alias) and `--quiet`.
- Native Go implementations for `clone`, `link`, `unlink`, `track`, `pull`, `push`, `commit`, `destroy`, `cd`, `open`, and `generate`. - Native Go implementations for `clone`, `link`, `unlink`, `track`, `pull`, `push`, `commit`, `destroy`, `cd`, `open`, and `generate`.
- Containerized behavior test suite for command parity validation. - Containerized behavior test suite for command parity validation.
- Dedicated test suites for `list`, `show_path`, `status`, `diff`, and `version`. - Dedicated test suites for `list`, `show_path`, `status`, `diff`, and `version`.