docs(readme): document rc implementation and parity checklist

This commit is contained in:
Micheal Wilkinson
2026-03-20 17:43:12 +00:00
parent f3b1a7707a
commit 6719fb170b

View File

@@ -35,8 +35,17 @@ Implemented commands:
- `link [CASTLE]` - `link [CASTLE]`
- `unlink [CASTLE]` - `unlink [CASTLE]`
- `track FILE [CASTLE]` - `track FILE [CASTLE]`
- `rc [CASTLE]`
- `version` - `version`
### rc behavior
- Runs executable scripts in `<castle>/.homesick.d/` in lexicographic order.
- Executes scripts with the castle root as the current working directory.
- Forwards script stdout/stderr to command output.
- If `<castle>/.homesickrc` exists and `<castle>/.homesick.d/parity.rb` does not, generates `parity.rb` before execution.
- Never overwrites an existing `parity.rb` wrapper.
Not yet implemented: Not yet implemented:
- `pull` - `pull`
@@ -47,9 +56,28 @@ Not yet implemented:
- `open` - `open`
- `exec` - `exec`
- `exec_all` - `exec_all`
- `rc`
- `generate` - `generate`
## Outstanding Feature Checklist
Command parity:
- [ ] `pull`
- [ ] `push`
- [ ] `commit`
- [ ] `destroy`
- [ ] `cd`
- [ ] `open`
- [ ] `exec`
- [ ] `exec_all`
- [ ] `generate`
Historical flag/behavior parity:
- [ ] `pull --all`
- [ ] `rc --force`
- [ ] Evaluate whether global `pretend`/`quiet` modes should be restored
## Behavior Suite ## Behavior Suite
The repository includes a Docker-based behavior suite that validates filesystem and git outcomes for the implemented commands. The repository includes a Docker-based behavior suite that validates filesystem and git outcomes for the implemented commands.