Initial README (#120)

* initial readme + logging and output fixes to support descriptions * minor tweaks to README descriptions * simplify phrasing Co-authored-by: Alfredo Deza <adeza@anchore.com> * add comment for example gif Co-authored-by: Alfredo Deza <adeza@anchore.com> * spelling fix Co-authored-by: Alfredo Deza <adeza@anchore.com> * update phrasing Co-authored-by: Alfredo Deza <adeza@anchore.com> * simplify TODO note Co-authored-by: Alfredo Deza <adeza@anchore.com> * grammar fix Co-authored-by: Alfredo Deza <adeza@anchore.com> * phrase fix Co-authored-by: Alfredo Deza <adeza@anchore.com> * rm readme bash block indicators * clarify config examples are default values * rm value Co-authored-by: Alfredo Deza <adeza@anchore.com> Co-authored-by: Alfredo Deza <adeza@anchore.com>
2026-11-01 15:06:36 +01:00 · 2020-08-04 15:22:34 -04:00
parent 8fe59c6f1a
commit 2560266e38
6 changed files with 108 additions and 7 deletions
@@ -1,3 +1,93 @@
 # syft

-A CLI tool and go library for generating a Software Bill of Materials from container images and filesystems.
+A CLI tool and go library for generating a Software Bill of Materials (SBOM) from container images and filesystems.
+
+[//]: # (TODO: add example gif here)
+
+**Features**
+- Catalog container images and filesystems to discover packages and libraries.
+- Supports packages and libraries from various ecosystems (APK, DEB, RPM, Ruby Bundles, Python Wheel/Egg/requirements.txt, JavaScript NPM/Yarn, Java JAR/EAR/WAR, Jenkins plugins JPI/HPI, Go modules)
+- OS distribution detection (supports alpine, busybox, centos/redhat, debian/ubuntu flavored distributions)
+
+## Getting started
+
+To generate an SBOM for an image:
+```
+syft <image>
+```
+
+The above output includes only software that is visible in the container (i.e., the squashed representation of the image).
+To include software from all image layers in the SBOM, regardless of its presence in the final image, provide `--scope all-layers`:
+
+```
+syft <image> --scope all-layers
+```
+
+Syft can generate a SBOM from a variety of sources:
+```
+# catalog a docker image tar (from the result of "docker image save ... -o image.tar" command)
+syft docker-archive://path/to/image.tar
+
+# catalog a directory
+syft dir://path/to/dir
+```
+
+By default Syft shows a summary table, however, more detailed `text` and `json` formats are also available.
+```
+syft <image> -o json
+syft <image> -o text
+```
+
+## Installation
+
+*NOTE: This tool hasn't been released yet, so these installation methods work right now*
+
+**Recommended**
+```bash
+# install the latest version to /usr/local/bin
+curl -sSfL https://raw.githubusercontent.com/anchore/syft/master/install.sh | sh -s -- -b /usr/local/bin
+
+# install a specific version into a specific dir
+curl -sSfL https://raw.githubusercontent.com/anchore/syft/master/install.sh | sh -s <RELEASE_VERSION> -b <SOME_BIN_PATH>
+```
+
+**macOS**
+```bash
+brew tap anchore/syft
+brew install syft
+```
+
+## Configuration
+
+Configuration search paths:
+
+- `.syft.yaml`
+- `.syft/config.yaml`
+- `~/.syft.yaml`
+- `<XDG_CONFIG_HOME>/syft/config.yaml`
+
+Configuration options (example values are the default):
+
+```yaml
+# same as -o ; the output format of the SBOM report (options: table, text, json)
+output: "table"
+
+# same as -s ; the search space to look for packages (options: all-layers, squashed)
+scope: "squashed"
+
+# same as -q ; suppress all output (except for the SBOM report)
+quiet: false
+
+log:
+  # use structured logging
+  structured: false
+
+  # the log level; note: detailed logging suppress the ETUI
+  level: "error"
+
+  # location to write the log file (default is not to have a log file)
+  file: ""
+
+# enable/disable checking for application updates on startup
+check-for-app-update: true
+```