feat: add cobra framework with help, version commands

jakec-dev · jakec-dev · commit 8d7e865ad016 · 2025-06-08T15:23:38.000+10:00
diff --git a/.goreleaser.yml b/.goreleaser.yml
@@ -86,31 +86,24 @@ release:
   name_template: "{{ .ProjectName }} {{ .Tag }}"
   
   header: |
-    ## AWS Local Sync {{ .Tag }}
-    
-    High-performance CLI tool that syncs data from AWS services (RDS, DynamoDB, S3, Elasticsearch, etc.) to your local development environment.
-    
-    ### Highlights
+    High-performance CLI tool that syncs data from AWS services to your local development environment.
   
   footer: |
+    ## Installation
     
-    ---
-    
-    ### Installation
-    
-    #### Binary installation
+    ### Binary installation
     ```bash
     # Download and extract (example for Linux x86_64)
     curl -sSL https://github.com/jakec-dev/aws-local-sync/releases/download/{{ .Tag }}/aws-local-sync_Linux_x86_64.tar.gz | tar xz
     
-    # Verify checksum signature
+    #### Verify checksum signature
     cosign verify-blob \
       --certificate aws-local-sync_checksums.txt.pem \
       --signature aws-local-sync_checksums.txt.sig \
       aws-local-sync_checksums.txt
     ```
     
-    #### Go installation
+    ### Go installation
     ```bash
     go install github.com/jakec-dev/aws-local-sync/cmd/aws-local-sync@{{ .Tag }}
     ```
diff --git a/.lefthook.yml b/.lefthook.yml
@@ -3,7 +3,7 @@ pre-commit:
   commands:
     golangci-lint:
       glob: "*.go"
-      run: golangci-lint run --fix --fast-only {staged_files}
+      run: golangci-lint run --fix --new-from-rev HEAD~1
       stage_fixed: true
     go-mod-tidy:
       glob: "go.mod"
diff --git a/Makefile b/Makefile
@@ -11,9 +11,9 @@ GIT_COMMIT 		:= $(shell git rev-parse --short HEAD)
 BUILD_TIME 		:= $(shell date +%FT%T%z)
 
 LDFLAGS := "-s -w \
-    -X 'main.Version=$(VERSION)' \
-    -X 'main.GitCommit=$(GIT_COMMIT)' \
-    -X 'main.BuildTime=$(BUILD_TIME)'"
+    -X 'github.com/jakec-dev/aws-local-sync/internal/version.version=$(VERSION)' \
+    -X 'github.com/jakec-dev/aws-local-sync/internal/version.gitCommit=$(GIT_COMMIT)' \
+    -X 'github.com/jakec-dev/aws-local-sync/internal/version.buildTime=$(BUILD_TIME)'"
 
 GREEN  := $(shell tput -Txterm setaf 2)
 YELLOW := $(shell tput -Txterm setaf 3)
@@ -76,6 +76,10 @@ install: ## Install all development dependencies, tools, and git hooks
 lint: ## Run code linters via golangci-lint
 	golangci-lint run
 
+.PHONY: lint-fix
+lint-fix: ## Fix linting and formatting issues
+	golangci-lint run --fix
+
 .PHONY: audit
 audit: test ## Run full audit: verify modules, scan for issues and vulnerabilities
 	go mod tidy -diff
diff --git a/README.md b/README.md
@@ -22,7 +22,7 @@ Key features:
 go install github.com/jakec-dev/aws-local-sync/cmd/aws-local-sync@latest
 
 # Then use it from anywhere:
-aws-local-sync
+aws-local-sync --help
 ```
 
 ### Option 2: Run from source
@@ -33,10 +33,20 @@ git clone https://github.com/jakec-dev/aws-local-sync.git
 cd aws-local-sync
 
 # Build the CLI
-go build -o bin/aws-local-sync ./cmd/aws-local-sync
+make build
 
 # Run the CLI
-./bin/aws-local-sync
+./bin/aws-local-sync --help
+```
+
+### Basic Usage
+
+```sh
+# Show available commands
+aws-local-sync --help
+
+# Check version and build info
+aws-local-sync version
 ```
 
 ## Contributing
diff --git a/cmd/aws-local-sync/main.go b/cmd/aws-local-sync/main.go
@@ -1,5 +1,15 @@
 package main
 
+import (
+	"fmt"
+	"os"
+
+	"github.com/jakec-dev/aws-local-sync/internal/cli"
+)
+
 func main() {
-	// Placeholder
+	if err := cli.Execute(cli.NewRootCommand()); err != nil {
+		fmt.Fprintln(os.Stderr, err)
+		os.Exit(1)
+	}
 }
diff --git a/go.mod b/go.mod
@@ -1,3 +1,10 @@
 module github.com/jakec-dev/aws-local-sync
 
 go 1.24.3
