Documentation update for the restore subcommand

This commit is contained in:
2026-05-19 22:32:55 -05:00
parent 648001a8fe
commit 5bc8e8683f
7 changed files with 333 additions and 30 deletions

View File

@@ -2,7 +2,7 @@
## Status
Planned. This document is implementation guidance for 5.3-Codex.
Implemented through Step 8. This document remains as roadmap and design history for the restore feature, and as the home for future restore-related ideas (for example `run --restore`).
## Summary
@@ -546,7 +546,7 @@ Do not document future `narratio run --restore` behavior outside `docs/roadmap/`
## Implementation phases
### Phase 1: Audit existing archive and path helpers
### Phase 1: Audit existing archive and path helpers (completed)
Before coding behavior, inspect:
@@ -574,7 +574,7 @@ Deliverable:
- small code comments or internal helper selection;
- no large behavior change yet unless required by tests.
### Phase 2: Add CLI surface and command wiring
### Phase 2: Add CLI surface and command wiring (completed)
Add `narratio restore` command parsing.
@@ -599,7 +599,7 @@ Deliverable:
- command returns a clear “not yet implemented” or calls an empty planner if phased commits are desired;
- CLI tests pass.
### Phase 3: Implement remote current-state discovery
### Phase 3: Implement remote current-state discovery (completed)
Add restore code that:
@@ -615,7 +615,7 @@ Deliverable:
- fake-storage tests for current-state discovery;
- no local file writes beyond temporary files.
### Phase 4: Implement restore planning
### Phase 4: Implement restore planning (completed)
Build deterministic restore plans for default scope and `--include-audio`.
@@ -627,7 +627,7 @@ Deliverable:
- dry-run output works;
- no real file overwrite yet except temp comparisons as needed.
### Phase 5: Implement restore execution
### Phase 5: Implement restore execution (completed)
Execute the plan safely:
@@ -644,7 +644,7 @@ Deliverable:
- restore works end-to-end against fake storage;
- failures are clear and do not corrupt existing local manifest.
### Phase 6: Add restore report and operator summary
### Phase 6: Add restore report and operator summary (completed)
Add concise stdout summary and optional JSON restore report if consistent with project diagnostics.
@@ -654,7 +654,7 @@ Deliverable:
- durable diagnostic report if implemented;
- no content leakage.
### Phase 7: Workflow integration test
### Phase 7: Workflow integration test (completed)
Add a test for restoring a previous session and then forcing `analyze`.
@@ -664,7 +664,7 @@ Deliverable:
- no upstream stages rerun;
- no reliance on live subprocesses or S3.
### Phase 8: Documentation update
### Phase 8: Documentation update (completed)
Once implemented, update current-behavior docs and internal command docs.