Building a command
A local command runs in the CLI process and calls no API, such as
osapi token generate. A command that calls the API is an
endpoint or a behavior. A command that runs for
a long time and stops on a signal, such as agent start, is not in the DSL yet:
it stays in cmd/.
A group of local commands is one directory, internal/cli/commands/<group>/,
and one import in internal/cli/commands/all. The DSL is in
internal/cli/command. From the definition, osapi makes the cobra command, the
flags, the help, the reference page and the checks of each method. The method is
a typed Go function. internal/cli/commands/token is a complete group.
Steps
- Write the layout:
go run . cli command create --name <group> --description "...". - Read the Command DSL reference, or
go run . cli command spec get. It lists each part of the DSL, what it does and when to use it. - Change the definition, the types and the methods.
- Run
go generate ./internal/cli/commands/allandjust cli-docs-generate. - Run
go run . cli command validate. Each problem ends with its fix, and--helplists each rule. - Run the tests of the group.
go run . cli command list shows each command of the binary and the layer that
made it. go run . cli command get --name <group> shows the commands, flags and
refused inputs of a group.
The build-a-command skill gives the same steps to an agent.