clap/examples/README.md

# Examples

- Basic demo: [derive](demo.md)
- Typed arguments: [derive](typed-derive.md)
  - Topics:
    - Custom `parse()`
- Custom cargo command: [builder](cargo-example.md), [derive](cargo-example-derive.md)
  - Topics:
    - Subcommands
    - Cargo plugins
- git-like interface: [builder](git.md), [derive](git-derive.md)
  - Topics:
    - Subcommands
    - External subcommands
    - Optional subcommands
    - Default subcommands
- pacman-like interface: [builder](pacman.md)
  - Topics:
    - Flag subcommands
    - Conflicting arguments
- Escaped positionals with `--`: [builder](escaped-positional.md), [derive](escaped-positional-derive.md)
- Multi-call
  - busybox: [builder](multicall-busybox.md)
    - Topics:
      - Subcommands
  - hostname: [builder](multicall-hostname.md)
    - Topics:
      - Subcommands
- repl: [builder](repl.rs)
  - Topics:
    - Read-Eval-Print Loops / Custom command lines

## Contributing

New examples:
- Building: They must be added to [Cargo.toml](../Cargo.toml) with the appropriate `required-features`.
- Testing: Ensure there is a markdown file with [trycmd](https://docs.rs/trycmd) syntax
- Link the `.md` file from here

See also the general [CONTRIBUTING](../CONTRIBUTING.md).
docs: Re-work examples This creates distinct tutorial examples from complex feature examples (more how-tos). Both sets are getting builder / derive versions (at least the critical ones). 2021-11-30 18:30:19 +00:00			`# Examples`
test: More thoroughly test examples This ports our example testing over to [trycmd](https://docs.rs/) so we can: - More thoroughly test our examples - Provide always-up-to-date example usage The old way of testing automatically picked up examples. This new way requires we have a `.md` file that uses the example in some way. Notes: - Moved overall example description to the `.md` file - I added cross-linking between related examples - `14_groups` had a redundant paragraph (twice talked about "one and only one" 2021-11-10 22:15:30 +00:00
docs: Re-work examples This creates distinct tutorial examples from complex feature examples (more how-tos). Both sets are getting builder / derive versions (at least the critical ones). 2021-11-30 18:30:19 +00:00			`- Basic demo: [derive](demo.md)`
docs(examples): Generalize key-value example 2022-03-14 14:37:52 +00:00			`- Typed arguments: [derive](typed-derive.md)`
docs(examples): Be explicit about example topics 2022-02-22 14:43:33 +00:00			`- Topics:`
			- Custom `parse()`
docs(examples): Add cargo subcommand example 2021-12-15 17:33:10 +00:00			`- Custom cargo command: [builder](cargo-example.md), [derive](cargo-example-derive.md)`
docs(examples): Be explicit about example topics 2022-02-22 14:43:33 +00:00			`- Topics:`
			`- Subcommands`
			`- Cargo plugins`
refactor(examples): Change naming style This is to make room for a reasonable looking cargo plugin example. I got lazy and didn't update the tutorials. 2021-12-15 17:12:16 +00:00			`- git-like interface: [builder](git.md), [derive](git-derive.md)`
docs(examples): Be explicit about example topics 2022-02-22 14:43:33 +00:00			`- Topics:`
			`- Subcommands`
			`- External subcommands`
docs(examples); Call out optional subcommands 2022-04-01 14:27:29 +00:00			`- Optional subcommands`
docs(examples): Show how to do default subcommands While we don't have a built-in mechanism, its relatively easy to support with the APIs we provide. Inspired by #3566 2022-03-23 16:08:07 +00:00			`- Default subcommands`
docs: Fix the pacman-like interface example link 2021-12-11 13:22:09 +00:00			`- pacman-like interface: [builder](pacman.md)`
docs(examples): Be explicit about example topics 2022-02-22 14:43:33 +00:00			`- Topics:`
			`- Flag subcommands`
			`- Conflicting arguments`
refactor(examples): Change naming style This is to make room for a reasonable looking cargo plugin example. I got lazy and didn't update the tutorials. 2021-12-15 17:12:16 +00:00			- Escaped positionals with `--`: [builder](escaped-positional.md), [derive](escaped-positional-derive.md)
docs: Re-work examples This creates distinct tutorial examples from complex feature examples (more how-tos). Both sets are getting builder / derive versions (at least the critical ones). 2021-11-30 18:30:19 +00:00			`- Multi-call`
refactor(examples): Change naming style This is to make room for a reasonable looking cargo plugin example. I got lazy and didn't update the tutorials. 2021-12-15 17:12:16 +00:00			`- busybox: [builder](multicall-busybox.md)`
docs(examples): Be explicit about example topics 2022-02-22 14:43:33 +00:00			`- Topics:`
			`- Subcommands`
refactor(examples): Change naming style This is to make room for a reasonable looking cargo plugin example. I got lazy and didn't update the tutorials. 2021-12-15 17:12:16 +00:00			`- hostname: [builder](multicall-hostname.md)`
docs(examples): Be explicit about example topics 2022-02-22 14:43:33 +00:00			`- Topics:`
			`- Subcommands`
docs: Add REPL example This is to help in cases like #3668 and #3673 2022-05-02 11:21:52 +00:00			`- repl: [builder](repl.rs)`
			`- Topics:`
			`- Read-Eval-Print Loops / Custom command lines`
test: More thoroughly test examples This ports our example testing over to [trycmd](https://docs.rs/) so we can: - More thoroughly test our examples - Provide always-up-to-date example usage The old way of testing automatically picked up examples. This new way requires we have a `.md` file that uses the example in some way. Notes: - Moved overall example description to the `.md` file - I added cross-linking between related examples - `14_groups` had a redundant paragraph (twice talked about "one and only one" 2021-11-10 22:15:30 +00:00
			`## Contributing`

docs: Re-work examples This creates distinct tutorial examples from complex feature examples (more how-tos). Both sets are getting builder / derive versions (at least the critical ones). 2021-11-30 18:30:19 +00:00			`New examples:`
fix cargo.toml link 2022-05-27 11:43:09 +00:00			- Building: They must be added to [Cargo.toml](../Cargo.toml) with the appropriate `required-features`.
docs: Re-work examples This creates distinct tutorial examples from complex feature examples (more how-tos). Both sets are getting builder / derive versions (at least the critical ones). 2021-11-30 18:30:19 +00:00			`- Testing: Ensure there is a markdown file with [trycmd](https://docs.rs/trycmd) syntax`
			- Link the `.md` file from here

Fix link to contributing 2022-02-23 04:36:54 +00:00			`See also the general [CONTRIBUTING](../CONTRIBUTING.md).`