Skip to content

Design Guidelines Sub Actions

Shane McLaughlin edited this page Aug 31, 2023 · 1 revision

Sub-actions are additional verbs that qualify the primary action. Sub-actions are optional and used only when necessary. For example, in the command sf project deploy start, the sub-action start qualifies what the command project deploy will do.

A sub-action can also be a followup action related to a previous asynchronous action. For example, sf data query with the --async flag starts a bulk query. You can then use sf data query resume --use-most-recent to "resume" that query later.

Guidelines

  • Sub-actions are optional.
  • Sub-actions are verbs.

Good Examples

  • sf project deploy start
  • sf project deploy preview
  • sf project deploy report
  • sf data query resume
Clone this wiki locally