devbox icon indicating copy to clipboard operation
devbox copied to clipboard

Allow adding description to each script

Open ahochsteger opened this issue 1 year ago • 0 comments

What problem are you trying to solve?

devbox run just shows a list of available scripts but without description. It would be great, if would be possible to add a description to each script that is shown in devbox run or also used when generating the README file using devbox generate readme.

What solution would you like?

Extend the config schema of devbox.json to optionally allow an additional description.

Alternatives you've considered

Manually document each script in a README or add a help script but that is not well maintainable.

ahochsteger avatar Sep 24 '24 14:09 ahochsteger