github.com/spf13/cobra v1.9.1: 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.9.1
Kind: HOW

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

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.

package cobracli

import (
	"bytes"

	"github.com/spf13/cobra"
)

// NewRootCommand creates a sample root command with flags and a subcommand.
func NewRootCommand() (*cobra.Command, *bytes.Buffer) {
	buf := new(bytes.Buffer)
	var name string

	rootCmd := &cobra.Command{
		Use:   "app",
		Short: "A minimal CLI app using cobra",
		RunE: func(cmd *cobra.Command, args []string) error {
			if name == "" {
				name = "world"
			}
			cmd.Printf("Hello, %s!", name)
			return nil
		},
	}

	rootCmd.Flags().StringVarP(&name, "name", "n", "world", "Name to greet")
	rootCmd.SetOut(buf)
	rootCmd.SetErr(buf)

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

	return rootCmd, buf
}

{"case":{"caseId":"case:sha256:92c7945201eedf9e83b54a42dc71450ee1ad4c1f1cb441ce5f48371e4dfdc09a","contract":["cobra.Command executes root command logic and parses flags correctly","cobra.Command supports adding subcommands with argument validation and output redirection"],"goal":"verify pkg:golang/github.com/spf13/cobra@v1.9.1","kind":"HOW","packages":["pkg:golang/github.com/spf13/cobra@v1.9.1"],"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.9.1"],"schemaVersion":1,"symbols":["github.com/spf13/cobra.Command"],"verifierAdapter":"golang@1"}

module example.com/cobra-cli

go 1.25.0

require github.com/spf13/cobra v1.9.1

require (
	github.com/inconshreveable/mousetrap v1.1.0 // indirect
	github.com/spf13/pflag v1.0.6 // 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.9.1 h1:CXSaggrXdbHK9CF+8ywj8Amf7PBRmPCOJugH954Nnlo=
github.com/spf13/cobra v1.9.1/go.mod h1:nDyEzZ8ogv936Cinf6g1RU9MRY64Ir93oCnqb9wxYW0=
github.com/spf13/pflag v1.0.6 h1:jFzHGLGAlb3ruxLB8MhbI6A8+AQX/2eW4qeyNZXNp2o=
github.com/spf13/pflag v1.0.6/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

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

package main

import (
	"bytes"
	"fmt"
	"os"

	cobracli "example.com/cobra-cli"
	"github.com/spf13/cobra"
)

func main() {
	// Assertion 1: Execute root command with default flag
	cmd, buf := cobracli.NewRootCommand()
	cmd.SetArgs([]string{})
	if err := cmd.Execute(); err != nil {
		fmt.Fprintf(os.Stderr, "FAIL: root command execution failed: %v\n", err)
		os.Exit(1)
	}
	if got := buf.String(); got != "Hello, world!" {
		fmt.Fprintf(os.Stderr, "FAIL: expected 'Hello, world!', got '%s'\n", got)
		os.Exit(1)
	}

	// Assertion 2: Execute root command with custom --name flag
	cmd, buf = cobracli.NewRootCommand()
	cmd.SetArgs([]string{"--name", "Cobra"})
	if err := cmd.Execute(); err != nil {
		fmt.Fprintf(os.Stderr, "FAIL: root command with flag execution failed: %v\n", err)
		os.Exit(1)
	}
	if got := buf.String(); got != "Hello, Cobra!" {
		fmt.Fprintf(os.Stderr, "FAIL: expected 'Hello, Cobra!', got '%s'\n", got)
		os.Exit(1)
	}

	// Assertion 3: Execute subcommand with arguments
	cmd, buf = cobracli.NewRootCommand()
	cmd.SetArgs([]string{"echo", "test message"})
	if err := cmd.Execute(); err != nil {
		fmt.Fprintf(os.Stderr, "FAIL: subcommand execution failed: %v\n", err)
		os.Exit(1)
	}
	if got := buf.String(); got != "Echo: test message" {
		fmt.Fprintf(os.Stderr, "FAIL: expected 'Echo: test message', got '%s'\n", got)
		os.Exit(1)
	}

	// Assertion 4: Subcommand validation fails when required arg is missing
	cmd, buf = cobracli.NewRootCommand()
	cmd.SetArgs([]string{"echo"})
	if err := cmd.Execute(); err == nil {
		fmt.Fprintf(os.Stderr, "FAIL: expected error when executing echo without args, got nil\n")
		os.Exit(1)
	}

	// Assertion 5: Direct usage of cobra.Command
	directCmd := &cobra.Command{
		Use: "ping",
		Run: func(c *cobra.Command, args []string) {
			c.Print("pong")
		},
	}
	var directBuf bytes.Buffer
	directCmd.SetOut(&directBuf)
	if err := directCmd.Execute(); err != nil {
		fmt.Fprintf(os.Stderr, "FAIL: direct command execution failed: %v\n", err)
		os.Exit(1)
	}
	if directBuf.String() != "pong" {
		fmt.Fprintf(os.Stderr, "FAIL: expected 'pong', got '%s'\n", directBuf.String())
		os.Exit(1)
	}

	fmt.Println("PASS: cobra.Command contract passed")
}