improve documentation

segmentio · Nov 21, 2023 · cc4eb74 · cc4eb74
1 parent 2f593fa
commit cc4eb74
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/cmd/topicctl/subcmd/delete.go b/cmd/topicctl/subcmd/delete.go
@@ -46,8 +46,11 @@ var deleteACLsConfig = aclsCmdConfig{}
 func deleteACLCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "acl [flags]",
-		Short: "Delete an ACL",
+		Short: "Delete an ACL. Requires providing flags to only target a single ACL for deletion.",
 		Args:  cobra.NoArgs,
+		Example: `Delete read acls for topic my-topic, user 'User:default', and host '*'
+$ topicctl delete acl --resource-type topic --resource-pattern-type literal --resource-name my-topic --principal 'User:default' --host '*' --operation read --permission-type allow
+`,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			ctx := context.Background()
 			sess := session.Must(session.NewSession())