cli-tools

CLI Tools

Uses the Clap crate for building input structures for CLI tools.

Running CLI Commands

There are two ways. One is via cargo and the other is to call the binary directly. I prefer running the binary directly as it mimics the experience a user would have.

• w/ cargo: $ cargo run --bin <the command>
• directly: $ ./target/debug/<the command>

This Carton is configured to create a binary for each example. That is configured with each [[bin]] in the Carton's Cargo.toml. The source files use underscores, but the commands follow Rust conventions by using hyphens.

The following toml tells Cargo to create a binary named kittyctl from a source file called src/sub_cmds.rs

[[bin]]
name = "kittyctl"
path = "src/sub_cmds.rs"

Projects

• basic: A simple example that demonstrates parameters, flags, and stacking flags [ source code ]
• kittyctl: A tool that demonstrates how to use Clap for sub commands, each with their own inputs. Creates a binary called kittyctl with subcommands that help with kitty management. [ source code ]

basic

Help output for the basic command:

$ ./target/debug/basic -h
Usage: basic [OPTIONS] [SOMETHING]

Arguments:
  [SOMETHING]  Some parameter

Options:
  -c, --config <FILE>  This param must be valid file path
  -v, --verbose...     Allows using -v, -vv, or -vvv
  -h, --help           Print help
  -V, --version        Print version

Called without any parameters:

$ ./target/debug/basic
Something: not provided
Config: not provided
Verbose mode is off

Called with a something parameter and -v for some verbosity

$ ./target/debug/basic meow -v
Something: meow
Config: not provided
Verbose mode is kind of on

Called a something parameter, the -c flag and a file path, and maximum verbosity

$ ./target/debug/basic meow -c "../README.md" -vvv
Something: meow
Config: ../README.md
Verbose mode is very on

kittyctl

Help output for the kittyctl command:

> ./target/debug/kittyctl -h
A CLI for managing kitties

Usage: kittyctl <COMMAND>

Commands:
  pet   Pet a kitty
  feed  Feed the kitties
  call  Call a kitty over
  help  Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

Help output for the pet subcommand:

> ./target/debug/kittyctl pet -h
Pet a kitty

Usage: kittyctl pet <NAME>

Arguments:
  <NAME>  The kitty to pet

Options:
  -h, --help  Print help

Executing the pet subcommand:

> ./target/debug/kittyctl pet sierra
Petting sierra