From f438ee974c19d64e77a5603246ba221389c6dadb Mon Sep 17 00:00:00 2001 From: Alex Goodman Date: Wed, 7 Apr 2021 16:31:09 -0400 Subject: [PATCH] add documentation for the file classifier cataloger config options Signed-off-by: Alex Goodman --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index b90157efe..642a1dc4d 100644 --- a/README.md +++ b/README.md @@ -108,6 +108,17 @@ package: # same as -s ; SYFT_PACKAGE_CATALOGER_SCOPE env var scope: "squashed" +# cataloging file classifications is exposed through the power-user subcommand +file-classification: + cataloger: + # enable/disable cataloging of file classifications + # SYFT_FILE_CLASSIFICATION_CATALOGER_ENABLED env var + enabled: true + + # the search space to look for file classifications (options: all-layers, squashed) + # SYFT_FILE_CLASSIFICATION_CATALOGER_SCOPE env var + scope: "squashed" + # cataloging file metadata is exposed through the power-user subcommand file-metadata: cataloger: