Skip to content

Commit 71cf944

Browse files
committed
doc: add new subcommand to readme
1 parent b74e0ef commit 71cf944

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

README.md

+17
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ Options:
4545
--help Show this message and exit.
4646

4747
Commands:
48+
extract-subtree Extract a subtree of resources from an Opossum file.
4849
generate Generate an Opossum file from various other file formats.
4950
```
5051

@@ -78,6 +79,22 @@ Options:
7879
--help Show this message and exit.
7980
```
8081

82+
### extract-subtree
83+
84+
```bash
85+
Usage: opossum-file extract-subtree [OPTIONS] OPOSSUM_FILE SUBPATH
86+
87+
Extract all resources from OPOSSUMFILE that are children of the specified
88+
SUBPATH into a new .opossum-file (default: output.opossum).
89+
90+
Options:
91+
-o, --outfile FILE The file path to write the generated opossum document
92+
to. If appropriate, the extension ".opossum" is
93+
appended. If the output file already exists, it is
94+
overwritten. [default: output.opossum]
95+
--help Show this message and exit.
96+
```
97+
8198
# Development
8299

83100
## Setting up the environment

0 commit comments

Comments
 (0)