Skip to content

docs(cli): fix command help typos, examples, and minor logging bugs #366

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
divyansh-v15-06 wants to merge 1 commit into
base: master
Choose a base branch
from
+8 −6
Open

docs(cli): fix command help typos, examples, and minor logging bugs #366

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
8 changes: 4 additions & 4 deletions cmd/start.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@ microcks start
microcks start --port [Port you want]

# Define your driver (by default docker)
microcks start --driver [driver you wnat either 'docker' or 'podman']
microcks start --driver [driver you want either 'docker' or 'podman']

# Define name of your microcks container/instance
microcks start --name [name of you container/instance]`,
microcks start --name [name of your container/instance]`,
Run: func(cmd *cobra.Command, args []string) {

configFile := globalClientOpts.ConfigPath
Expand Down Expand Up @@ -143,10 +143,10 @@ microcks start --name [name of you container/instance]`,
fmt.Printf("Microcks started successfully at %s\n", server)
},
}
startCmd.Flags().StringVar(&name, "name", "microcks", "name for you microcks instance")
startCmd.Flags().StringVar(&name, "name", "microcks", "name for your microcks instance")
startCmd.Flags().StringVar(&hostPort, "port", "8585", "")
startCmd.Flags().StringVar(&imageName, "image", "quay.io/microcks/microcks-uber:latest-native", "image which will be used to create a container")
startCmd.Flags().BoolVar(&autoRemove, "rm", false, "mimic of '--rm' flag of dokcer to automatically remove the container when it exits")
startCmd.Flags().BoolVar(&autoRemove, "rm", false, "mimic of '--rm' flag of docker to automatically remove the container when it exits")
startCmd.Flags().StringVar(&driver, "driver", "docker", "use --driver to change driver from docker to podman")
return startCmd
}
2 changes: 2 additions & 0 deletions cmd/stop.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ func NewStopCommand(globalClientOpts *connectors.ClientOptions) *cobra.Command {
Use: "stop",
Short: "stop microcks instance",
Long: "stop microcks instance",
Example: `# Stop the current Microcks instance
microcks stop`,
Run: func(cmd *cobra.Command, args []string) {

configFile := globalClientOpts.ConfigPath
Expand Down
2 changes: 1 addition & 1 deletion pkg/config/localconfig.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -345,7 +345,7 @@ func (l *LocalConfig) GetAuth(server string) (*Auth, error) {
}
}

return nil, fmt.Errorf("Auth for '%s' is undifined", server)
return nil, fmt.Errorf("Auth for '%s' is undefined", server)
}

func (l *LocalConfig) UpsertAuth(auth Auth) {
Expand Down
2 changes: 1 addition & 1 deletion pkg/watcher/executor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ func TriggerImport(entry config.WatchEntry) {
// Retrieve config to get client options.
cfgPath, err := config.DefaultLocalConfigPath()
if err != nil {
fmt.Errorf("Error while loading config: %s", err.Error())
fmt.Printf("[ERROR] Error while loading config: %s\n", err.Error())
}

fmt.Println("[INFO] Re-importing changed file: " + entry.FilePath)
Expand Down
Loading