Skip to content

Commit 5bf7df3

Browse files
author
lemmih
committed
update cli reference documentation
1 parent e845727 commit 5bf7df3

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

docs/docs/users/reference/cli.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1364,6 +1364,7 @@ Commands:
13641364
checkpoints Print block headers at 30 day interval for a snapshot file
13651365
merge Merge snapshot archives into a single file. The output snapshot refers to the heaviest tipset in the input set
13661366
diff Show the difference between the canonical and computed state of a tipset
1367+
sync-bucket Export lite+diff snapshots from one or more CAR files, and upload them to an S3 bucket
13671368
help Print this message or the help of the given subcommand(s)
13681369
13691370
Options:
@@ -1452,6 +1453,22 @@ Options:
14521453
-h, --help Print help
14531454
```
14541455

1456+
### `forest-tool archive sync-bucket`
1457+
1458+
```
1459+
Export lite+diff snapshots from one or more CAR files, and upload them to an S3 bucket
1460+
1461+
Usage: forest-tool archive sync-bucket [OPTIONS] <SNAPSHOT_FILES>...
1462+
1463+
Arguments:
1464+
<SNAPSHOT_FILES>...
1465+
1466+
Options:
1467+
--endpoint <ENDPOINT> S3 endpoint URL [default: https://2238a825c5aca59233eab1f221f7aefb.r2.cloudflarestorage.com]
1468+
--dry-run Don't generate or upload files, just show what would be done
1469+
-h, --help Print help
1470+
```
1471+
14551472
### `forest-tool db`
14561473

14571474
```

docs/docs/users/reference/cli.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -119,6 +119,7 @@ generate_markdown_section "forest-tool" "archive export"
119119
generate_markdown_section "forest-tool" "archive checkpoints"
120120
generate_markdown_section "forest-tool" "archive merge"
121121
generate_markdown_section "forest-tool" "archive diff"
122+
generate_markdown_section "forest-tool" "archive sync-bucket"
122123

123124
generate_markdown_section "forest-tool" "db"
124125
generate_markdown_section "forest-tool" "db stats"

0 commit comments

Comments
 (0)