Use --output/-o instead of --format

Keep --format as a hidden flag for backward compat.
opensvc · Aug 23, 2023 · 6138fb9 · 6138fb9
1 parent 476da79
commit 6138fb9
Show file tree

Hide file tree

Showing 126 changed files with 178 additions and 175 deletions.
diff --git a/cmd/flags.go b/cmd/flags.go
@@ -27,11 +27,14 @@ func addFlagsGlobal(flagSet *pflag.FlagSet, p *commands.OptsGlobal) {
 	flagSet.BoolVar(&p.Local, "local", false, "Inline action on local instance.")
 	flagSet.BoolVarP(&p.Quiet, "quiet", "q", false, "Display no logs and no progress.")
 	flagSet.StringVar(&p.Color, "color", "auto", "Output colorization yes|no|auto.")
-	flagSet.StringVar(&p.Format, "format", "auto", "Output format json|flat|auto.")
+	flagSet.StringVar(&p.Output, "format", "auto", "Output format json|flat|auto|tab=<header>:<jsonpath>,...")
+	flagSet.StringVarP(&p.Output, "output", "o", "auto", "Output format json|flat|auto|tab=<header>:<jsonpath>,...")
 	flagSet.StringVar(&p.Log, "log", "", "Display the logs on the console at the specified level.")
 	flagSet.StringVar(&p.Server, "server", "", "URI of the opensvc api server. scheme raw|https.")
 	flagSet.StringVar(&p.NodeSelector, "node", "", "Execute on a list of nodes.")
 	flagSet.StringVarP(&p.ObjectSelector, "service", "s", "", "Execute on a list of objects.")
+	flagSet.MarkHidden("format")
+
 }
 
 func addFlagsLock(flagSet *pflag.FlagSet, p *commands.OptsLock) {

diff --git a/core/commands/array_ls.go b/core/commands/array_ls.go
@@ -27,7 +27,7 @@ func (t *CmdArrayLs) Run() error {
 		data, err = t.extractDaemon()
 	}
 	output.Renderer{
-		Format: t.Format,
+		Format: t.Output,
 		Color:  t.Color,
 		Data:   data,
 		HumanRenderer: func() string {

diff --git a/core/commands/cluster_freeze.go b/core/commands/cluster_freeze.go
@@ -15,7 +15,7 @@ func (t *CmdClusterFreeze) Run() error {
 		nodeaction.WithAsyncTime(t.Time),
 		nodeaction.WithAsyncWait(t.Wait),
 		nodeaction.WithAsyncWatch(t.Watch),
-		nodeaction.WithFormat(t.Format),
+		nodeaction.WithFormat(t.Output),
 		nodeaction.WithColor(t.Color),
 		nodeaction.WithLocal(false),
 	).Do()

diff --git a/core/commands/cluster_unfreeze.go b/core/commands/cluster_unfreeze.go
@@ -15,7 +15,7 @@ func (t *CmdClusterUnfreeze) Run() error {
 		nodeaction.WithAsyncTime(t.Time),
 		nodeaction.WithAsyncWait(t.Wait),
 		nodeaction.WithAsyncWatch(t.Watch),
-		nodeaction.WithFormat(t.Format),
+		nodeaction.WithFormat(t.Output),
 		nodeaction.WithColor(t.Color),
 		nodeaction.WithLocal(false),
 	).Do()

diff --git a/core/commands/daemon_dns_dump.go b/core/commands/daemon_dns_dump.go
@@ -38,7 +38,7 @@ func (t *CmdDaemonDNSDump) Run() error {
 		return err
 	}
 	renderer := output.Renderer{
-		Format:   t.Format,
+		Format:   t.Output,
 		Color:    t.Color,
 		Data:     parsed,
 		Colorize: rawconfig.Colorize,

diff --git a/core/commands/daemon_relay_status.go b/core/commands/daemon_relay_status.go
@@ -43,7 +43,7 @@ func (t *CmdDaemonRelayStatus) Run() error {
 		})
 	}
 	output.Renderer{
-		Format:   t.Format,
+		Format:   t.Output,
 		Color:    t.Color,
 		Data:     messages,
 		Colorize: rawconfig.Colorize,

diff --git a/core/commands/daemon_status.go b/core/commands/daemon_status.go
@@ -17,7 +17,7 @@ type (
 func (t *CmdDaemonStatus) Run() error {
 	m := monitor.New()
 	m.SetColor(t.Color)
-	m.SetFormat(t.Format)
+	m.SetFormat(t.Output)
 	m.SetSectionsFromExpression(t.Sections)
 
 	cli, err := newClient(t.Server)

diff --git a/core/commands/keystore_add.go b/core/commands/keystore_add.go
@@ -24,7 +24,7 @@ func (t *CmdKeystoreAdd) Run(selector, kind string) error {
 		objectaction.LocalFirst(),
 		objectaction.WithLocal(t.Local),
 		objectaction.WithColor(t.Color),
-		objectaction.WithFormat(t.Format),
+		objectaction.WithFormat(t.Output),
 		objectaction.WithObjectSelector(mergedSelector),
 		objectaction.WithRemoteNodes(t.NodeSelector),
 		objectaction.WithRemoteAction("add"),

diff --git a/core/commands/keystore_change.go b/core/commands/keystore_change.go
@@ -23,7 +23,7 @@ func (t *CmdKeystoreChange) Run(selector, kind string) error {
 		objectaction.LocalFirst(),
 		objectaction.WithLocal(t.Local),
 		objectaction.WithColor(t.Color),
-		objectaction.WithFormat(t.Format),
+		objectaction.WithFormat(t.Output),
 		objectaction.WithObjectSelector(mergedSelector),
 		objectaction.WithRemoteNodes(t.NodeSelector),
 		objectaction.WithRemoteAction("change"),

diff --git a/core/commands/keystore_decode.go b/core/commands/keystore_decode.go
@@ -21,7 +21,7 @@ func (t *CmdKeystoreDecode) Run(selector, kind string) error {
 		objectaction.LocalFirst(),
 		objectaction.WithLocal(t.Local),
 		objectaction.WithColor(t.Color),
-		objectaction.WithFormat(t.Format),
+		objectaction.WithFormat(t.Output),
 		objectaction.WithObjectSelector(mergedSelector),
 		objectaction.WithRemoteNodes(t.NodeSelector),
 		objectaction.WithRemoteAction("decode"),

diff --git a/core/commands/keystore_gencert.go b/core/commands/keystore_gencert.go
@@ -21,7 +21,7 @@ func (t *CmdSecGenCert) Run(selector, kind string) error {
 		objectaction.LocalFirst(),
 		objectaction.WithLocal(t.Local),
 		objectaction.WithColor(t.Color),
-		objectaction.WithFormat(t.Format),
+		objectaction.WithFormat(t.Output),
 		objectaction.WithObjectSelector(mergedSelector),
 		objectaction.WithRemoteNodes(t.NodeSelector),
 		objectaction.WithRemoteAction("gencert"),

diff --git a/core/commands/keystore_install.go b/core/commands/keystore_install.go
@@ -21,7 +21,7 @@ func (t *CmdKeystoreInstall) Run(selector, kind string) error {
 		objectaction.LocalFirst(),
 		objectaction.WithLocal(t.Local),
 		objectaction.WithColor(t.Color),
-		objectaction.WithFormat(t.Format),
+		objectaction.WithFormat(t.Output),
 		objectaction.WithObjectSelector(mergedSelector),
 		objectaction.WithRemoteNodes(t.NodeSelector),
 		objectaction.WithRemoteAction("install"),

diff --git a/core/commands/keystore_keys.go b/core/commands/keystore_keys.go
@@ -21,7 +21,7 @@ func (t *CmdKeystoreKeys) Run(selector, kind string) error {
 		objectaction.LocalFirst(),
 		objectaction.WithLocal(t.Local),
 		objectaction.WithColor(t.Color),
-		objectaction.WithFormat(t.Format),
+		objectaction.WithFormat(t.Output),
 		objectaction.WithObjectSelector(mergedSelector),
 		objectaction.WithRemoteNodes(t.NodeSelector),
 		objectaction.WithRemoteAction("keys"),

diff --git a/core/commands/keystore_pkcs.go b/core/commands/keystore_pkcs.go
@@ -21,7 +21,7 @@ func (t *CmdPKCS) Run(selector, kind string) error {
 		objectaction.LocalFirst(),
 		objectaction.WithLocal(t.Local),
 		objectaction.WithColor(t.Color),
-		objectaction.WithFormat(t.Format),
+		objectaction.WithFormat(t.Output),
 		objectaction.WithObjectSelector(mergedSelector),
 		objectaction.WithRemoteNodes(t.NodeSelector),
 		objectaction.WithRemoteAction("pkcs"),

diff --git a/core/commands/keystore_remove.go b/core/commands/keystore_remove.go
@@ -21,7 +21,7 @@ func (t *CmdKeystoreRemove) Run(selector, kind string) error {
 		objectaction.LocalFirst(),
 		objectaction.WithLocal(t.Local),
 		objectaction.WithColor(t.Color),
-		objectaction.WithFormat(t.Format),
+		objectaction.WithFormat(t.Output),
 		objectaction.WithObjectSelector(mergedSelector),
 		objectaction.WithRemoteNodes(t.NodeSelector),
 		objectaction.WithRemoteAction("keys"),

diff --git a/core/commands/network_ls.go b/core/commands/network_ls.go
@@ -28,7 +28,7 @@ func (t *CmdNetworkLs) Run() error {
 		data, err = t.extractDaemon()
 	}
 	output.Renderer{
-		Format: t.Format,
+		Format: t.Output,
 		Color:  t.Color,
 		Data:   data,
 		HumanRenderer: func() string {

diff --git a/core/commands/network_status.go b/core/commands/network_status.go
@@ -37,7 +37,7 @@ func (t *CmdNetworkStatus) Run() error {
 		return err
 	}
 	output.Renderer{
-		Format:   t.Format,
+		Format:   t.Output,
 		Color:    t.Color,
 		Data:     data,
 		Colorize: rawconfig.Colorize,

diff --git a/core/commands/node_abort.go b/core/commands/node_abort.go
@@ -15,7 +15,7 @@ func (t *CmdNodeAbort) Run() error {
 		nodeaction.WithRemoteAction("abort"),
 		nodeaction.WithAsyncTarget("aborted"),
 		nodeaction.WithAsyncWatch(t.Watch),
-		nodeaction.WithFormat(t.Format),
+		nodeaction.WithFormat(t.Output),
 		nodeaction.WithColor(t.Color),
 		nodeaction.WithLocal(t.Local),
 	).Do()

diff --git a/core/commands/node_capabilities_list.go b/core/commands/node_capabilities_list.go
@@ -13,14 +13,14 @@ type (
 
 func (t *CmdNodeCapabilitiesList) Run() error {
 	return nodeaction.New(
-		nodeaction.WithFormat(t.Format),
+		nodeaction.WithFormat(t.Output),
 		nodeaction.WithColor(t.Color),
 		nodeaction.WithServer(t.Server),
 
 		nodeaction.WithRemoteNodes(t.NodeSelector),
 		nodeaction.WithRemoteAction("node print capabilities"),
 		nodeaction.WithRemoteOptions(map[string]interface{}{
-			"format": t.Format,
+			"format": t.Output,
 		}),
 
 		nodeaction.WithLocal(t.Local),

diff --git a/core/commands/node_capabilities_scan.go b/core/commands/node_capabilities_scan.go
@@ -15,12 +15,12 @@ func (t *CmdNodeCapabilitiesScan) Run() error {
 	return nodeaction.New(
 		nodeaction.WithLocal(t.Local),
 		nodeaction.WithRemoteNodes(t.NodeSelector),
-		nodeaction.WithFormat(t.Format),
+		nodeaction.WithFormat(t.Output),
 		nodeaction.WithColor(t.Color),
 		nodeaction.WithServer(t.Server),
 		nodeaction.WithRemoteAction("scan capabilities"),
 		nodeaction.WithRemoteOptions(map[string]interface{}{
-			"format": t.Format,
+			"format": t.Output,
 		}),
 		nodeaction.WithLocalRun(func() (interface{}, error) {
 			n, err := object.NewNode()

diff --git a/core/commands/node_checks.go b/core/commands/node_checks.go
@@ -15,12 +15,12 @@ func (t *CmdNodeChecks) Run() error {
 	return nodeaction.New(
 		nodeaction.WithLocal(t.Local),
 		nodeaction.WithRemoteNodes(t.NodeSelector),
-		nodeaction.WithFormat(t.Format),
+		nodeaction.WithFormat(t.Output),
 		nodeaction.WithColor(t.Color),
 		nodeaction.WithServer(t.Server),
 		nodeaction.WithRemoteAction("checks"),
 		nodeaction.WithRemoteOptions(map[string]interface{}{
-			"format": t.Format,
+			"format": t.Output,
 		}),
 		nodeaction.WithLocalRun(func() (interface{}, error) {
 			n, err := object.NewNode()

diff --git a/core/commands/node_collector_tag_attach.go b/core/commands/node_collector_tag_attach.go
@@ -18,7 +18,7 @@ type (
 func (t *CmdNodeCollectorTagAttach) Run() error {
 	return nodeaction.New(
 		nodeaction.WithLocal(t.Local),
-		nodeaction.WithFormat(t.Format),
+		nodeaction.WithFormat(t.Output),
 		nodeaction.WithColor(t.Color),
 		nodeaction.WithLocalRun(func() (interface{}, error) {
 			n, err := object.NewNode()

diff --git a/core/commands/node_collector_tag_create.go b/core/commands/node_collector_tag_create.go
@@ -19,7 +19,7 @@ type (
 func (t *CmdNodeCollectorTagCreate) Run() error {
 	return nodeaction.New(
 		nodeaction.WithLocal(t.Local),
-		nodeaction.WithFormat(t.Format),
+		nodeaction.WithFormat(t.Output),
 		nodeaction.WithColor(t.Color),
 		nodeaction.WithLocalRun(func() (interface{}, error) {
 			n, err := object.NewNode()

diff --git a/core/commands/node_collector_tag_detach.go b/core/commands/node_collector_tag_detach.go
@@ -17,7 +17,7 @@ type (
 func (t *CmdNodeCollectorTagDetach) Run() error {
 	return nodeaction.New(
 		nodeaction.WithLocal(t.Local),
-		nodeaction.WithFormat(t.Format),
+		nodeaction.WithFormat(t.Output),
 		nodeaction.WithColor(t.Color),
 		nodeaction.WithLocalRun(func() (interface{}, error) {
 			n, err := object.NewNode()

diff --git a/core/commands/node_collector_tag_list.go b/core/commands/node_collector_tag_list.go
@@ -16,7 +16,7 @@ type (
 func (t *CmdNodeCollectorTagList) Run() error {
 	return nodeaction.New(
 		nodeaction.WithLocal(t.Local),
-		nodeaction.WithFormat(t.Format),
+		nodeaction.WithFormat(t.Output),
 		nodeaction.WithColor(t.Color),
 		nodeaction.WithLocalRun(func() (interface{}, error) {
 			n, err := object.NewNode()

diff --git a/core/commands/node_collector_tag_show.go b/core/commands/node_collector_tag_show.go
@@ -18,7 +18,7 @@ type (
 func (t *CmdNodeCollectorTagShow) Run() error {
 	return nodeaction.New(
 		nodeaction.WithLocal(t.Local),
-		nodeaction.WithFormat(t.Format),
+		nodeaction.WithFormat(t.Output),
 		nodeaction.WithColor(t.Color),
 		nodeaction.WithLocalRun(func() (interface{}, error) {
 			n, err := object.NewNode()

diff --git a/core/commands/node_compliance_attach_moduleset.go b/core/commands/node_compliance_attach_moduleset.go
@@ -16,12 +16,12 @@ func (t *CmdNodeComplianceAttachModuleset) Run() error {
 	return nodeaction.New(
 		nodeaction.WithLocal(t.Local),
 		nodeaction.WithRemoteNodes(t.NodeSelector),
-		nodeaction.WithFormat(t.Format),
+		nodeaction.WithFormat(t.Output),
 		nodeaction.WithColor(t.Color),
 		nodeaction.WithServer(t.Server),
 		nodeaction.WithRemoteAction("compliance attach moduleset"),
 		nodeaction.WithRemoteOptions(map[string]interface{}{
-			"format": t.Format,
+			"format": t.Output,
 		}),
 		nodeaction.WithLocalRun(func() (interface{}, error) {
 			n, err := object.NewNode()

diff --git a/core/commands/node_compliance_attach_ruleset.go b/core/commands/node_compliance_attach_ruleset.go
@@ -16,12 +16,12 @@ func (t *CmdNodeComplianceAttachRuleset) Run() error {
 	return nodeaction.New(
 		nodeaction.WithLocal(t.Local),
 		nodeaction.WithRemoteNodes(t.NodeSelector),
-		nodeaction.WithFormat(t.Format),
+		nodeaction.WithFormat(t.Output),
 		nodeaction.WithColor(t.Color),
 		nodeaction.WithServer(t.Server),
 		nodeaction.WithRemoteAction("compliance attach ruleset"),
 		nodeaction.WithRemoteOptions(map[string]interface{}{
-			"format": t.Format,
+			"format": t.Output,
 		}),
 		nodeaction.WithLocalRun(func() (interface{}, error) {
 			n, err := object.NewNode()

diff --git a/core/commands/node_compliance_auto.go b/core/commands/node_compliance_auto.go
@@ -19,12 +19,12 @@ func (t *CmdNodeComplianceAuto) Run() error {
 	return nodeaction.New(
 		nodeaction.WithLocal(t.Local),
 		nodeaction.WithRemoteNodes(t.NodeSelector),
-		nodeaction.WithFormat(t.Format),
+		nodeaction.WithFormat(t.Output),
 		nodeaction.WithColor(t.Color),
 		nodeaction.WithServer(t.Server),
 		nodeaction.WithRemoteAction("compliance auto"),
 		nodeaction.WithRemoteOptions(map[string]interface{}{
-			"format":    t.Format,
+			"format":    t.Output,
 			"force":     t.Force,
 			"module":    t.Module,
 			"moduleset": t.Moduleset,

diff --git a/core/commands/node_compliance_check.go b/core/commands/node_compliance_check.go
@@ -19,12 +19,12 @@ func (t *CmdNodeComplianceCheck) Run() error {
 	return nodeaction.New(
 		nodeaction.WithLocal(t.Local),
 		nodeaction.WithRemoteNodes(t.NodeSelector),
-		nodeaction.WithFormat(t.Format),
+		nodeaction.WithFormat(t.Output),
 		nodeaction.WithColor(t.Color),
 		nodeaction.WithServer(t.Server),
 		nodeaction.WithRemoteAction("compliance check"),
 		nodeaction.WithRemoteOptions(map[string]interface{}{
-			"format":    t.Format,
+			"format":    t.Output,
 			"force":     t.Force,
 			"module":    t.Module,
 			"moduleset": t.Moduleset,

diff --git a/core/commands/node_compliance_detach_moduleset.go b/core/commands/node_compliance_detach_moduleset.go
@@ -16,12 +16,12 @@ func (t *CmdNodeComplianceDetachModuleset) Run() error {
 	return nodeaction.New(
 		nodeaction.WithLocal(t.Local),
 		nodeaction.WithRemoteNodes(t.NodeSelector),
-		nodeaction.WithFormat(t.Format),
+		nodeaction.WithFormat(t.Output),
 		nodeaction.WithColor(t.Color),
 		nodeaction.WithServer(t.Server),
 		nodeaction.WithRemoteAction("compliance detach moduleset"),
 		nodeaction.WithRemoteOptions(map[string]interface{}{
-			"format":    t.Format,
+			"format":    t.Output,
 			"moduleset": t.Moduleset,
 		}),
 		nodeaction.WithLocalRun(func() (interface{}, error) {

diff --git a/core/commands/node_compliance_detach_ruleset.go b/core/commands/node_compliance_detach_ruleset.go
@@ -16,12 +16,12 @@ func (t *CmdNodeComplianceDetachRuleset) Run() error {
 	return nodeaction.New(
 		nodeaction.WithLocal(t.Local),
 		nodeaction.WithRemoteNodes(t.NodeSelector),
-		nodeaction.WithFormat(t.Format),
+		nodeaction.WithFormat(t.Output),
 		nodeaction.WithColor(t.Color),
 		nodeaction.WithServer(t.Server),
 		nodeaction.WithRemoteAction("compliance detach ruleset"),
 		nodeaction.WithRemoteOptions(map[string]interface{}{
-			"format": t.Format,
+			"format": t.Output,
 		}),
 		nodeaction.WithLocalRun(func() (interface{}, error) {
 			n, err := object.NewNode()

diff --git a/core/commands/node_compliance_env.go b/core/commands/node_compliance_env.go
@@ -17,12 +17,12 @@ func (t *CmdNodeComplianceEnv) Run() error {
 	return nodeaction.New(
 		nodeaction.WithLocal(t.Local),
 		nodeaction.WithRemoteNodes(t.NodeSelector),
-		nodeaction.WithFormat(t.Format),
+		nodeaction.WithFormat(t.Output),
 		nodeaction.WithColor(t.Color),
 		nodeaction.WithServer(t.Server),
 		nodeaction.WithRemoteAction("compliance env"),
 		nodeaction.WithRemoteOptions(map[string]interface{}{
-			"format":    t.Format,
+			"format":    t.Output,
 			"moduleset": t.Moduleset,
 			"module":    t.Module,
 		}),

diff --git a/core/commands/node_compliance_fix.go b/core/commands/node_compliance_fix.go
@@ -19,12 +19,12 @@ func (t *CmdNodeComplianceFix) Run() error {
 	return nodeaction.New(
 		nodeaction.WithLocal(t.Local),
 		nodeaction.WithRemoteNodes(t.NodeSelector),
-		nodeaction.WithFormat(t.Format),
+		nodeaction.WithFormat(t.Output),
 		nodeaction.WithColor(t.Color),
 		nodeaction.WithServer(t.Server),
 		nodeaction.WithRemoteAction("compliance fix"),
 		nodeaction.WithRemoteOptions(map[string]interface{}{
-			"format":    t.Format,
+			"format":    t.Output,
 			"force":     t.Force,
 			"module":    t.Module,
 			"moduleset": t.Moduleset,

diff --git a/core/commands/node_compliance_fixable.go b/core/commands/node_compliance_fixable.go
@@ -19,12 +19,12 @@ func (t *CmdNodeComplianceFixable) Run() error {
 	return nodeaction.New(
 		nodeaction.WithLocal(t.Local),
 		nodeaction.WithRemoteNodes(t.NodeSelector),
-		nodeaction.WithFormat(t.Format),
+		nodeaction.WithFormat(t.Output),
 		nodeaction.WithColor(t.Color),
 		nodeaction.WithServer(t.Server),
 		nodeaction.WithRemoteAction("compliance fixable"),
 		nodeaction.WithRemoteOptions(map[string]interface{}{
-			"format":    t.Format,
+			"format":    t.Output,
 			"force":     t.Force,
 			"module":    t.Module,
 			"moduleset": t.Moduleset,