clap/examples
Ed Page eda0ca54c1 fix(parser): Simplify the common getter API
Clap has focused on reporting development errors through assertions
rather than mixing user errors with development errors.  Sometimes,
developers need to handle things more flexibly so included in #3732 was
the reporting of value accessor failures as internal errors with a
distinct type.  I've been going back and forth on whether the extra
error pessimises the usability in the common case vs dealing with the
proliferation of different function combinations.  In working on
deprecating the `value_of` functions, I decided that it was going to be
worth duplicating so long as we can keep the documentation focused.
2022-05-25 10:50:42 -05:00
..
derive_ref fix(parser): Simplify the common getter API 2022-05-25 10:50:42 -05:00
tutorial_builder fix(parser): Simplify the common getter API 2022-05-25 10:50:42 -05:00
tutorial_derive fix(error): Remove usage from value validation 2022-05-23 20:56:04 -05:00
cargo-example-derive.md docs: Fix messed up highlighting 2022-01-05 11:53:06 -06:00
cargo-example-derive.rs doc(derive): Update for value_parser 2022-05-20 20:02:23 -05:00
cargo-example.md fix(parser): Simplify the common getter API 2022-05-25 10:50:42 -05:00
cargo-example.rs docs(example): Update for value_parser 2022-05-24 14:53:08 -05:00
demo.md docs: Fix messed up highlighting 2022-01-05 11:53:06 -06:00
demo.rs doc(derive): Update for value_parser 2022-05-20 20:02:23 -05:00
escaped-positional-derive.md docs: Fix messed up highlighting 2022-01-05 11:53:06 -06:00
escaped-positional-derive.rs doc(derive): Update for value_parser 2022-05-20 20:02:23 -05:00
escaped-positional.md docs: Fix messed up highlighting 2022-01-05 11:53:06 -06:00
escaped-positional.rs fix(parser): Simplify the common getter API 2022-05-25 10:50:42 -05:00
git-derive.md docs: Fix examples 2022-03-23 12:31:13 -05:00
git-derive.rs doc(derive): Update for value_parser 2022-05-20 20:02:23 -05:00
git.md docs(examples): Fix help output 2022-03-25 07:20:46 -05:00
git.rs fix(parser): Simplify the common getter API 2022-05-25 10:50:42 -05:00
multicall-busybox.md docs: Update App references to Command 2022-02-14 15:33:49 -06:00
multicall-busybox.rs docs(example): Update for value_parser 2022-05-24 14:53:08 -05:00
multicall-hostname.md docs: Update App references to Command 2022-02-14 15:33:49 -06:00
multicall-hostname.rs feat(multicall): Stablize multicall 2022-05-20 12:20:40 -05:00
pacman.md fix(help): Use standard alternate syntax for subcommands 2022-02-14 21:18:33 -06:00
pacman.rs fix(parser): Simplify the common getter API 2022-05-25 10:50:42 -05:00
README.md docs: Add REPL example 2022-05-02 06:27:57 -05:00
repl.rs feat(multicall): Stablize multicall 2022-05-20 12:20:40 -05:00
typed-derive.md docs(examples): Show IP Address 2022-03-14 09:53:31 -05:00
typed-derive.rs doc(derive): Update for value_parser 2022-05-20 20:02:23 -05:00

Examples

  • Basic demo: derive
  • Typed arguments: derive
    • Topics:
      • Custom parse()
  • Custom cargo command: builder, derive
    • Topics:
      • Subcommands
      • Cargo plugins
  • git-like interface: builder, derive
    • Topics:
      • Subcommands
      • External subcommands
      • Optional subcommands
      • Default subcommands
  • pacman-like interface: builder
    • Topics:
      • Flag subcommands
      • Conflicting arguments
  • Escaped positionals with --: builder, derive
  • Multi-call
    • busybox: builder
      • Topics:
        • Subcommands
    • hostname: builder
      • Topics:
        • Subcommands
  • repl: builder
    • Topics:
      • Read-Eval-Print Loops / Custom command lines

Contributing

New examples:

  • Building: They must be added to Cargo.toml with the appropriate required-features.
  • Testing: Ensure there is a markdown file with trycmd syntax
  • Link the .md file from here

See also the general CONTRIBUTING.