github.com/spf13/cobra v1.10.2: Command

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify pkg:golang/github.com/spf13/cobra@v1.10.2
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:golang/github.com/spf13/cobra@v1.10.2

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:cc17011ee53f3f7a198ccb79f8f28712c89483739c757ab8157708d20b4cceff","contract":["cobra.Command initializes with Use and Short descriptions","cobra.Command executes root command RunE successfully","cobra.Command AddCommand registers subcommands correctly","cobra.Command validates exact arguments using cobra.ExactArgs","cobra.Command executes subcommand with arguments and captures output"],"goal":"verify pkg:golang/github.com/spf13/cobra@v1.10.2","kind":"HOW","packages":["pkg:golang/github.com/spf13/cobra@v1.10.2"],"schemaVersion":1,"symbols":["github.com/spf13/cobra.Command"]},"contractCommand":["go","run","./test"],"environment":{"arch":"x64","ecosystem":"golang","os":"windows","osVersionBucket":"11","packageManager":"go","schemaVersion":1},"license":"MIT-0","packages":["pkg:golang/github.com/spf13/cobra@v1.10.2"],"schemaVersion":1,"symbols":["github.com/spf13/cobra.Command"],"verifierAdapter":"golang@1"}

module sample

go 1.26.5

require (
	github.com/inconshreveable/mousetrap v1.1.0 // indirect
	github.com/spf13/cobra v1.10.2 // indirect
	github.com/spf13/pflag v1.0.9 // indirect
)

github.com/cpuguy83/go-md2man/v2 v2.0.6/go.mod h1:oOW0eioCTA6cOiMLiUPZOpcVxMig6NIQQ7OS05n1F4g=
github.com/inconshreveable/mousetrap v1.1.0 h1:wN+x4NVGpMsO7ErUn/mUI3vEoE6Jt13X2s0bqwp9tc8=
github.com/inconshreveable/mousetrap v1.1.0/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw=
github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM=
github.com/spf13/cobra v1.10.2 h1:DMTTonx5m65Ic0GOoRY2c16WCbHxOOw6xxezuLaBpcU=
github.com/spf13/cobra v1.10.2/go.mod h1:7C1pvHqHw5A4vrJfjNwvOdzYu0Gml16OCs2GRiTUUS4=
github.com/spf13/pflag v1.0.9 h1:9exaQaMOCwffKiiiYk6/BndUBv+iRViNW+4lEMi0PvY=
github.com/spf13/pflag v1.0.9/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
go.yaml.in/yaml/v3 v3.0.4/go.mod h1:DhzuOOF2ATzADvBadXxruRBLzYTpT36CKvDb3+aBEFg=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=

package main

import (
	"bytes"
	"fmt"
	"os"
	"strings"

	"github.com/spf13/cobra"
)

// NewRootCmd creates and returns the root cobra command.
func NewRootCmd() *cobra.Command {
	var verbose bool

	rootCmd := &cobra.Command{
		Use:   "app",
		Short: "A minimal CLI built with Cobra",
		RunE: func(cmd *cobra.Command, args []string) error {
			if verbose {
				cmd.Println("Verbose mode enabled")
			}
			cmd.Println("Running root command")
			return nil
		},
	}

	rootCmd.PersistentFlags().BoolVarP(&verbose, "verbose", "v", false, "enable verbose output")

	echoCmd := &cobra.Command{
		Use:   "echo [message]",
		Short: "Echo back the provided message",
		Args:  cobra.ExactArgs(1),
		RunE: func(cmd *cobra.Command, args []string) error {
			cmd.Println(args[0])
			return nil
		},
	}

	versionCmd := &cobra.Command{
		Use:   "version",
		Short: "Print the application version",
		RunE: func(cmd *cobra.Command, args []string) error {
			cmd.Println("app version 1.0.0")
			return nil
		},
	}

	rootCmd.AddCommand(echoCmd, versionCmd)
	return rootCmd
}

