diff --git a/README.md b/README.md index 2cfd1ef..7d0d1b3 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,21 @@ # lql_api + LQL API Server for check_mk + +## Commands the client supports + +### localclient + +Local LQL Client - requires a local lql unix socket + +### sshclient + +SSH LQL Client - connects to your Server by SSH opens a SSH tunnel to the server's lql Socket and runs a query on it. + +### sshserver + +SSH LQL Server - connects to your Server by SSH opens a SSH tunnel to the server's lql Socket and runs an API Server for that socket. + +### Version + +Prints the version \ No newline at end of file diff --git a/cmd/root.go b/cmd/root.go index 31fc75d..e1df6ed 100644 --- a/cmd/root.go +++ b/cmd/root.go @@ -9,8 +9,8 @@ var ( cfgFile string rootCmd = &cobra.Command{ - Use: "lql_api_proxy", - Short: "Check_MK LQL API Proxy", + Use: "lql_api", + Short: "Check_MK LQL API Client/Server", Long: ``, } ) diff --git a/cmd/sshclient.go b/cmd/sshclient.go index 0fd4a5d..9ec9083 100644 --- a/cmd/sshclient.go +++ b/cmd/sshclient.go @@ -44,7 +44,7 @@ var sshClientCmd = &cobra.Command{ This version connects to the Check_MK Server by SSH. -If you don't provide ssh-keyfile and ssh-password I will use your local agent. +If you don't provide ssh-keyfile and ssh-password it will use your local agent. `, Args: cobra.ExactArgs(2), Run: func(cmd *cobra.Command, args []string) { diff --git a/cmd/sshserver.go b/cmd/sshserver.go index 6937eda..0184938 100644 --- a/cmd/sshserver.go +++ b/cmd/sshserver.go @@ -26,7 +26,7 @@ func init() { sshServerCmd.Flags().IntVarP(&sshServerMaxConns, "max-conns", "x", 5, "maximal Client Connections") sshServerCmd.Flags().StringP("socket", "s", "/opt/omd/sites/{site}/tmp/run/live", "Socket on the Server") - sshServerCmd.Flags().StringP("htpasswd", "h", "", "htpasswd file, default: NO authentication") + sshServerCmd.Flags().StringP("htpasswd", "t", "", "htpasswd file, default: NO authentication") sshServerCmd.Flags().BoolP("debug", "d", false, "Enable Debug on stderr") sshServerCmd.Flags().StringP("ssh-user", "U", "root", "SSH User") sshServerCmd.Flags().StringP("ssh-keyfile", "k", "~/.ssh/id_rsa", "Keyfile") @@ -41,7 +41,7 @@ var sshServerCmd = &cobra.Command{ This version connects to the Check_MK Server by SSH. -If you don't provide ssh-keyfile and ssh-password I will use your local agent. +If you don't provide ssh-keyfile and ssh-password it will use your local agent. `, Args: cobra.ExactArgs(2), Run: func(cmd *cobra.Command, args []string) { diff --git a/cmd/version.go b/cmd/version.go index ca59dbe..482f7f2 100644 --- a/cmd/version.go +++ b/cmd/version.go @@ -13,7 +13,7 @@ func init() { var versionCmd = &cobra.Command{ Use: "version", - Short: "Print the version number of lql_api_proxy", + Short: "Prints the version", Long: `Even I have a version`, Run: func(cmd *cobra.Command, args []string) { fmt.Printf("lql_api %s\n", version.Version)