How to use clap without name or about message?

[imclint21]

Hi

All is in the question, any idea how to do this?

When I only use this YAML configuration file, it does not works:

subcommands:
 - cli:
    about: "Spawn to the command line interface"
    args:
     - help:
        help: "Prints CLI help information"
        short: h
        long: help

But when I add name: "" it works!

Thanks!

[CreepySkeleton]

AFAIK, in clap, the name field is mandatory. You can't create a clap::App instance with no name at all since the only way is clap::App::new which takes an &str.

So, name: "" is the correct way to do this.

Out of curiosity, could you please explain why do you want your program to be nameless?

[imclint21]

Oh okey, I'll explain you! The problem with clap for me is that it begin by the name of the process, and I want to setup an ascii logo with an about message WITHOUT process name.

In the past, I was forced to set author and about fields but I want to improve this (lucid-kv/lucid#47).

This is what I want in the cleanest way possible!

 ██╗    ██╗   ██╗ ██████╗██╗██████╗     ██╗  ██╗██╗   ██╗
 ██║    ██║   ██║██╔════╝██║██╔══██╗    ██║ ██╔╝██║   ██║
 ██║    ██║   ██║██║     ██║██║  ██║    ██╔═██╗ ╚██╗ ██╔╝
 ██████╗╚██████╔╝╚██████╗██║██████╔╝    ██║  ██╗ ╚████╔╝
 ╚═════╝ ╚═════╝  ╚═════╝╚═╝╚═════╝     ╚═╝  ╚═╝  ╚═══╝

A Fast, Secure and Distributed KV store with an HTTP API.
Written in Rust by Clint.Network (twitter.com/clint_network)

USAGE:
    lucid.exe [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -v, --version    Prints version information

SUBCOMMANDS:
    cli         Spawn to the command line interface
    help        Prints this message or the help of the given subcommand(s)
    init        Initialize Lucid and generate configuration file
    server      Run a new Lucid server instance
    settings    Manage Lucid configuration file
    store       Play with the KV store (get/set)
    tokens      Manage JWT Tokens (issue, revoke etc.)

[CreepySkeleton]

I believe template is what you're looking for.

Please note that template is not propagated to subcomands, and there's currently no way to do that. You will need the .template(TEMPLATE) call for every .subcommand().

use structopt::clap::{App, SubCommand};

const TEMPLATE: &str = "
 ██╗    ██╗   ██╗ ██████╗██╗██████╗     ██╗  ██╗██╗   ██╗
 ██║    ██║   ██║██╔════╝██║██╔══██╗    ██║ ██╔╝██║   ██║
 ██║    ██║   ██║██║     ██║██║  ██║    ██╔═██╗ ╚██╗ ██╔╝
 ██████╗╚██████╔╝╚██████╗██║██████╔╝    ██║  ██╗ ╚████╔╝
 ╚═════╝ ╚═════╝  ╚═════╝╚═╝╚═════╝     ╚═╝  ╚═╝  ╚═══╝

A Fast, Secure and Distributed KV store with an HTTP API.
Written in Rust by Clint.Network (twitter.com/clint_network)

USAGE:
    {usage}

FLAGS:
{flags}

SUBCOMMANDS:
{subcommands}
";

fn main() {
    let m = App::new("lucid")
        .subcommand(SubCommand::with_name("cli")
                .template(TEMPLATE))
        .template(TEMPLATE);

    println!("{:?}", m.get_matches());
}

Output:

user@user-PC:~/workspace/probe$ cargo run -- -h
   Compiling lucid v0.2.0 (/mnt/d/workspace/probe)
    Finished dev [unoptimized + debuginfo] target(s) in 6.08s
     Running `target/debug/lucid -h`

 ██╗    ██╗   ██╗ ██████╗██╗██████╗     ██╗  ██╗██╗   ██╗
 ██║    ██║   ██║██╔════╝██║██╔══██╗    ██║ ██╔╝██║   ██║
 ██║    ██║   ██║██║     ██║██║  ██║    ██╔═██╗ ╚██╗ ██╔╝
 ██████╗╚██████╔╝╚██████╗██║██████╔╝    ██║  ██╗ ╚████╔╝
 ╚═════╝ ╚═════╝  ╚═════╝╚═╝╚═════╝     ╚═╝  ╚═╝  ╚═══╝

A Fast, Secure and Distributed KV store with an HTTP API.
Written in Rust by Clint.Network (twitter.com/clint_network)

USAGE:
    lucid [SUBCOMMAND]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    cli
    help    Prints this message or the help of the given subcommand(s)

[imclint21]

Oh looks interesting, and is it possible to use that with yaml file?

[CreepySkeleton]

Sure, why not?

name: lucid

# `&template` means yaml anchor, so this template can be reused easily,
#             essential for subcommands
#
# `|` means "block scalar, do not replace newlines with spaces"
# `-` means "trim only trailing newlines"
# `4` is the number of spaces you indent the block with,
#     required since your logo starts with a space
#
# see https://yaml-multiline.info/ for details
template: &template |-4
     ██╗    ██╗   ██╗ ██████╗██╗██████╗     ██╗  ██╗██╗   ██╗
     ██║    ██║   ██║██╔════╝██║██╔══██╗    ██║ ██╔╝██║   ██║
     ██║    ██║   ██║██║     ██║██║  ██║    ██╔═██╗ ╚██╗ ██╔╝
     ██████╗╚██████╔╝╚██████╗██║██████╔╝    ██║  ██╗ ╚████╔╝
     ╚═════╝ ╚═════╝  ╚═════╝╚═╝╚═════╝     ╚═╝  ╚═╝  ╚═══╝

    A Fast, Secure and Distributed KV store with an HTTP API.
    Written in Rust by Clint.Network (twitter.com/clint_network)

    USAGE:
        {usage}

    FLAGS:
    {flags}

    SUBCOMMANDS:
    {subcommands}


subcommands:
    - cli:
        # reusing the anchored template, must be done for every subcommand
        template: *template

[imclint21]

Maybe in the future you could add some options to do that, like remove name by default or something like that.

Thank you!