// ExecuteCommand executes the command with given arguments and returns output and error.
func ExecuteCommand(cmd *cobra.Command, args ...string) (string, error) {
	buf := new(bytes.Buffer)
	cmd.SetOut(buf)
	cmd.SetErr(buf)
	cmd.SetArgs(args)

	err := cmd.Execute()
	return strings.TrimSpace(buf.String()), err
}

func main() {
	cmd := NewRootCmd()
	if err := cmd.Execute(); err != nil {
		fmt.Fprintln(os.Stderr, err)
		os.Exit(1)
	}
}

{
  "schemaVersion": 1,
  "goal": "verify pkg:golang/github.com/spf13/cobra@v1.10.2",
  "kind": "HOW",
  "packages": [
    "pkg:golang/github.com/spf13/cobra@v1.10.2"
  ],
  "symbols": [
    "github.com/spf13/cobra.Command"
  ]
}

package main

import (
	"bytes"
	"fmt"
	"os"
	"strings"

	"github.com/spf13/cobra"
)

func assertTrue(name string, condition bool) {
	if !condition {
		fmt.Fprintf(os.Stderr, "Assertion failed for %s: expected true, got false\n", name)
		os.Exit(1)
	}
}

func assertEqual(name, actual, expected string) {
	if actual != expected {
		fmt.Fprintf(os.Stderr, "Assertion failed for %s: got %q, expected %q\n", name, actual, expected)
		os.Exit(1)
	}
}

func main() {
	// Contract: cobra.Command initializes with Use and Short descriptions
	rootCmd := &cobra.Command{
		Use:   "testapp",
		Short: "Test application for cobra verification",
	}
	assertTrue("rootCmd.Use equals 'testapp'", rootCmd.Use == "testapp")
	assertTrue("rootCmd.Short equals 'Test application for cobra verification'", rootCmd.Short == "Test application for cobra verification")

	// Contract: cobra.Command executes root command RunE successfully
	var rootExecuted bool
	rootCmd.RunE = func(cmd *cobra.Command, args []string) error {
		rootExecuted = true
		cmd.Println("root executed")
		return nil
	}
	buf := new(bytes.Buffer)
	rootCmd.SetOut(buf)
	rootCmd.SetErr(buf)
	rootCmd.SetArgs([]string{})

	err := rootCmd.Execute()
	assertTrue("rootCmd.Execute returns nil error", err == nil)
	assertTrue("rootExecuted is true", rootExecuted)
	assertEqual("root output matches", strings.TrimSpace(buf.String()), "root executed")

	// Contract: cobra.Command AddCommand registers subcommands correctly
	subCmd := &cobra.Command{
		Use:   "sub [msg]",
		Short: "Subcommand test",
		Args:  cobra.ExactArgs(1),
		RunE: func(cmd *cobra.Command, args []string) error {
			cmd.Printf("sub: %s\n", args[0])
			return nil
		},
	}
	rootCmd.AddCommand(subCmd)
	commands := rootCmd.Commands()
	var foundSub bool
	for _, c := range commands {
		if c.Name() == "sub" {
			foundSub = true
			break
		}
	}
	assertTrue("subcommand registered in rootCmd.Commands()", foundSub)

	// Contract: cobra.Command validates exact arguments using cobra.ExactArgs
	buf.Reset()
	rootCmd.SetArgs([]string{"sub"})
	err = rootCmd.Execute()
	assertTrue("subcommand execution without args returns error", err != nil)

	// Contract: cobra.Command executes subcommand with arguments and captures output
	buf.Reset()
	rootCmd.SetArgs([]string{"sub", "hello-world"})
	err = rootCmd.Execute()
	assertTrue("subcommand execution with valid args returns nil error", err == nil)
	assertEqual("sub output matches", strings.TrimSpace(buf.String()), "sub: hello-world")

	fmt.Println("All contract assertions passed successfully.")
}