Every new command group starts with the resource name like repo.\nCommands should be defined as singular. For repository commands it is repo and not repos.\nYou may set aliases to make your command more convenient to use.
@CommandLine.Command(name = \"repo\")Subcommands are action centered and can look like scm repo create x/y.
The RepositoryCreateCommand is a subcommand of RepositoryCommand and must be explicitly annotated.
\n@ParentCommand(value = RepositoryCommand.class)Every required field for a command must be a parameter. All other fields have to be options.
\nscm repo create git namespace/name --init --description=\"test\"
The repository type and namespace/name must be set, so they must be annotated as parameters.\nThe other fields like init and description are optional and are therefore annotated as options.
@CommandLine.Parameters\n private String type;\n @CommandLine.Parameters\n private String repository;\n @CommandLine.Option(names = \"--description\")\n private String description;\n @CommandLine.Option(names = \"--contact\")\n private String contact;\n @CommandLine.Option(names = \"--init\")\n private boolean init;Commands which return large texts or much content should allow templating.\nThis can be achieved by using the TemplateRenderer.\nIf you inject the TemplateRenderer you must annotate it as a Mixin:
\n @CommandLine.Mixin\n private final TemplateRenderer templateRenderer;Besides \"loose\" templates, you can use a table-like template to render your output.\nFor this purpose use the TemplateRender and create table first.\nThen add your table headers and rows.
\n Table table = templateRenderer.createTable();\n table.addHeader(\"repoName\", \"repoType\", \"repoUrl\");\n for (RepositoryCommandDto dto : dtos) {\n table.addRow(dto.getNamespace() + \"/\" + dto.getName(), dto.getType(), dto.getUrl());\n }\n templateRenderer.renderToStdout(TABLE_TEMPLATE, ImmutableMap.of(\"rows\", table, \"repos\", dtos)); NAME TYPE URL \n scmadmin/nice_repo git http://localhost:8081/scm/repo/scmadmin/nice_repo To create a two column (key-value-style) table you can use the addKeyValueRow() method.
Table table = createTable();\n RepositoryCommandDto dto = mapper.map(repository);\n table.addLabelValueRow(\"repoNamespace\", dto.getNamespace());\n table.addLabelValueRow(\"repoName\", dto.getName());\n table.addLabelValueRow(\"repoType\", dto.getType());\n table.addLabelValueRow(\"repoContact\", dto.getContact());\n table.addLabelValueRow(\"repoUrl\", dto.getUrl());\n table.addLabelValueRow(\"repoDescription\", dto.getDescription());\n renderToStdout(DETAILS_TABLE_TEMPLATE, ImmutableMap.of(\"rows\", table, \"repo\", dto));Namespace: scmadmin \nName : testrepo \nType : git The CLI client commands should support multiple languages.\nThis can be done by using translation keys in the related resource bundles.\nBy default, we support English and German translations.
\n static final String DEFAULT_TEMPLATE = String.join(\"\\n\",\n \"{{repo.namespace}}/{{repo.name}}\",\n \"{{i18n.repoDescription}}: {{repo.description}}\",\n \"{{i18n.repoType}}: {{repo.type}}\",\n \"{{i18n.repoContact}}: {{repo.contact}}\"\n );The variables starting with i18n are translations from the resource bundles.\nThe fields starting with repo are context related model data from the repository we are currently accessing.
There are different options on how to handle errors.\nYou can use the TemplateRender and print the errors or exception messages to stderr channel.
\nHowever, you also can throw an exception directly inside your execution.\nThese exceptions will be handled by the CliExceptionHandler and will be printed to the stderr channel based on a specific template.
\nThe CLI commands support Java bean validation.\nIf you want to use this validation you have to inject the CommandValidator and call validator.validate() in the first line of the command execution.\nThen you can simply annotate your fields with validation annotations.
@Email\n @CommandLine.Option(names = {\"--contact\", \"-c\"})\n private String contact; @Inject\n public MyCommand(CommandValidator validator) {\n this.validator = validator;\n }\n\n@Override\npublic void run() {\n validator.validate();\n ...\n}