Skip to content

Commit

Permalink
add cmd descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
AshutoshPatole committed Aug 10, 2024
1 parent 77e9f6b commit abbaae8
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
6 changes: 4 additions & 2 deletions cmd/add.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,10 @@ var (
// addCmd represents the add command
var addCmd = &cobra.Command{
Use: "add",
Short: "A brief description of your command",
Long: ``,
Short: "Add a new SSH server configuration to your profile.",
Long: `This command allows you to add a new SSH server configuration to your profile.
You can specify the hostname, username, group, environment, and other optional settings such as alias and dotfiles configuration.`,
Args: func(cmd *cobra.Command, args []string) error {
if len(args) < 1 {
return errors.New(color.InRed("Requires hostname of the machine"))
Expand Down
7 changes: 5 additions & 2 deletions cmd/template.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,11 @@ import (
// templateCmd represents the template command
var templateCmd = &cobra.Command{
Use: "template",
Short: "A brief description of your command",
Long: ``,
Short: "Generate and save a template YAML configuration file.",
Long: `This command generates a template YAML configuration file with example SSH groups, environments, and server settings.
The template is then saved to your home directory as '.ssm-template.yaml'.
This file can be used as a starting point for importing your SSH profiles.`,

Run: func(cmd *cobra.Command, args []string) {
saveTemplate()
},
Expand Down

0 comments on commit abbaae8

Please sign in to comment.