Add proboctl core skeleton and build system

Introduce the proboctl CLI entry point, root command, version, completion, iostreams, shared cmdutil helpers (flags, table, JSON, time formatting), API client with pagination, config management, goreleaser configuration, and build system integration. Signed-off-by: Bryan Frimin <bryan@getprobo.com>
2026-03-14 23:34:22 +01:00
parent 0b7c0e0806
commit 6919b9372a
18 changed files with 1286 additions and 4 deletions
--- a/pkg/cmd/cmdutil/factory.go
+++ b/pkg/cmd/cmdutil/factory.go
@@ -0,0 +1,26 @@
+// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+package cmdutil
+
+import (
+	"go.probo.inc/probo/pkg/cli/config"
+	"go.probo.inc/probo/pkg/cmd/iostreams"
+)
+
+type Factory struct {
+	IOStreams *iostreams.IOStreams
+	Version  string
+	Config   func() (*config.Config, error)
+}
--- a/pkg/cmd/cmdutil/flags.go
+++ b/pkg/cmd/cmdutil/flags.go
@@ -0,0 +1,75 @@
+// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+package cmdutil
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/spf13/cobra"
+)
+
+const (
+	OutputJSON  = "json"
+	OutputTable = "table"
+)
+
+// AddOutputFlag registers --output / -o on cmd and returns a pointer to the
+// value. The default is "table". Callers should call ValidateOutputFlag early
+// in RunE, then branch on *p.
+func AddOutputFlag(cmd *cobra.Command) *string {
+	var output string
+	cmd.Flags().StringVarP(
+		&output,
+		"output",
+		"o",
+		"",
+		"Output format: json, table (default)",
+	)
+	return &output
+}
+
+// ValidateOutputFlag checks that value is a supported output format. An empty
+// string is treated as table (the default).
+func ValidateOutputFlag(value *string) error {
+	switch *value {
+	case "":
+		*value = OutputTable
+		return nil
+	case OutputJSON, OutputTable:
+		return nil
+	default:
+		return fmt.Errorf(
+			"invalid --output value %q: valid values are json, table",
+			*value,
+		)
+	}
+}
+
+// ValidateEnum checks that value is one of the allowed values. It returns a
+// user-friendly error mentioning the flag name and the valid choices.
+func ValidateEnum(flag string, value string, allowed []string) error {
+	for _, v := range allowed {
+		if value == v {
+			return nil
+		}
+	}
+	return fmt.Errorf(
+		"invalid --%s value %q: valid values are %s",
+		flag,
+		value,
+		strings.Join(allowed, ", "),
+	)
+}
--- a/pkg/cmd/cmdutil/json.go
+++ b/pkg/cmd/cmdutil/json.go
@@ -0,0 +1,31 @@
+// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+package cmdutil
+
+import (
+	"encoding/json"
+	"fmt"
+	"io"
+)
+
+// PrintJSON writes v as indented JSON followed by a newline.
+func PrintJSON(out io.Writer, v any) error {
+	data, err := json.MarshalIndent(v, "", "  ")
+	if err != nil {
+		return fmt.Errorf("cannot marshal JSON: %w", err)
+	}
+	_, err = fmt.Fprintln(out, string(data))
+	return err
+}
--- a/pkg/cmd/cmdutil/table.go
+++ b/pkg/cmd/cmdutil/table.go
@@ -0,0 +1,37 @@
+// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+package cmdutil
+
+import (
+	"github.com/charmbracelet/lipgloss"
+	"github.com/charmbracelet/lipgloss/table"
+)
+
+// NewTable returns a pre-styled lipgloss table with the given headers.
+func NewTable(headers ...string) *table.Table {
+	headerStyle := lipgloss.NewStyle().Bold(true).Padding(0, 1)
+	cellStyle := lipgloss.NewStyle().Padding(0, 1)
+
+	return table.New().
+		Border(lipgloss.NormalBorder()).
+		BorderStyle(lipgloss.NewStyle().Foreground(lipgloss.Color("238"))).
+		Headers(headers...).
+		StyleFunc(func(row, col int) lipgloss.Style {
+			if row == table.HeaderRow {
+				return headerStyle
+			}
+			return cellStyle
+		})
+}
--- a/pkg/cmd/cmdutil/time.go
+++ b/pkg/cmd/cmdutil/time.go
@@ -0,0 +1,27 @@
+// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+package cmdutil
+
+import "time"
+
+// FormatTime parses an RFC3339 timestamp and returns a human-friendly
+// local representation. If parsing fails it returns the raw string.
+func FormatTime(raw string) string {
+	t, err := time.Parse(time.RFC3339, raw)
+	if err != nil {
+		return raw
+	}
+	return t.Local().Format("Jan 02, 2006 15:04 MST")
+}
--- a/pkg/cmd/completion/completion.go
+++ b/pkg/cmd/completion/completion.go
@@ -0,0 +1,75 @@
+// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+package completion
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+	"go.probo.inc/probo/pkg/cmd/cmdutil"
+)
+
+func NewCmdCompletion(f *cmdutil.Factory) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "completion <shell>",
+		Short: "Generate shell completion scripts",
+		Long: `Generate shell completion scripts for proboctl.
+
+To load completions:
+
+Bash:
+  $ source <(proboctl completion bash)
+  # To load completions for each session, execute once:
+  # Linux:
+  $ proboctl completion bash > /etc/bash_completion.d/proboctl
+  # macOS:
+  $ proboctl completion bash > $(brew --prefix)/etc/bash_completion.d/proboctl
+
+Zsh:
+  $ source <(proboctl completion zsh)
+  # To load completions for each session, execute once:
+  $ proboctl completion zsh > "${fpath[1]}/_proboctl"
+
+Fish:
+  $ proboctl completion fish | source
+  # To load completions for each session, execute once:
+  $ proboctl completion fish > ~/.config/fish/completions/proboctl.fish
+
+PowerShell:
+  PS> proboctl completion powershell | Out-String | Invoke-Expression
+  # To load completions for each session, execute once:
+  PS> proboctl completion powershell > proboctl.ps1`,
+		ValidArgs:             []string{"bash", "zsh", "fish", "powershell"},
+		Args:                  cobra.MatchAll(cobra.ExactArgs(1), cobra.OnlyValidArgs),
+		DisableFlagsInUseLine: true,
+		RunE: func(cmd *cobra.Command, args []string) error {
+			out := f.IOStreams.Out
+			switch args[0] {
+			case "bash":
+				return cmd.Root().GenBashCompletionV2(out, true)
+			case "zsh":
+				return cmd.Root().GenZshCompletion(out)
+			case "fish":
+				return cmd.Root().GenFishCompletion(out, true)
+			case "powershell":
+				return cmd.Root().GenPowerShellCompletionWithDesc(out)
+			default:
+				return fmt.Errorf("unsupported shell: %s", args[0])
+			}
+		},
+	}
+
+	return cmd
+}
--- a/pkg/cmd/iostreams/iostreams.go
+++ b/pkg/cmd/iostreams/iostreams.go
@@ -0,0 +1,104 @@
+// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+package iostreams
+
+import (
+	"bytes"
+	"io"
+	"os"
+
+	"github.com/charmbracelet/lipgloss"
+	"github.com/muesli/termenv"
+	"golang.org/x/term"
+)
+
+type IOStreams struct {
+	In     io.ReadCloser
+	Out    io.Writer
+	ErrOut io.Writer
+
+	// ForceNonInteractive disables all interactive prompts. Set by the
+	// --no-interactive global flag or the PROBO_NO_INTERACTIVE env var.
+	ForceNonInteractive bool
+
+	// ForceNoColor disables ANSI color output. Set by the --no-color
+	// global flag, the NO_COLOR env var, or TERM=dumb.
+	ForceNoColor bool
+}
+
+func (s *IOStreams) IsInteractive() bool {
+	if s.ForceNonInteractive {
+		return false
+	}
+	return s.isStdinTTY() && s.isStdoutTTY()
+}
+
+func (s *IOStreams) isStdinTTY() bool {
+	if f, ok := s.In.(*os.File); ok {
+		return term.IsTerminal(int(f.Fd()))
+	}
+	return false
+}
+
+func (s *IOStreams) isStdoutTTY() bool {
+	if f, ok := s.Out.(*os.File); ok {
+		return term.IsTerminal(int(f.Fd()))
+	}
+	return false
+}
+
+func (s *IOStreams) IsStdinTTY() bool {
+	return s.isStdinTTY()
+}
+
+func (s *IOStreams) IsStdoutTTY() bool {
+	if s.ForceNonInteractive {
+		return false
+	}
+	return s.isStdoutTTY()
+}
+
+func (s *IOStreams) ColorEnabled() bool {
+	if s.ForceNoColor {
+		return false
+	}
+	return s.isStdoutTTY()
+}
+
+// ApplyColorProfile configures the lipgloss default renderer based on
+// the current color settings. Call this after ForceNoColor has been set.
+func (s *IOStreams) ApplyColorProfile() {
+	if s.ForceNoColor {
+		lipgloss.SetColorProfile(termenv.Ascii)
+	}
+}
+
+func System() *IOStreams {
+	return &IOStreams{
+		In:     os.Stdin,
+		Out:    os.Stdout,
+		ErrOut: os.Stderr,
+	}
+}
+
+func Test() (*IOStreams, *bytes.Buffer, *bytes.Buffer) {
+	out := new(bytes.Buffer)
+	errOut := new(bytes.Buffer)
+	return &IOStreams{
+		In:     io.NopCloser(new(bytes.Buffer)),
+		Out:    out,
+		ErrOut: errOut,
+	}, out, errOut
+}
--- a/pkg/cmd/root/root.go
+++ b/pkg/cmd/root/root.go
@@ -0,0 +1,80 @@
+// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+package root
+
+import (
+	"github.com/spf13/cobra"
+	cmdapi "go.probo.inc/probo/pkg/cmd/api"
+	"go.probo.inc/probo/pkg/cmd/auth"
+	"go.probo.inc/probo/pkg/cmd/browse"
+	"go.probo.inc/probo/pkg/cmd/cmdutil"
+	"go.probo.inc/probo/pkg/cmd/completion"
+	cmdconfig "go.probo.inc/probo/pkg/cmd/config"
+	"go.probo.inc/probo/pkg/cmd/control"
+	"go.probo.inc/probo/pkg/cmd/framework"
+	"go.probo.inc/probo/pkg/cmd/org"
+	"go.probo.inc/probo/pkg/cmd/risk"
+	"go.probo.inc/probo/pkg/cmd/soa"
+	"go.probo.inc/probo/pkg/cmd/user"
+	"go.probo.inc/probo/pkg/cmd/version"
+	"go.probo.inc/probo/pkg/cmd/webhook"
+)
+
+func NewCmdRoot(f *cmdutil.Factory) *cobra.Command {
+	cmd := &cobra.Command{
+		Use:           "proboctl <command> [flags]",
+		Short:         "Probo CLI",
+		Long:          "proboctl is a command-line tool for interacting with the Probo platform.",
+		SilenceUsage:  true,
+		SilenceErrors: true,
+		PersistentPreRun: func(cmd *cobra.Command, args []string) {
+			if noInteractive, _ := cmd.Flags().GetBool("no-interactive"); noInteractive {
+				f.IOStreams.ForceNonInteractive = true
+			}
+			if noColor, _ := cmd.Flags().GetBool("no-color"); noColor {
+				f.IOStreams.ForceNoColor = true
+			}
+			f.IOStreams.ApplyColorProfile()
+		},
+	}
+
+	cmd.PersistentFlags().Bool(
+		"no-interactive",
+		false,
+		"Disable interactive prompts (also set via PROBO_NO_INTERACTIVE=1, CI=true, or TERM=dumb)",
+	)
+
+	cmd.PersistentFlags().Bool(
+		"no-color",
+		false,
+		"Disable ANSI color output (also set via NO_COLOR or TERM=dumb)",
+	)
+
+	cmd.AddCommand(cmdapi.NewCmdAPI(f))
+	cmd.AddCommand(auth.NewCmdAuth(f))
+	cmd.AddCommand(browse.NewCmdBrowse(f))
+	cmd.AddCommand(completion.NewCmdCompletion(f))
+	cmd.AddCommand(cmdconfig.NewCmdConfig(f))
+	cmd.AddCommand(control.NewCmdControl(f))
+	cmd.AddCommand(framework.NewCmdFramework(f))
+	cmd.AddCommand(org.NewCmdOrg(f))
+	cmd.AddCommand(risk.NewCmdRisk(f))
+	cmd.AddCommand(soa.NewCmdSoa(f))
+	cmd.AddCommand(user.NewCmdUser(f))
+	cmd.AddCommand(version.NewCmdVersion(f))
+	cmd.AddCommand(webhook.NewCmdWebhook(f))
+
+	return cmd
+}
--- a/pkg/cmd/version/version.go
+++ b/pkg/cmd/version/version.go
@@ -0,0 +1,49 @@
+// Copyright (c) 2026 Probo Inc <hello@getprobo.com>.
+//
+// Permission to use, copy, modify, and/or distribute this software for any
+// purpose with or without fee is hereby granted, provided that the above
+// copyright notice and this permission notice appear in all copies.
+//
+// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+// REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+// AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+// INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+// LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+// OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+// PERFORMANCE OF THIS SOFTWARE.
+
+package version
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+	"go.probo.inc/probo/pkg/cmd/cmdutil"
+	"go.probo.inc/probo/pkg/version"
+)
+
+func NewCmdVersion(f *cmdutil.Factory) *cobra.Command {
+	return &cobra.Command{
+		Use:   "version",
+		Short: "Print the version of proboctl",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			info := version.GetBuildInfo()
+
+			v := f.Version
+			if v == "" || v == "unknown" {
+				v = info.Version
+			}
+
+			_, _ = fmt.Fprintf(
+				f.IOStreams.Out,
+				"proboctl version %s (commit: %s, built: %s, go: %s)\n",
+				v,
+				info.Commit,
+				info.BuildDate,
+				info.GoVersion,
+			)
+
+			return nil
+		},
+	}
+}