Design Patterns
Use these patterns while designing your commands:
- Use the
--async
flag for events that are long running and happening on the server level rather than in the client CLI.- Example:
sf org create sandbox --async
- Example:
- Provide user feedback for long running commands.
- Use a spinner with interactive commands.
- Long-running commands must always provide an ID to report back on.
- Multiple resources must have a default.
- Present lists as tables.
- Use these flags when including and outputting files or directories:
--output-file
,—output-dir
,—input-file
,--input-dir
.