Examples with HelpExample org.springframework.boot.cli.command.HelpExample used on opensource projects

Example 1 with HelpExample

use of org.springframework.boot.cli.command.HelpExample in project spring-boot by spring-projects.

the class HelpCommand method run.

@Override
public ExitStatus run(String... args) throws Exception {
    if (args.length == 0) {
        throw new NoHelpCommandArgumentsException();
    }
    String commandName = args[0];
    for (Command command : this.commandRunner) {
        if (command.getName().equals(commandName)) {
            Log.info(this.commandRunner.getName() + command.getName() + " - " + command.getDescription());
            Log.info("");
            if (command.getUsageHelp() != null) {
                Log.info("usage: " + this.commandRunner.getName() + command.getName() + " " + command.getUsageHelp());
                Log.info("");
            }
            if (command.getHelp() != null) {
                Log.info(command.getHelp());
            }
            Collection<HelpExample> examples = command.getExamples();
            if (examples != null) {
                Log.info(examples.size() == 1 ? "example:" : "examples:");
                Log.info("");
                for (HelpExample example : examples) {
                    Log.info("    " + example.getDescription() + ":");
                    Log.info("        $ " + example.getExample());
                    Log.info("");
                }
                Log.info("");
            }
            return ExitStatus.OK;
        }
    }
    throw new NoSuchCommandException(commandName);
}

Example 2 with HelpExample

use of org.springframework.boot.cli.command.HelpExample in project spring-boot by spring-projects.

the class InitCommand method getExamples.

@Override
public Collection<HelpExample> getExamples() {
    List<HelpExample> examples = new ArrayList<>();
    examples.add(new HelpExample("To list all the capabilities of the service", "spring init --list"));
    examples.add(new HelpExample("To creates a default project", "spring init"));
    examples.add(new HelpExample("To create a web my-app.zip", "spring init -d=web my-app.zip"));
    examples.add(new HelpExample("To create a web/data-jpa gradle project unpacked", "spring init -d=web,jpa --build=gradle my-dir"));
    return examples;
}