Skip to content

Improve CLI command descriptions and usability #413

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gmarav05 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve CLI command descriptions and usability #413

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cmd/list.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion cmd/prune.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).",
Copy link

@gemini-code-assist gemini-code-assist bot Feb 9, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For consistency with other command descriptions in this CLI (e.g., tag, upload), it's better to start with a verb in the imperative mood. This makes the descriptions more direct and uniform.

Suggested change
Short: "Prune removes unused manifests and blobs from local storage (destructive operation).",
Short: "Remove unused manifests and blobs from local storage (destructive operation).",

Args: cobra.NoArgs,
DisableAutoGenTag: true,
SilenceUsage: true,
Expand Down
2 changes: 1 addition & 1 deletion cmd/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion cmd/tag.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ import (
// tagCmd represents the modctl command for tag.
var tagCmd = &cobra.Command{
Use: "tag [flags] <source> <target>",
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,
Expand Down
2 changes: 1 addition & 1 deletion cmd/upload.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ var uploadConfig = config.NewUpload()
// uploadCmd represents the modctl command for upload.
var uploadCmd = &cobra.Command{
Use: "upload [flags] <file>",
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,
Expand Down