diff --git a/cmd/attach.go b/cmd/attach.go index 2de8342c..59e22aca 100644 --- a/cmd/attach.go +++ b/cmd/attach.go @@ -32,7 +32,7 @@ var attachConfig = config.NewAttach() // attachCmd represents the modctl command for attach. var attachCmd = &cobra.Command{ Use: "attach [flags] ", - Short: "A command line tool for modctl attach", + Short: "Attach the file to an existing model artifact.", Args: cobra.ExactArgs(1), DisableAutoGenTag: true, SilenceUsage: true, diff --git a/cmd/build.go b/cmd/build.go index 9cc46b04..f0ea6f03 100644 --- a/cmd/build.go +++ b/cmd/build.go @@ -32,7 +32,7 @@ var buildConfig = config.NewBuild() // buildCmd represents the modctl command for build. var buildCmd = &cobra.Command{ Use: "build [flags] ", - Short: "A command line tool for modctl build", + Short: "Build the model artifact with the context by specified path.", Args: cobra.ExactArgs(1), DisableAutoGenTag: true, SilenceUsage: true, diff --git a/cmd/extract.go b/cmd/extract.go index a813622d..f71ef64a 100644 --- a/cmd/extract.go +++ b/cmd/extract.go @@ -32,7 +32,7 @@ var extractConfig = config.NewExtract() // extractCmd represents the modctl command for extract. var extractCmd = &cobra.Command{ Use: "extract --output ", - Short: "A command line tool for modctl extract", + Short: "Extract the model artifact to the output path, which can restore the initial state of the model files.", Args: cobra.ExactArgs(1), DisableAutoGenTag: true, SilenceUsage: true, diff --git a/cmd/fetch.go b/cmd/fetch.go index 469a0b8b..9503286f 100644 --- a/cmd/fetch.go +++ b/cmd/fetch.go @@ -32,7 +32,7 @@ var fetchConfig = config.NewFetch() // fetchCmd represents the modctl command for fetch. var fetchCmd = &cobra.Command{ Use: "fetch [flags] ", - Short: "A command line tool for modctl fetch, please note that this command is designed for remote model fetching only.", + Short: "Fetch can retrieve files from the remote model repository, enabling selective download of partial model files by filtering based on file path patterns.", Args: cobra.ExactArgs(1), DisableAutoGenTag: true, SilenceUsage: true, diff --git a/cmd/inspect.go b/cmd/inspect.go index 679ed50e..3fde9d57 100644 --- a/cmd/inspect.go +++ b/cmd/inspect.go @@ -33,7 +33,7 @@ var inspectConfig = config.NewInspect() // inspectCmd represents the modctl command for inspect. var inspectCmd = &cobra.Command{ Use: "inspect [flags] ", - Short: "A command line tool for modctl inspect", + Short: "Inspect can help to analyze the composition of model artifact.", Args: cobra.ExactArgs(1), DisableAutoGenTag: true, SilenceUsage: true, diff --git a/cmd/list.go b/cmd/list.go index 68e355e6..74c8ae6f 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: "A command line tool for modctl list", + Short: "List will lists the current built model artifacts from local storage.", Args: cobra.NoArgs, DisableAutoGenTag: true, SilenceUsage: true, diff --git a/cmd/login.go b/cmd/login.go index 418e21d5..9e898532 100644 --- a/cmd/login.go +++ b/cmd/login.go @@ -35,7 +35,7 @@ var loginConfig = config.NewLogin() // loginCmd represents the modctl command for login. var loginCmd = &cobra.Command{ Use: "login [flags] ", - Short: "A command line tool for modctl login", + Short: "Login to a registry.", Example: ` # login to docker hub: modctl login -u foo registry-1.docker.io diff --git a/cmd/logout.go b/cmd/logout.go index b0610052..19055d79 100644 --- a/cmd/logout.go +++ b/cmd/logout.go @@ -29,7 +29,7 @@ import ( // logoutCmd represents the modctl command for logout. var logoutCmd = &cobra.Command{ Use: "logout [flags]", - Short: "A command line tool for modctl logout", + Short: "Logout from a registry.", Args: cobra.ExactArgs(1), DisableAutoGenTag: true, SilenceUsage: true, diff --git a/cmd/prune.go b/cmd/prune.go index 7ac7332a..0004ac3b 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: "A command line tool for modctl prune", + Short: "Prune can help to cleanup useless manifests and blobs in the local storage.", Args: cobra.NoArgs, DisableAutoGenTag: true, SilenceUsage: true, diff --git a/cmd/pull.go b/cmd/pull.go index c1a047e3..52904107 100644 --- a/cmd/pull.go +++ b/cmd/pull.go @@ -32,7 +32,7 @@ var pullConfig = config.NewPull() // pullCmd represents the modctl command for pull. var pullCmd = &cobra.Command{ Use: "pull [flags] ", - Short: "A command line tool for modctl pull", + Short: "Pull a model artifact from the remote registry.", Args: cobra.ExactArgs(1), DisableAutoGenTag: true, SilenceUsage: true, diff --git a/cmd/push.go b/cmd/push.go index b770eb4f..5fb41c38 100644 --- a/cmd/push.go +++ b/cmd/push.go @@ -32,7 +32,7 @@ var pushConfig = config.NewPush() // pushCmd represents the modctl command for push. var pushCmd = &cobra.Command{ Use: "push [flags] ", - Short: "A command line tool for modctl push", + Short: "Push a model artifact to the remote registry.", Args: cobra.ExactArgs(1), DisableAutoGenTag: true, SilenceUsage: true, diff --git a/cmd/rm.go b/cmd/rm.go index c830e614..0f6677d5 100644 --- a/cmd/rm.go +++ b/cmd/rm.go @@ -29,7 +29,7 @@ import ( // rmCmd represents the modctl command for rm. var rmCmd = &cobra.Command{ Use: "rm [flags] ", - Short: "A command line tool for modctl rm", + Short: "Remove a model artifact from the local storage.", Args: cobra.ExactArgs(1), DisableAutoGenTag: true, SilenceUsage: true, diff --git a/cmd/root.go b/cmd/root.go index 3368bde7..d6973a24 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 Model Format Specification", + Short: "A command line tool for managing artifact bundled based on the ModelPack Specification", Args: cobra.MaximumNArgs(1), DisableAutoGenTag: true, SilenceUsage: true, diff --git a/cmd/tag.go b/cmd/tag.go index 5c750d20..0a2a5fe8 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: "A command line tool for modctl tag", + Short: "Tag can tag one model artifact to another one without rebuiding.", Args: cobra.ExactArgs(2), DisableAutoGenTag: true, SilenceUsage: true, diff --git a/cmd/upload.go b/cmd/upload.go index a2da294f..5d59527c 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: "A command line tool for modctl upload", + 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.", Args: cobra.ExactArgs(1), DisableAutoGenTag: true, SilenceUsage: true,