+
+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
+)
diff --git a/go.sum b/go.sum
@@ -0,0 +1,10 @@
+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=
diff --git a/internal/cli/commands.go b/internal/cli/commands.go
@@ -0,0 +1,7 @@
+package cli
+
+import "github.com/spf13/cobra"
+
+func RegisterCommands(rootCmd *cobra.Command) {
+	rootCmd.AddCommand(NewVersionCommand(rootCmd.OutOrStdout()))
+}
diff --git a/internal/cli/commands_test.go b/internal/cli/commands_test.go
@@ -0,0 +1,27 @@
+package cli_test
+
+import (
+	"testing"
+
+	"github.com/spf13/cobra"
+
+	"github.com/jakec-dev/aws-local-sync/internal/cli"
+)
+
+func TestAllCommandsPresent(t *testing.T) {
+	cmd := &cobra.Command{Use: "test"}
+
+	cli.RegisterCommands(cmd)
+
+	expected := map[string]bool{"version": false}
+	for _, sc := range cmd.Commands() {
+		if _, ok := expected[sc.Name()]; ok {
+			expected[sc.Name()] = true
+		}
+	}
+	for name, seen := range expected {
+		if !seen {
+			t.Errorf("Expected subcommand %q to be registered", name)
+		}
+	}
+}
diff --git a/internal/cli/root.go b/internal/cli/root.go
@@ -0,0 +1,32 @@
+package cli
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+)
+
+func NewRootCommand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "aws-local-sync",
+		Short: "Sync data from AWS services to your local development environment",
+		Long: `aws-local-sync is a high-performance CLI tool for syncing data from AWS services
+into your local development environment.
+
+Documentation:
+  https://github.com/jakec-dev/aws-local-sync/wiki`,
+		SilenceUsage:  true,
+		SilenceErrors: true,
+	}
+
+	RegisterCommands(cmd)
+
+	return cmd
+}
+
+func Execute(cmd *cobra.Command) error {
+	if err := cmd.Execute(); err != nil {
+		return fmt.Errorf("command execution failed: %w", err)
+	}
+	return nil
+}
diff --git a/internal/cli/root_test.go b/internal/cli/root_test.go
@@ -0,0 +1,52 @@
+package cli_test
+
+import (
+	"bytes"
+	"strings"
+	"testing"
+
+	"github.com/jakec-dev/aws-local-sync/internal/cli"
+)
+
+func executeCommand(args ...string) (string, error) {
+	buf := new(bytes.Buffer)
+	cmd := cli.NewRootCommand()
+	cmd.SetOut(buf)
+	cmd.SetErr(buf)
+	cmd.SetArgs(args)
+
+	err := cli.Execute(cmd)
+
+	return buf.String(), err
+}
+
+func TestRootCommand(t *testing.T) {
+	output, err := executeCommand()
+
+	if err != nil {
+		t.Fatalf("Expected no error, got %v", err)
+	}
+	if !strings.Contains(output, "aws-local-sync") {
+		t.Errorf("Expected output to contain `aws-local-sync`, got %s", output)
+	}
+}
+
+func TestUnknownCommand(t *testing.T) {
+	buf := new(bytes.Buffer)
+	cmd := cli.NewRootCommand()
+	cmd.SilenceErrors = false
+	cmd.SilenceUsage = false
+	cmd.SetOut(buf)
+	cmd.SetErr(buf)
+	cmd.SetArgs([]string{"invalid-command"})
+
+	err := cli.Execute(cmd)
+	output := buf.String()
+
+	if err == nil {
+		t.Fatalf("Expected error for unknown command, got nil")
+	}
+	if !strings.Contains(output, "unknown command") {
+		t.Errorf("Expected output to contain `unknown command`, got %s", output)
+	}
+}
diff --git a/internal/cli/version.go b/internal/cli/version.go
@@ -0,0 +1,27 @@
+package cli
+
+import (
+	"fmt"
+	"io"
+
+	"github.com/spf13/cobra"
+
+	"github.com/jakec-dev/aws-local-sync/internal/version"
+)
+
+func NewVersionCommand(out io.Writer) *cobra.Command {
+	return &cobra.Command{
+		Use:   "version",
+		Short: "Show detailed build and version information",
+		Long: `Display the current version of aws-local-sync, including build metadata.
+
+This includes the Git tag, commit hash, and build timestamp.
+Useful for debugging or verifying which version of the CLI is running.`,
+
+		Run: func(_ *cobra.Command, _ []string) {
+			v := version.Get()
+			fmt.Fprintf(out, "Version:     %s\n", v.Version)
+			fmt.Fprintf(out, "Git commit:  %s\n", v.GitCommit)
+			fmt.Fprintf(out, "Built at:    %s\n", v.BuildTime)
+		}}
+}
diff --git a/internal/cli/version_test.go b/internal/cli/version_test.go
@@ -0,0 +1,36 @@
+package cli_test
+
+import (
+	"bytes"
+	"strings"
+	"testing"
+
+	"github.com/spf13/cobra"
+
+	"github.com/jakec-dev/aws-local-sync/internal/cli"
+)
+
+func TestVersionCommand(t *testing.T) {
+	buf := new(bytes.Buffer)
+	cmd := cobra.Command{
+		Use: "test",
+	}
+	cmd.SetOut(buf)
+	cmd.SetErr(buf)
+
+	err := cli.NewVersionCommand(cmd.OutOrStdout()).Execute()
+
+	if err != nil {
+		t.Fatalf("Expected no error, got %v", err)
+	}
+	output := buf.String()
+	if !strings.Contains(output, "Version:") {
+		t.Errorf("Expected output to contain `Version:`, got %s", output)
+	}
+	if !strings.Contains(output, "Git commit:") {
+		t.Errorf("Expected output to contain `Git commit:`, got %s", output)
+	}
+	if !strings.Contains(output, "Built at:") {
+		t.Errorf("Expected output to contain `Built at:`, got %s", output)
+	}
+}
diff --git a/internal/version/version.go b/internal/version/version.go
@@ -0,0 +1,22 @@
+package version
+
+//nolint:gochecknoglobals // required for version injection via ldflags
+var (
+	version   = "dev"
+	gitCommit = "none"
+	buildTime = "unknown"
+)
+
+type Info struct {
+	Version   string
+	GitCommit string
+	BuildTime string
+}
+
+func Get() Info {
+	return Info{
+		Version:   version,
+		GitCommit: gitCommit,
+		BuildTime: buildTime,
+	}
+}
