Skip to content

Latest commit

 

History

History
21 lines (16 loc) · 900 Bytes

ANNOTATIONS.md

File metadata and controls

21 lines (16 loc) · 900 Bytes

Cloud and On-Prem Annotations

Occasionally, we want to restrict commands to be used only when the user is logged in to Confluent Cloud or Confluent Platform. We use Cobra annotations to label commands as Cloud-only or On-Prem-only. Applying an annotation to a parent command will recursively apply the same annotation to its children.

For example, the confluent admin commands have been labeled as Cloud-only:

cmd := &cobra.Command{
    Use:         "admin",
    Short:       "Perform administrative tasks for the current organization.",
    Args:        cobra.NoArgs,
    Annotations: map[string]string{annotations.RunRequirement: annotations.RequireCloudLogin},
}

Trying to use any confluent admin command results in the following error:

$ confluent admin payment describe
Error: you must log in to Confluent Cloud to use this command