From 3822b6615a038ae5f0b965e4269a47073cc7d825 Mon Sep 17 00:00:00 2001 From: Julien Bordellier Date: Fri, 20 Apr 2018 18:38:36 +0200 Subject: [PATCH] Add documentation to helm search --regexp (#3927) Add examples and general sub-command documentation from PR feedback --- cmd/helm/search.go | 15 +++++++++++++++ docs/helm/helm_search.md | 17 ++++++++++++++++- 2 files changed, 31 insertions(+), 1 deletion(-) diff --git a/cmd/helm/search.go b/cmd/helm/search.go index ab284a898..8e6fa5ec5 100644 --- a/cmd/helm/search.go +++ b/cmd/helm/search.go @@ -35,6 +35,21 @@ Search reads through all of the repositories configured on the system, and looks for matches. Repositories are managed with 'helm repo' commands. + +To look for charts with a particular name (such as stable/mysql), try +searching using vertical tabs (\v). Vertical tabs are used as the delimiter +between search fields. For example: + + helm search --regexp '\vstable/mysql\v' + +To search for charts using common keywords (such as "database" or +"key-value store"), use + + helm search database + +or + + helm search key-value store ` // searchMaxScore suggests that any score higher than this is not considered a match. diff --git a/docs/helm/helm_search.md b/docs/helm/helm_search.md index 1ed04e880..15b03589d 100644 --- a/docs/helm/helm_search.md +++ b/docs/helm/helm_search.md @@ -11,6 +11,21 @@ looks for matches. Repositories are managed with 'helm repo' commands. +To look for charts with a particular name (such as stable/mysql), try +searching using vertical tabs (\v). Vertical tabs are used as the delimiter +between search fields. For example: + + helm search --regexp '\vstable/mysql\v' + +To search for charts using common keywords (such as "database" or +"key-value store"), use + + helm search database + +or + + helm search key-value store + ``` helm search [keyword] @@ -39,4 +54,4 @@ helm search [keyword] ### SEE ALSO * [helm](helm.md) - The Helm package manager for Kubernetes. -###### Auto generated by spf13/cobra on 23-Apr-2018 +###### Auto generated by spf13/cobra on 24-Apr-2018