Skip to content
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.

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

list-images should explain the filtering options #104

Open
ondrejbudai opened this issue Jan 27, 2025 · 0 comments
Open

list-images should explain the filtering options #104

ondrejbudai opened this issue Jan 27, 2025 · 0 comments
Labels
📖 documentation Improvements or additions to documentation

Comments

@ondrejbudai
Copy link
Member

$ podman run --privileged  --rm ghcr.io/osbuild/image-builder-cli list-images --help
List buildable images, use --filter to limit further

Usage:
  image-builder list-images [flags]

Flags:
      --filter stringArray   Filter distributions by a specific criteria (e.g. "type:iot*")
  -h, --help                 help for list-images
      --output string        Output in a specific format (text, json)

Global Flags:
      --datadir string      Override the default data direcotry for e.g. custom repositories/*.json data
      --output-dir string   Put output into the specified direcotry

Expected:

I know which criteria can I use in the --filter flag.

(btw, IIRC criteria is a plural form, so the help test should contain either "by a specific criterion", or "by specific criteria".)

@supakeen supakeen added the 📖 documentation Improvements or additions to documentation label Jan 29, 2025
mvo5 added a commit to mvo5/images that referenced this issue Feb 6, 2025
This commit tweaks the error message for unsupported filter prefixes
to include what is actually supported.

See osbuild/image-builder-cli#104
mvo5 added a commit to mvo5/images that referenced this issue Feb 6, 2025
This commit adds a new `SupportedFilter()` function that returns
the available filter prefixes.

See osbuild/image-builder-cli#104
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants