Skip to content

Commit a4dc545

Browse files
authored
docs: update command descriptions to be more descriptive (#256)
Signed-off-by: chlins <[email protected]>
1 parent 25f1b2f commit a4dc545

File tree

15 files changed

+15
-15
lines changed

15 files changed

+15
-15
lines changed

cmd/attach.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var attachConfig = config.NewAttach()
3232
// attachCmd represents the modctl command for attach.
3333
var attachCmd = &cobra.Command{
3434
Use: "attach [flags] <file>",
35-
Short: "A command line tool for modctl attach",
35+
Short: "Attach the file to an existing model artifact.",
3636
Args: cobra.ExactArgs(1),
3737
DisableAutoGenTag: true,
3838
SilenceUsage: true,

cmd/build.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var buildConfig = config.NewBuild()
3232
// buildCmd represents the modctl command for build.
3333
var buildCmd = &cobra.Command{
3434
Use: "build [flags] <path>",
35-
Short: "A command line tool for modctl build",
35+
Short: "Build the model artifact with the context by specified path.",
3636
Args: cobra.ExactArgs(1),
3737
DisableAutoGenTag: true,
3838
SilenceUsage: true,

cmd/extract.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var extractConfig = config.NewExtract()
3232
// extractCmd represents the modctl command for extract.
3333
var extractCmd = &cobra.Command{
3434
Use: "extract <target> --output <output>",
35-
Short: "A command line tool for modctl extract",
35+
Short: "Extract the model artifact to the output path, which can restore the initial state of the model files.",
3636
Args: cobra.ExactArgs(1),
3737
DisableAutoGenTag: true,
3838
SilenceUsage: true,

cmd/fetch.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var fetchConfig = config.NewFetch()
3232
// fetchCmd represents the modctl command for fetch.
3333
var fetchCmd = &cobra.Command{
3434
Use: "fetch [flags] <target>",
35-
Short: "A command line tool for modctl fetch, please note that this command is designed for remote model fetching only.",
35+
Short: "Fetch can retrieve files from the remote model repository, enabling selective download of partial model files by filtering based on file path patterns.",
3636
Args: cobra.ExactArgs(1),
3737
DisableAutoGenTag: true,
3838
SilenceUsage: true,

cmd/inspect.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ var inspectConfig = config.NewInspect()
3333
// inspectCmd represents the modctl command for inspect.
3434
var inspectCmd = &cobra.Command{
3535
Use: "inspect [flags] <target>",
36-
Short: "A command line tool for modctl inspect",
36+
Short: "Inspect can help to analyze the composition of model artifact.",
3737
Args: cobra.ExactArgs(1),
3838
DisableAutoGenTag: true,
3939
SilenceUsage: true,

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: "A command line tool for modctl list",
35+
Short: "List will lists the current built model artifacts from local storage.",
3636
Args: cobra.NoArgs,
3737
DisableAutoGenTag: true,
3838
SilenceUsage: true,

cmd/login.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ var loginConfig = config.NewLogin()
3535
// loginCmd represents the modctl command for login.
3636
var loginCmd = &cobra.Command{
3737
Use: "login [flags] <registry>",
38-
Short: "A command line tool for modctl login",
38+
Short: "Login to a registry.",
3939
Example: `
4040
# login to docker hub:
4141
modctl login -u foo registry-1.docker.io

cmd/logout.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ import (
2929
// logoutCmd represents the modctl command for logout.
3030
var logoutCmd = &cobra.Command{
3131
Use: "logout [flags]",
32-
Short: "A command line tool for modctl logout",
32+
Short: "Logout from a registry.",
3333
Args: cobra.ExactArgs(1),
3434
DisableAutoGenTag: true,
3535
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: "A command line tool for modctl prune",
35+
Short: "Prune can help to cleanup useless manifests and blobs in the local storage.",
3636
Args: cobra.NoArgs,
3737
DisableAutoGenTag: true,
3838
SilenceUsage: true,

cmd/pull.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ var pullConfig = config.NewPull()
3232
// pullCmd represents the modctl command for pull.
3333
var pullCmd = &cobra.Command{
3434
Use: "pull [flags] <target>",
35-
Short: "A command line tool for modctl pull",
35+
Short: "Pull a model artifact from the remote registry.",
3636
Args: cobra.ExactArgs(1),
3737
DisableAutoGenTag: true,
3838
SilenceUsage: true,

0 commit comments

Comments
 (0)