Package software.amazon.smithy.cli
Interface Command
-
- All Known Implementing Classes:
SmithyCommand
public interface CommandRepresents a CLI command.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classCommand.EnvEnvironment settings for the command.
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description intexecute(Arguments arguments, Command.Env env)Executes the command using the provided arguments.java.lang.StringgetName()Gets the name of the command.java.lang.StringgetSummary()Gets a short summary of the command that's shown in the main help.default booleanisHidden()Return true to hide this command from help output.
-
-
-
Method Detail
-
getName
java.lang.String getName()
Gets the name of the command.The returned name should contain no spaces or special characters.
- Returns:
- Returns the command name.
-
isHidden
default boolean isHidden()
Return true to hide this command from help output.- Returns:
- Return true if this is a hidden command.
-
getSummary
java.lang.String getSummary()
Gets a short summary of the command that's shown in the main help.- Returns:
- Returns the short help description.
-
execute
int execute(Arguments arguments, Command.Env env)
Executes the command using the provided arguments.- Parameters:
arguments- CLI arguments.env- CLI environment settings like stdout, stderr, etc.- Returns:
- Returns the exit code.
-
-