fix: cleanup-folder-structure-for-cli-import (#51)

This PR contains a number of QOL fixes:
1. Create `version` package to be used by CLI and controller
2. Move internal code packages into `internal` folder
3. Allow for CLI code to be run from external libraries, aka `kagent`

---------

Signed-off-by: Eitan Yarmush <eitan.yarmush@solo.io>

Author: EItanya

Dockerfile

@@ -21,7 +21,9 @@ COPY pkg/ pkg/
 # was called. For example, if we call make docker-build in a local env which has the Apple Silicon M1 SO
 # the docker BUILDPLATFORM arg will be linux/arm64 when for Apple x86 it will be linux/amd64. Therefore,
 # by leaving it empty we can ensure that the container and binary shipped on it will have the same platform.
-RUN CGO_ENABLED=0 GOOS=${TARGETOS:-linux} GOARCH=${TARGETARCH} go build -a -o manager cmd/main.go
+ARG LDFLAGS
+
+RUN CGO_ENABLED=0 GOOS=${TARGETOS:-linux} GOARCH=${TARGETARCH} go build -a -ldflags "$LDFLAGS" -o manager cmd/main.go
 
 # Use distroless as minimal base image to package the manager binary
 # Refer to https://github.com/GoogleContainerTools/distroless for more details

Makefile

@@ -9,6 +9,12 @@ BUILD_DATE := $(shell date -u '+%Y-%m-%d')
 GIT_COMMIT := $(shell git rev-parse --short HEAD || echo "unknown")
 VERSION ?= $(shell git describe --tags --always --dirty 2>/dev/null | sed 's/-dirty//' | grep v || echo "v0.0.1+$(GIT_COMMIT)")
 
+
+# Version information for the build
+LDFLAGS := "-X github.com/kagent-dev/kmcp/pkg/internal/version.Version=$(VERSION)      \
+            -X github.com/kagent-dev/kmcp/pkg/internal/version.GitCommit=$(GIT_COMMIT) \
+            -X github.com/kagent-dev/kmcp/pkg/internal/version.BuildDate=$(BUILD_DATE)"
+
 # Local architecture detection to build for the current platform
 LOCALARCH ?= $(shell uname -m | sed 's/x86_64/amd64/' | sed 's/aarch64/arm64/')
 
@@ -176,7 +182,7 @@ build: manifests generate fmt vet ## Build manager binary.
 .PHONY: build-cli
 build-cli: fmt vet ## Build kmcp CLI binary.
 	mkdir -p $(DIST_FOLDER)
-	go build -ldflags="-X 'github.com/kagent-dev/kmcp/cmd/kmcp/cmd.Version=$(VERSION)'" -o $(DIST_FOLDER)/kmcp cmd/kmcp/main.go
+	go build -ldflags=$(LDFLAGS) -o $(DIST_FOLDER)/kmcp cmd/kmcp/main.go
 
 .PHONY: run
 run: manifests generate fmt vet ## Run a controller from your host.

api/v1alpha1/zz_generated.deepcopy.go

@@ -4,11 +4,11 @@ import (
 	"fmt"
 	"os"
 
-	"github.com/kagent-dev/kmcp/cmd/kmcp/cmd"
+	"github.com/kagent-dev/kmcp/pkg/cli"
 )
 
 func main() {
-	if err := cmd.Execute(); err != nil {
+	if err := cli.Root().Execute(); err != nil {
 		fmt.Fprintf(os.Stderr, "Error: %v\n", err)
 		os.Exit(1)
 	}

cmd/kmcp/cmd/root.go

@@ -1,15 +1,15 @@
-package cmd
+package commands
 
 import (
 	"fmt"
 	"os"
 	"path/filepath"
 	"strings"
 
-	"github.com/kagent-dev/kmcp/pkg/templates"
+	"github.com/kagent-dev/kmcp/pkg/cli/internal/templates"
 
-	"github.com/kagent-dev/kmcp/pkg/frameworks"
-	"github.com/kagent-dev/kmcp/pkg/manifest"
+	"github.com/kagent-dev/kmcp/pkg/cli/internal/frameworks"
+	"github.com/kagent-dev/kmcp/pkg/cli/internal/manifest"
 	"github.com/spf13/cobra"
 )
 
@@ -41,7 +41,7 @@ var (
 )
 
 func init() {
-	rootCmd.AddCommand(addToolCmd)
+	addRootSubCmd(addToolCmd)
 
 	addToolCmd.Flags().StringVarP(&addToolDescription, "description", "d", "", "Tool description")
 	addToolCmd.Flags().BoolVarP(&addToolForce, "force", "f", false, "Overwrite existing tool file")
@@ -87,7 +87,7 @@ func runAddTool(_ *cobra.Command, args []string) error {
 	toolPath := filepath.Join("src", "tools", toolName+".py")
 	toolExists := fileExists(toolPath)
 
-	if verbose {
+	if Verbose {
 		fmt.Printf("Tool file path: %s\n", toolPath)
 		fmt.Printf("Tool exists: %v\n", toolExists)
 	}
@@ -174,7 +174,7 @@ func createToolInteractive(toolName, projectRoot, framework string) error {
 }
 
 func createTool(toolName, projectRoot, framework string) error {
-	if verbose {
+	if Verbose {
 		fmt.Printf("Creating tool: %s\n", toolName)
 	}
 

cmd/kmcp/main.go

@@ -1,15 +1,15 @@
-package cmd
+package commands
 
 import (
 	"fmt"
 	"os"
 	"os/exec"
 	"strings"
 
-	"github.com/kagent-dev/kmcp/pkg/manifest"
+	"github.com/kagent-dev/kmcp/pkg/cli/internal/manifest"
 	"github.com/stoewer/go-strcase"
 
-	"github.com/kagent-dev/kmcp/pkg/build"
+	"github.com/kagent-dev/kmcp/pkg/cli/internal/build"
 	"github.com/spf13/cobra"
 )
 
@@ -37,7 +37,7 @@ var (
 )
 
 func init() {
-	rootCmd.AddCommand(buildCmd)
+	addRootSubCmd(buildCmd)
 
 	buildCmd.Flags().StringVarP(&buildTag, "tag", "t", "", "Docker image tag (alias for --output)")
 	buildCmd.Flags().BoolVar(&buildPush, "push", false, "Push Docker image to registry")
@@ -88,7 +88,7 @@ func runBuild(cmd *cobra.Command, args []string) error {
 		ProjectDir: buildDirectory,
 		Tag:        imageName,
 		Platform:   buildPlatform,
-		Verbose:    verbose,
+		Verbose:    Verbose,
 	}
 
 	if err := builder.Build(opts); err != nil {
@@ -110,7 +110,7 @@ func runBuild(cmd *cobra.Command, args []string) error {
 			var err error
 			clusterName, err = getCurrentKindClusterName()
 			if err != nil {
-				if verbose {
+				if Verbose {
 					fmt.Printf("could not detect kind cluster name: %v, using default\n", err)
 				}
 				clusterName = "kind" // default to kind cluster
@@ -129,7 +129,7 @@ func runBuild(cmd *cobra.Command, args []string) error {
 }
 
 func runDocker(args ...string) error {
-	if verbose {
+	if Verbose {
 		fmt.Printf("Running: docker %s\n", strings.Join(args, " "))
 	}
 	cmd := exec.Command("docker", args...)
@@ -139,7 +139,7 @@ func runDocker(args ...string) error {
 }
 
 func runKind(args ...string) error {
-	if verbose {
+	if Verbose {
 		fmt.Printf("Running: kind %s\n", strings.Join(args, " "))
 	}
 	cmd := exec.Command("kind", args...)

pkg/build/build.go pkg/cli/internal/build/build.gopkg/build/build.go renamed to pkg/cli/internal/build/build.go

@@ -1,4 +1,4 @@
-package cmd
+package commands
 
 import (
 	"bytes"
@@ -12,8 +12,8 @@ import (
 	"time"
 
 	"github.com/kagent-dev/kmcp/api/v1alpha1"
-	"github.com/kagent-dev/kmcp/pkg/manifest"
-	"github.com/kagent-dev/kmcp/pkg/wellknown"
+	"github.com/kagent-dev/kmcp/pkg/cli/internal/manifest"
+	"github.com/kagent-dev/kmcp/pkg/cli/internal/wellknown"
 	"github.com/spf13/cobra"
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -79,7 +79,7 @@ var (
 )
 
 func init() {
-	rootCmd.AddCommand(deployCmd)
+	addRootSubCmd(deployCmd)
 
 	// Get current namespace from kubeconfig
 	currentNamespace, err := getCurrentNamespaceFromKubeconfig()
@@ -155,7 +155,7 @@ func runDeployMCP(_ *cobra.Command, args []string) error {
 	// Set namespace
 	mcpServer.Namespace = deployNamespace
 
-	if verbose {
+	if Verbose {
 		fmt.Printf("Generated MCPServer: %s/%s\n", mcpServer.Namespace, mcpServer.Name)
 	}
 
@@ -524,7 +524,7 @@ func waitForDeployment(name, namespace string, timeout time.Duration) error {
 	}
 
 	cmd := exec.CommandContext(ctx, "kubectl", args...)
-	if verbose {
+	if Verbose {
 		fmt.Printf("Running: kubectl %s\n", strings.Join(args, " "))
 	}
 	var stderr bytes.Buffer
@@ -544,7 +544,7 @@ func waitForDeployment(name, namespace string, timeout time.Duration) error {
 }
 
 func runKubectl(args ...string) error {
-	if verbose {
+	if Verbose {
 		fmt.Printf("Running: kubectl %s\n", strings.Join(args, " "))
 	}
 

cmd/kmcp/cmd/add_tool.go pkg/cli/internal/commands/add_tool.gocmd/kmcp/cmd/add_tool.go renamed to pkg/cli/internal/commands/add_tool.go

@@ -1,4 +1,4 @@
-package cmd
+package commands
 
 import (
 	"bufio"
@@ -8,9 +8,9 @@ import (
 	"regexp"
 	"strings"
 
-	"github.com/kagent-dev/kmcp/pkg/frameworks"
-	"github.com/kagent-dev/kmcp/pkg/manifest"
-	"github.com/kagent-dev/kmcp/pkg/templates"
+	"github.com/kagent-dev/kmcp/pkg/cli/internal/frameworks"
+	"github.com/kagent-dev/kmcp/pkg/cli/internal/manifest"
+	"github.com/kagent-dev/kmcp/pkg/cli/internal/templates"
 
 	"github.com/spf13/cobra"
 )
@@ -41,7 +41,7 @@ var (
 )
 
 func init() {
-	rootCmd.AddCommand(initCmd)
+	addRootSubCmd(initCmd)
 
 	initCmd.PersistentFlags().BoolVar(&initForce, "force", false, "Overwrite existing directory")
 	initCmd.PersistentFlags().BoolVar(&initNoGit, "no-git", false, "Skip git initialization")
@@ -101,7 +101,7 @@ func runInitFramework(
 		Secrets:     projectManifest.Secrets,
 		Directory:   projectPath,
 		NoGit:       initNoGit,
-		Verbose:     verbose,
+		Verbose:     Verbose,
 	}
 
 	// Customize project config for the specific framework