fix: accept saved result envelopes as plan files; fix docs CLI examples
apply_plan/apply_bootstrap_plan required the raw plan object, but the natural capture workflow (repoctl ... --output json > plan.json) saves the full result envelope, so following the documented workflow verbatim failed the hash check. repoctl now unwraps a stored envelope's `data` automatically (an idea worth keeping from codex/repoctl-l1's cli.py, which had the same fallback). Found while walking docs/repoctl.md's adopt and cross-repo examples live end to end: two more invocation bugs in the doc itself (`config add-root` takes a positional path, not `--path`; `--output` must follow `config` itself, not the add-root/remove-root subaction) -- fixed and clarified in place.
This commit is contained in:
+5
-3
@@ -40,12 +40,14 @@ repoctl validate --repo .
|
||||
Пока `repoctl` не установлен как инструмент, из исходников этого репозитория он запускается через `uv run repoctl ...` (см. README.md). Если репозиториев несколько и они лежат в общем каталоге, добавьте этот каталог как root один раз:
|
||||
|
||||
```bash
|
||||
repoctl config add-root --path C:/Users/example/Git
|
||||
repoctl describe --repo some-repo-name
|
||||
repoctl config --output json add-root C:/Users/example/Git
|
||||
repoctl describe --repo some-repo-name --output json
|
||||
```
|
||||
|
||||
Порядок разрешения имени репозитория: явный `--root` → переменная окружения `REPOCTL_ROOTS` → сохранённый `config add-root` → текущий репозиторий (если команда запущена изнутри него).
|
||||
|
||||
`--output` — параметр конкретной подкоманды, а не общий флаг: он идёт **после** имени команды (`repoctl validate --output json ...`), а для `config` — сразу после `config`, перед `show`/`add-root`/`remove-root` (`repoctl config --output json add-root ...`).
|
||||
|
||||
## Команды по порядку знакомства
|
||||
|
||||
### `validate` — всё ли корректно
|
||||
@@ -110,7 +112,7 @@ repoctl init --repo ../new-repo --name new-repo --type project --owner team-name
|
||||
repoctl init --repo ../new-repo --apply --plan plan.json --approve sha256:<planHash-из-плана> --output json
|
||||
```
|
||||
|
||||
`--approve` должен побайтово совпасть с `planHash` — иначе команда завершится кодом `5` (approval required/denied) и ничего не запишет. `init` также повторно проверяет, что ни один из планируемых файлов не появился с момента построения плана — иначе откажется перезаписывать существующее.
|
||||
`--approve` должен побайтово совпасть с `planHash` — иначе команда завершится кодом `5` (approval required/denied) и ничего не запишет. `init` также повторно проверяет, что ни один из планируемых файлов не появился с момента построения плана — иначе откажется перезаписывать существующее. `--plan` принимает как файл, сохранённый напрямую из `--output json > plan.json` (полный envelope с `data`), так и голый объект плана — `repoctl` сам распознаёт и разворачивает envelope.
|
||||
|
||||
### `adopt` — подключить существующий репозиторий
|
||||
|
||||
|
||||
Reference in New Issue
Block a user