Write Useful Messages
It’s never too early to start thinking about the messages you display for your users. Messages include:
- Command summary and description
- Flag summaries and descriptions
- Examples
- Error messages
- Interactive prompts
Because the full help for sf
commands can be long, we provide these two flags to control how much of the content is displayed:
--help
: Displays all the content.-h
: Displays a short form of the content. Output includes the command summary and the USAGE and FLAGS sections. It doesn’t include the long command description, examples, and long flag descriptions.
When you code your command, you automatically get these two flags too.