Skip to content

Commit a2c2244

Browse files
committed
docs/oasis-node/cli: Document prune command
1 parent 5c2e908 commit a2c2244

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

docs/oasis-node/cli.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -364,3 +364,26 @@ may stay constant or not be reclaimed for a very long time.
364364

365365
This command gives operators manual control to release disk space during
366366
maintenance periods.
367+
368+
### prune-experimental
369+
370+
Run
371+
372+
```sh
373+
oasis-node storage prune-experimental --config /path/to/config/file
374+
```
375+
376+
to trigger manual pruning of consensus database instances:
377+
378+
```sh
379+
{"caller":"storage.go:433","level":"info","module":"cmd/storage", \
380+
"msg":"Starting consensus databases pruning. This may take a while...", \
381+
"ts":"2025-10-23T11:02:11.129822974Z"}
382+
```
383+
384+
Operatos should run this whenever they change pruning configuration, e.g. when
385+
enabling it for the first time, or later changing it to retain less data. This
386+
way they guarantee the node is healthy when it starts.
387+
388+
Following successful pruning, to release disk space, they are encouraged to run
389+
[the compaction command](#compact-experimental).

0 commit comments

Comments
 (0)