Skip to content

Commit

Permalink
Readme update
Browse files Browse the repository at this point in the history
Signed-off-by: Prabhu Subramanian <[email protected]>
  • Loading branch information
prabhu committed Feb 6, 2024
1 parent 18f00f8 commit 6a461fc
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,14 +71,16 @@ sub-commands:
### SBOM sub-command
```shell
usage: blint sbom [-h] [-i SRC_DIR_IMAGE [SRC_DIR_IMAGE ...]] [--output-file SBOM_OUTPUT]
usage: blint sbom [-h] [-i SRC_DIR_IMAGE [SRC_DIR_IMAGE ...]] [-o SBOM_OUTPUT] [--deep]

options:
-h, --help show this help message and exit
-i SRC_DIR_IMAGE [SRC_DIR_IMAGE ...], --src SRC_DIR_IMAGE [SRC_DIR_IMAGE ...]
Source directories, container images or binary files. Defaults to current directory.
--output-file SBOM_OUTPUT
-o SBOM_OUTPUT, --output-file SBOM_OUTPUT
SBOM output file. Defaults to bom.json in current directory.
--deep Enable deep mode to collect more used symbols and modules aggressively. Slow
operation.
```
To test any binary including default commands
Expand Down Expand Up @@ -109,6 +111,12 @@ blint sbom -i /path/to/apk -o bom.json
blint sbom -i /directory/with/apk/aab -o bom.json
```
To parse all files including `.dex` files, pass `--deep` argument.
```shell
blint sbom -i /path/to/apk -o bom.json --deep
```
PowerShell example
![PowerShell](./docs/blint-powershell.jpg)
Expand Down

0 comments on commit 6a461fc

Please sign in to comment.