Skip to content

docs: fix README CLI flags table #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Mani Bindra (maniSbindra) merged 2 commits into from
Apr 17, 2026
Merged

docs: fix README CLI flags table #11

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cf8106d
docs: fix README CLI flags table
maniSbindra Apr 17, 2026
ece3da0
docs: align --update-existing description with CLI help text
maniSbindra Apr 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,16 +61,26 @@ task build

### CLI Flags

**Global flags** (available on all subcommands):

| Flag | Default | Description |
| ---- | ------- | ----------- |
| `--database` | `azure_linux_images.db` | Path to SQLite database |
| `--config-dir` | `config` | Path to configuration directory |
| `--output` | `docs/daily_recommendations.md` | Path to output report |
| `--top-n` | 10 | Number of top images per language |
| `--max-tags` | 5 | Maximum tags per repository (0 = all) |
| `--comprehensive` | false | Enable secrets + misconfig scanning |
| `--update-existing` | false | Rescan images already in the database |
| `--output` | `docs/daily_recommendations.md` | Path to output report file |
| `--top-n` | 10 | Number of top images per language per base OS (0 = all) |
| `--json-top-n` | 20 | Number of top images per language per base OS in JSON report (0 = all) |
| `--verbose, -v` | false | Enable verbose output |
| `--debug, -d` | false | Enable debug output |

**`scan` flags:**

| Flag | Default | Description |
| ---- | ------- | ----------- |
| `--max-tags` | 5 | Maximum tags per repository (0 = all) |
| `--comprehensive` | false | Enable comprehensive scanning (secrets + misconfigs) |
| `--update-existing` | false | Rescan existing images |
| `--no-cleanup` | false | Keep Docker images after scanning |

## Configuration

Expand Down
Loading