18 releases

new 0.1.18 Apr 8, 2024
0.1.17 Mar 17, 2024
0.1.9 Feb 13, 2024
0.1.0 Aug 13, 2023

#403 in Configuration

Download history 411/week @ 2024-02-08 383/week @ 2024-02-15 399/week @ 2024-02-22 222/week @ 2024-02-29 165/week @ 2024-03-07 2005/week @ 2024-03-14 584/week @ 2024-03-21 500/week @ 2024-03-28 645/week @ 2024-04-04

3,756 downloads per month

MIT license

105KB
2.5K SLoC

Usage

Usage is a spec and CLI for defining CLI tools. Arguments, flags, environment variables, and config files can all be defined in a Usage spec. It can be thought of like OpenAPI (swagger) for CLIs. Here are some potential reasons for defining your CLI with a Usage spec:

  • Generate autocompletion scripts
  • Generate markdown documentation
  • Generate man pages
  • Use an advanced arg parser in any language
  • Scaffold one spec into different CLI frameworks—even different languages
  • [coming soon] Host your CLI documentation on usage.sh

See more at usage.jdx.dev.

[!WARNING] This is beta software and may have breaking changes both with the CLI and schema design. You've been warned.

Dependencies

~17MB
~308K SLoC