Skip to content

Commit dbd10b1

Browse files
xperimentalxperimental
committed
Update readme
1 parent ae69bce commit dbd10b1

File tree

1 file changed

+43
-40
lines changed

1 file changed

+43
-40
lines changed

‎README.md‎

Lines changed: 43 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1745,10 +1745,10 @@ NAME:
17451745
trivy - A simple and comprehensive vulnerability scanner for containers
17461746
17471747
USAGE:
1748-
trivy [global options] command [command options] image_name
1748+
trivy [global options] command [command options] target
17491749
17501750
VERSION:
1751-
v0.9.0
1751+
v0.15.0
17521752
17531753
COMMANDS:
17541754
image, i scan an image
@@ -1764,7 +1764,6 @@ GLOBAL OPTIONS:
17641764
--cache-dir value cache directory (default: "/Users/teppei/Library/Caches/trivy") [$TRIVY_CACHE_DIR]
17651765
--help, -h show help (default: false)
17661766
--version, -v print the version (default: false)
1767-
17681767
```
17691768

17701769
## Image
@@ -1775,30 +1774,32 @@ NAME:
17751774
trivy image - scan an image
17761775
17771776
USAGE:
1778-
trivy image [command options] [arguments...]
1777+
trivy image [command options] image_name
17791778
17801779
OPTIONS:
1781-
--template value output template [$TRIVY_TEMPLATE]
1782-
--format value format (table, json, template) (default: "table") [$TRIVY_FORMAT]
1783-
--input value input file path instead of image name [$TRIVY_INPUT]
1784-
--severity value severities of vulnerabilities to be displayed (comma separated) (default: "UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL") [$TRIVY_SEVERITY]
1785-
--output value output file name [$TRIVY_OUTPUT]
1786-
--exit-code value Exit code when vulnerabilities were found (default: 0) [$TRIVY_EXIT_CODE]
1787-
--skip-update skip db update (default: false) [$TRIVY_SKIP_UPDATE]
1788-
--download-db-only download/update vulnerability database but don't run a scan (default: false) [$TRIVY_DOWNLOAD_DB_ONLY]
1789-
--reset remove all caches and database (default: false) [$TRIVY_RESET]
1790-
--clear-cache clear image caches without scanning (default: false) [$TRIVY_CLEAR_CACHE]
1791-
--no-progress suppress progress bar (default: false) [$TRIVY_NO_PROGRESS]
1792-
--ignore-unfixed display only fixed vulnerabilities (default: false) [$TRIVY_IGNORE_UNFIXED]
1793-
--removed-pkgs detect vulnerabilities of removed packages (only for Alpine) (default: false) [$TRIVY_REMOVED_PKGS]
1794-
--vuln-type value comma-separated list of vulnerability types (os,library) (default: "os,library") [$TRIVY_VULN_TYPE]
1795-
--ignorefile value specify .trivyignore file (default: ".trivyignore") [$TRIVY_IGNOREFILE]
1796-
--timeout value docker timeout (default: 2m0s) [$TRIVY_TIMEOUT]
1797-
--light light mode: it's faster, but vulnerability descriptions and references are not displayed (default: false) [$TRIVY_LIGHT]
1798-
--list-all-pkgs enabling the option will output all packages regardless of vulnerability [$TRIVY_LIST_ALL_PKGS]
1799-
--skip-files value specify the file path to skip traversal [$TRIVY_SKIP_FILES]
1800-
--skip-dirs value specify the directory where the traversal is skipped [$TRIVY_SKIP_DIRS]
1801-
--help, -h show help (default: false)
1780+
--template value, -t value output template [$TRIVY_TEMPLATE]
1781+
--format value, -f value format (table, json, template) (default: "table") [$TRIVY_FORMAT]
1782+
--input value, -i value input file path instead of image name [$TRIVY_INPUT]
1783+
--severity value, -s value severities of vulnerabilities to be displayed (comma separated) (default: "UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL") [$TRIVY_SEVERITY]
1784+
--output value, -o value output file name [$TRIVY_OUTPUT]
1785+
--exit-code value Exit code when vulnerabilities were found (default: 0) [$TRIVY_EXIT_CODE]
1786+
--skip-update skip db update (default: false) [$TRIVY_SKIP_UPDATE]
1787+
--download-db-only download/update vulnerability database but don't run a scan (default: false) [$TRIVY_DOWNLOAD_DB_ONLY]
1788+
--reset remove all caches and database (default: false) [$TRIVY_RESET]
1789+
--clear-cache, -c clear image caches without scanning (default: false) [$TRIVY_CLEAR_CACHE]
1790+
--no-progress suppress progress bar (default: false) [$TRIVY_NO_PROGRESS]
1791+
--ignore-unfixed display only fixed vulnerabilities (default: false) [$TRIVY_IGNORE_UNFIXED]
1792+
--removed-pkgs detect vulnerabilities of removed packages (only for Alpine) (default: false) [$TRIVY_REMOVED_PKGS]
1793+
--vuln-type value comma-separated list of vulnerability types (os,library) (default: "os,library") [$TRIVY_VULN_TYPE]
1794+
--ignorefile value specify .trivyignore file (default: ".trivyignore") [$TRIVY_IGNOREFILE]
1795+
--timeout value docker timeout (default: 2m0s) [$TRIVY_TIMEOUT]
1796+
--light light mode: it's faster, but vulnerability descriptions and references are not displayed (default: false) [$TRIVY_LIGHT]
1797+
--ignore-policy value specify the Rego file to evaluate each vulnerability [$TRIVY_IGNORE_POLICY]
1798+
--list-all-pkgs enabling the option will output all packages regardless of vulnerability (default: false) [$TRIVY_LIST_ALL_PKGS]
1799+
--skip-files value specify the file path to skip traversal [$TRIVY_SKIP_FILES]
1800+
--skip-dirs value specify the directory where the traversal is skipped [$TRIVY_SKIP_DIRS]
1801+
--cache-backend value cache backend (e.g. redis://localhost:6379) (default: "fs") [$TRIVY_CACHE_BACKEND]
1802+
--help, -h show help (default: false)
18021803
```
18031804

18041805
## Client
@@ -1808,7 +1809,7 @@ NAME:
18081809
trivy client - client mode
18091810
18101811
USAGE:
1811-
trivy client [command options] [arguments...]
1812+
trivy client [command options] image_name
18121813
18131814
OPTIONS:
18141815
--template value, -t value output template [$TRIVY_TEMPLATE]
@@ -1817,16 +1818,18 @@ OPTIONS:
18171818
--severity value, -s value severities of vulnerabilities to be displayed (comma separated) (default: "UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL") [$TRIVY_SEVERITY]
18181819
--output value, -o value output file name [$TRIVY_OUTPUT]
18191820
--exit-code value Exit code when vulnerabilities were found (default: 0) [$TRIVY_EXIT_CODE]
1820-
--clear-cache, -c clear image caches without scanning [$TRIVY_CLEAR_CACHE]
1821-
--quiet, -q suppress progress bar and log output [$TRIVY_QUIET]
1822-
--ignore-unfixed display only fixed vulnerabilities [$TRIVY_IGNORE_UNFIXED]
1823-
--debug, -d debug mode [$TRIVY_DEBUG]
1821+
--clear-cache, -c clear image caches without scanning (default: false) [$TRIVY_CLEAR_CACHE]
1822+
--ignore-unfixed display only fixed vulnerabilities (default: false) [$TRIVY_IGNORE_UNFIXED]
1823+
--removed-pkgs detect vulnerabilities of removed packages (only for Alpine) (default: false) [$TRIVY_REMOVED_PKGS]
18241824
--vuln-type value comma-separated list of vulnerability types (os,library) (default: "os,library") [$TRIVY_VULN_TYPE]
18251825
--ignorefile value specify .trivyignore file (default: ".trivyignore") [$TRIVY_IGNOREFILE]
1826-
--cache-dir value use as cache directory, but image cache is stored in /path/to/cache/fanal (default: "/Users/teppei/Library/Caches/trivy") [$TRIVY_CACHE_DIR]
1827-
--timeout value docker timeout (default: 1m0s) [$TRIVY_TIMEOUT]
1826+
--timeout value docker timeout (default: 2m0s) [$TRIVY_TIMEOUT]
1827+
--ignore-policy value specify the Rego file to evaluate each vulnerability [$TRIVY_IGNORE_POLICY]
18281828
--token value for authentication [$TRIVY_TOKEN]
1829+
--token-header value specify a header name for token (default: "Trivy-Token") [$TRIVY_TOKEN_HEADER]
18291830
--remote value server address (default: "http://localhost:4954") [$TRIVY_REMOTE]
1831+
--custom-headers value custom headers [$TRIVY_CUSTOM_HEADERS]
1832+
--help, -h show help (default: false)
18301833
```
18311834

18321835
## Server
@@ -1839,14 +1842,14 @@ USAGE:
18391842
trivy server [command options] [arguments...]
18401843
18411844
OPTIONS:
1842-
--skip-update skip db update [$TRIVY_SKIP_UPDATE]
1843-
--download-db-only download/update vulnerability database but don't run a scan [$TRIVY_DOWNLOAD_DB_ONLY]
1844-
--reset remove all caches and database [$TRIVY_RESET]
1845-
--quiet, -q suppress progress bar and log output [$TRIVY_QUIET]
1846-
--debug, -d debug mode [$TRIVY_DEBUG]
1847-
--cache-dir value use as cache directory, but image cache is stored in /path/to/cache/fanal (default: "/Users/teppei/Library/Caches/trivy") [$TRIVY_CACHE_DIR]
1848-
--token value for authentication [$TRIVY_TOKEN]
1849-
--listen value listen address (default: "localhost:4954") [$TRIVY_LISTEN]
1845+
--skip-update skip db update (default: false) [$TRIVY_SKIP_UPDATE]
1846+
--download-db-only download/update vulnerability database but don't run a scan (default: false) [$TRIVY_DOWNLOAD_DB_ONLY]
1847+
--reset remove all caches and database (default: false) [$TRIVY_RESET]
1848+
--cache-backend value cache backend (e.g. redis://localhost:6379) (default: "fs") [$TRIVY_CACHE_BACKEND]
1849+
--token value for authentication [$TRIVY_TOKEN]
1850+
--token-header value specify a header name for token (default: "Trivy-Token") [$TRIVY_TOKEN_HEADER]
1851+
--listen value listen address (default: "localhost:4954") [$TRIVY_LISTEN]
1852+
--help, -h show help (default: false)
18501853
```
18511854

18521855
# Air-gapped environment

0 commit comments

Comments
 (0)