Skip to content

Commit 5185637

Browse files
committed
Update CLI docs
1 parent 0420562 commit 5185637

File tree

1 file changed

+29
-0
lines changed
  • docs/content/administration

1 file changed

+29
-0
lines changed

docs/content/administration/cli.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,3 +112,32 @@ Options:
112112
flag is not set)
113113
--help Show this message and exit.
114114
```
115+
116+
117+
118+
## `export`
119+
120+
Bulk-exports one or more (or all) resources' data in on or more (or all) available export formats.
121+
122+
```sh
123+
python -m tekst export
124+
```
125+
126+
This command takes several arguments for customizing its behavior:
127+
128+
```
129+
Usage: python -m tekst export [OPTIONS]
130+
131+
Exports the contents of the given resources (or all) using the given formats
132+
(or all) to the given output directory
133+
134+
Options:
135+
-r, --resource TEXT ID(s) of resource(s) to export, all if not set
136+
-f, --format TEXT Format(s) to export, all if not set [default: json,
137+
tekst-json, csv]
138+
-o, --output TEXT Output directory to write to [default:
139+
/tmp/tekst_resource_export/]
140+
-q, --quiet Don't output anything (except errors and warnings)
141+
-d, --delete Delete all existing files in the output directory
142+
--help Show this message and exit.
143+
```

0 commit comments

Comments
 (0)