fix: correct autoCheckpoint config documentation in 08-checkpoints (#39)

The autoCheckpoint setting does not exist in Claude Code's settings
schema. Checkpointing is automatic and built-in — every user prompt
creates a checkpoint. Replace the incorrect config example with the
actual cleanupPeriodDays setting, which controls retention period.

Fixes #18
This commit is contained in:
JiayuWang(王嘉宇)
2026-04-07 07:18:46 +08:00
committed by GitHub
parent b511ed1997
commit 749c79f633
+6 -4
View File
@@ -207,15 +207,17 @@ Since checkpoints are created automatically, you can focus on your work without
## Configuration ## Configuration
You can toggle automatic checkpoints in your settings: Checkpoints are a built-in default behavior in Claude Code and do not require any configuration to enable. Every user prompt automatically creates a checkpoint.
The only checkpoint-related setting is `cleanupPeriodDays`, which controls how long sessions and checkpoints are retained:
```json ```json
{ {
"autoCheckpoint": true "cleanupPeriodDays": 30
} }
``` ```
- `autoCheckpoint`: Enable or disable automatic checkpoint creation on every user prompt (default: `true`) - `cleanupPeriodDays`: Number of days to retain session history and checkpoints (default: `30`)
## Limitations ## Limitations
@@ -233,8 +235,8 @@ Checkpoints have the following limitations:
**Solution**: **Solution**:
- Check if checkpoints were cleared - Check if checkpoints were cleared
- Verify that `autoCheckpoint` is enabled in your settings
- Check disk space - Check disk space
- Ensure `cleanupPeriodDays` is set high enough (default: 30 days)
### Rewind Failed ### Rewind Failed