Skip to content

Commit 58e583a

Browse files
committed
docs: corrections from code review
1 parent 1a693f5 commit 58e583a

2 files changed

Lines changed: 13 additions & 6 deletions

File tree

docs/user-guides/files.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,8 @@ divbase-cli files stream sample_metadata.tsv
4747
If you want to download/stream a specific older version of a file, you can included the `Version ID` shown in the `info` command output like this:
4848

4949
```bash
50-
divbase-cli files download "sample_metadata.tsv:[version_id]"
51-
divbase-cli files stream "sample_metadata.tsv:[version_id]"
50+
divbase-cli files download "sample_metadata.tsv:VERSION_ID"
51+
divbase-cli files stream "sample_metadata.tsv:VERSION_ID"
5252
```
5353

5454
!!! info "You can't upload an identical file twice"
@@ -172,7 +172,7 @@ divbase-cli files download-all
172172
This will download all current files in your project except for DivBase query results files. Before the download starts, you'll be prompted to confirm whether you want to proceed. The command will display the total number of files and their combined size.
173173
174174
!!! Info "Resume a download"
175-
Use the `--resume` flag to continue a `download-all` command that got interupted.
175+
Use the `--resume` flag to continue a `download-all` command that got interrupted.
176176
This will skip files already downloaded with the same file name and MD5 checksum.
177177
You need to use the same download directory (`--download-dir`) as your initial run.
178178
@@ -230,7 +230,7 @@ divbase-cli files rm file1.txt file2.csv
230230

231231
A hard delete is when the file is permanently deleted from DivBase and can no longer be accessed or restored.
232232

233-
After a certain time period, soft deleted files will be hard deleted from DivBase [see here for more details](). Before that time you can restore the file(s).
233+
After a certain time period, soft deleted files will be hard deleted from DivBase [see here for more details](#what-if-i-want-to-delete-a-file-permanently). Before that time you can restore the file(s).
234234

235235
### Restoring files
236236

docs/user-guides/using-divbase-programmatically.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,20 @@ TODO - Should be a set of tips for users who want to use DivBase in scripts etc.
44

55
E.G. how to wait for a query to be complete, and download the query results programmatically.
66

7-
## Parse divbase-cli files ls/info commands programmatically
7+
## Parse divbase-cli files ls/info output programmatically
88

99
1. You can make the output of the `divbase-cli files info` and `divbase-cli files ls` commands in TSV format for easier parsing. Use the `--tsv` flag:
1010

1111
```bash
12-
divbase-cli files info --tsv
1312
divbase-cli files ls --tsv
13+
divbase-cli files info FILE_NAME --tsv
14+
```
15+
16+
You can do the same for any [project versions](./project-versioning.md) you've created for your project:
17+
18+
```bash
19+
divbase-cli version ls --tsv
20+
divbase-cli version info VERSION_NAME --tsv
1421
```
1522
1623
2. Rather than first downloading a file, you can stream a file from the command line and pipe it into other tools for processing directly without saving it to disk.

0 commit comments

Comments
 (0)