Skip to content

Commit 13073f2

Browse files
committed
Improve CLI command descriptions and usability
1 parent 66ef121 commit 13073f2

File tree

5 files changed

+5
-5
lines changed

5 files changed

+5
-5
lines changed

cmd/list.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ import (
3232
// listCmd represents the modctl command for list.
3333
var listCmd = &cobra.Command{
3434
Use: "ls",
35-
Short: "List will lists the current built model artifacts from local storage.",
35+
Short: "List model artifacts currently stored locally.",
3636
Args: cobra.NoArgs,
3737
DisableAutoGenTag: true,
3838
SilenceUsage: true,

cmd/prune.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var pruneConfig = config.NewPrune()
3232
// pruneCmd represents the modctl command for prune.
3333
var pruneCmd = &cobra.Command{
3434
Use: "prune [flags]",
35-
Short: "Prune can help to cleanup useless manifests and blobs in the local storage.",
35+
Short: "Prune removes unused manifests and blobs from local storage (destructive operation).",
3636
Args: cobra.NoArgs,
3737
DisableAutoGenTag: true,
3838
SilenceUsage: true,

cmd/root.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ var logFile *os.File
4040
// rootCmd represents the modctl command.
4141
var rootCmd = &cobra.Command{
4242
Use: "modctl",
43-
Short: "A command line tool for managing artifact bundled based on the ModelPack Specification",
43+
Short: "A command-line tool for managing artifacts bundled according to the ModelPack Specification.",
4444
Args: cobra.MaximumNArgs(1),
4545
DisableAutoGenTag: true,
4646
SilenceUsage: true,

cmd/tag.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import (
2929
// tagCmd represents the modctl command for tag.
3030
var tagCmd = &cobra.Command{
3131
Use: "tag [flags] <source> <target>",
32-
Short: "Tag can tag one model artifact to another one without rebuiding.",
32+
Short: "Tag one model artifact as another without rebuilding.",
3333
Args: cobra.ExactArgs(2),
3434
DisableAutoGenTag: true,
3535
SilenceUsage: true,

cmd/upload.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var uploadConfig = config.NewUpload()
3232
// uploadCmd represents the modctl command for upload.
3333
var uploadCmd = &cobra.Command{
3434
Use: "upload [flags] <file>",
35-
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.",
35+
Short: "Pre-upload a file to a remote repository to speed up later builds.",
3636
Args: cobra.ExactArgs(1),
3737
DisableAutoGenTag: true,
3838
SilenceUsage: true,

0 commit comments

Comments
 (0)