-
Notifications
You must be signed in to change notification settings - Fork 30
Closed
Description
- Save the first KDL code block in https://usage.jdx.dev/spec/reference/ as
mycli.usage.kdl - Replace
#inline-comments with//, as proposed in docs: mark KDL code blocks as KDL and use correct inline-comment//#536 - Run
, comment unsupported spec key, and rerun to catch them all.
usage lint mycli.usage.kdl
mycli.usage.kdl:
min_usage_version "1.0.0" // the minimum version of usage this CLI supports
// you want this at the top
name "My CLI" // a friendly name for the CLI
bin "mycli" // the name of the binary
version "1.0.0" // the version of the CLI
author "nobody" // the author of the CLI
license "MIT" // SPDX license the CLI is released under
// help for -h
before_help "before about"
about "some help"
after_help "after about"
// help for --help
before_long_help "before about"
long_about "longer help"
after_long_help "after about"
// examples (shown in markdown and manpage docs)
example "mycli --help" header="Getting help" help="Display help information"
example "mycli --version"
// render a link to the source code in markdown docs
source_code_link_template "https://github.com/me/myproj/blob/main/src/cli/{{path}}.rs"
include "./my_overrides.usage.kdl" // include another spec, will be merged and override existing valuesReactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels