From 5467c9e5b4a2c049e33a2499913f011a0640c8b6 Mon Sep 17 00:00:00 2001 From: Aravind Date: Mon, 9 Feb 2026 23:19:55 +0530 Subject: [PATCH] Improve CLI command descriptions and usability Signed-off-by: Aravind --- cmd/list.go | 2 +- cmd/prune.go | 2 +- cmd/root.go | 2 +- cmd/tag.go | 2 +- cmd/upload.go | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/cmd/list.go b/cmd/list.go index 74c8ae6f..c8868e89 100644 --- a/cmd/list.go +++ b/cmd/list.go @@ -32,7 +32,7 @@ import ( // listCmd represents the modctl command for list. var listCmd = &cobra.Command{ Use: "ls", - Short: "List will lists the current built model artifacts from local storage.", + Short: "List model artifacts currently stored locally.", Args: cobra.NoArgs, DisableAutoGenTag: true, SilenceUsage: true, diff --git a/cmd/prune.go b/cmd/prune.go index 0004ac3b..a49b59e0 100644 --- a/cmd/prune.go +++ b/cmd/prune.go @@ -32,7 +32,7 @@ var pruneConfig = config.NewPrune() // pruneCmd represents the modctl command for prune. var pruneCmd = &cobra.Command{ Use: "prune [flags]", - Short: "Prune can help to cleanup useless manifests and blobs in the local storage.", + Short: "Prune removes unused manifests and blobs from local storage (destructive operation).", Args: cobra.NoArgs, DisableAutoGenTag: true, SilenceUsage: true, diff --git a/cmd/root.go b/cmd/root.go index d6973a24..5c70fcde 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -40,7 +40,7 @@ var logFile *os.File // rootCmd represents the modctl command. var rootCmd = &cobra.Command{ Use: "modctl", - Short: "A command line tool for managing artifact bundled based on the ModelPack Specification", + Short: "A command-line tool for managing artifacts bundled according to the ModelPack Specification.", Args: cobra.MaximumNArgs(1), DisableAutoGenTag: true, SilenceUsage: true, diff --git a/cmd/tag.go b/cmd/tag.go index 0a2a5fe8..4b203fff 100644 --- a/cmd/tag.go +++ b/cmd/tag.go @@ -29,7 +29,7 @@ import ( // tagCmd represents the modctl command for tag. var tagCmd = &cobra.Command{ Use: "tag [flags] ", - Short: "Tag can tag one model artifact to another one without rebuiding.", + Short: "Tag one model artifact as another without rebuilding.", Args: cobra.ExactArgs(2), DisableAutoGenTag: true, SilenceUsage: true, diff --git a/cmd/upload.go b/cmd/upload.go index 10b50eae..57405be4 100644 --- a/cmd/upload.go +++ b/cmd/upload.go @@ -32,7 +32,7 @@ var uploadConfig = config.NewUpload() // uploadCmd represents the modctl command for upload. var uploadCmd = &cobra.Command{ Use: "upload [flags] ", - Short: "Upload a file to the remote end in advance to save time in the later build, applicable to the scenario of uploading while downloading, this function needs to be used together with build.", + Short: "Pre-upload a file to a remote repository to speed up later builds.", Args: cobra.ExactArgs(1), DisableAutoGenTag: true, SilenceUsage: true,