cryostatio / cryostatio/cryostat-agent

[Request] `--help` output should include (optional) listing of config properties

Open
#552 0 comments 0 reactions 0 assignees View on GitHub
feat
Dominant language
Java
Stars
8
Forks
12
Avg merge
1d 4h
Merged PRs (30d)
15

Description

It would be really nice if the Agent's various configuration properties (keys, default values, optionality, and descriptions) were embedded into the sources in some way that could be iterated over dynamically at runtime and dumped as help output. This would remove the need to manually maintain a separate README document listing.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the Agent's --help handling and the source definitions for its configuration properties, then compare them with the separately maintained README listing. Define how keys, default values, optionality, and descriptions are represented and iterated at runtime. Done means help can optionally print this complete configuration information without requiring a separate manually maintained list.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.