Skip to content

Commit 2339190

Browse files
committed
Minor README updates
1 parent abe838a commit 2339190

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Supports human-readable, JSON, CSV and SARIF output. SARIF alerts can be uploade
3232
- includes Code Scanning upload†
3333
- Works with GitHub.com, GitHub Enterprise Server, GitHub Enterprise Managed Users and GitHub Enterprise Cloud with Data Residency (custom base URL)
3434

35-
† GitHub Advanced Security or GitHub Code Security required for this feature
35+
† GitHub Advanced Security/GitHub Code Security required for this feature
3636

3737
## Usage
3838

@@ -388,12 +388,12 @@ Then type one PURL query per line. Entering a blank line or using Ctrl+C on a bl
388388
| `--token <token>` | GitHub token; required for `--sync-sboms`, `--sync-malware`, and `--upload-sarif` (or use `GITHUB_TOKEN`) |
389389
| `--enterprise <slug>` | Collect across all orgs in an Enterprise (mutually exclusive with `--org`/`--repo` when syncing) |
390390
| `--org <login>` | Single organization scope (mutually exclusive with `--enterprise`/`--repo` when syncing) |
391-
| `--repo <name>` | Single repository scope (mutually exclusive with `--enterprise`/`--org` when syncing) |
391+
| `--repo <name>` | Single repository scope in the form `owner/name` (mutually exclusive with `--enterprise`/`--org` when syncing) |
392392
| `--base-url <url>` | GitHub Enterprise Server REST base URL (e.g. `https://ghe.example.com/api/v3`) |
393393
| `--concurrency <n>` | Parallel SBOM fetches (default 5) |
394394
| `--sbom-delay <ms>` | Delay between SBOM fetch requests (default 3000) |
395395
| `--light-delay <ms>` | Delay between lightweight metadata requests (default 100) |
396-
| `--sbom-cache <dir>` | Directory to read/write per‑repo SBOM JSON; required for offline mode |
396+
| `--sbom-cache <dir>` | Directory to read/write per‑repo SBOM JSON; required for SBOM syncing and offline use |
397397
| `--sync-sboms` | Perform API calls to collect SBOMs; without it the CLI runs offline using `--sbom-cache` |
398398
| `--progress` | Show a progress bar during SBOM collection |
399399
| `--suppress-secondary-rate-limit-logs` | Suppress secondary rate limit warning logs (useful with `--progress`) |
@@ -465,7 +465,7 @@ npm run start -- --sbom-cache fixtures/sboms --malware-cache fixtures/malware-ca
465465

466466
Standard & secondary rate limits trigger an automatic retry (up to 2 times).
467467

468-
You can tune concurrency and increase the delay to reduce the chance of hitting rate limits.
468+
You can tune concurrency and increase the various delays to reduce the chance of hitting rate limits, if you find that you have hit rate limits.
469469

470470
Each time a secondary rate limit is hit, the delay between fetching SBOMs is increased by 10%, to provide a way to adaptively respond to that rate limit.
471471

0 commit comments

Comments
 (0)