github.com/sgoings/helm@v2.0.0-alpha.2.0.20170406211108-734e92851ac3+incompatible/docs/man/man1/helm_list.1 (about)

     1  .TH "HELM" "1" "Mar 2017" "Auto generated by spf13/cobra" "" 
     2  .nh
     3  .ad l
     4  
     5  
     6  .SH NAME
     7  .PP
     8  helm\-list \- list releases
     9  
    10  
    11  .SH SYNOPSIS
    12  .PP
    13  \fBhelm list [flags] [FILTER]\fP
    14  
    15  
    16  .SH DESCRIPTION
    17  .PP
    18  This command lists all of the releases.
    19  
    20  .PP
    21  By default, it lists only releases that are deployed or failed. Flags like
    22  '\-\-deleted' and '\-\-all' will alter this behavior. Such flags can be combined:
    23  '\-\-deleted \-\-failed'.
    24  
    25  .PP
    26  By default, items are sorted alphabetically. Use the '\-d' flag to sort by
    27  release date.
    28  
    29  .PP
    30  If an argument is provided, it will be treated as a filter. Filters are
    31  regular expressions (Perl compatible) that are applied to the list of releases.
    32  Only items that match the filter will be returned.
    33  
    34  .PP
    35  .RS
    36  
    37  .nf
    38  $ helm list 'ara[a\-z]+'
    39  NAME                UPDATED                     CHART
    40  maudlin\-arachnid    Mon May  9 16:07:08 2016    alpine\-0.1.0
    41  
    42  .fi
    43  .RE
    44  
    45  .PP
    46  If no results are found, 'helm list' will exit 0, but with no output (or in
    47  the case of no '\-q' flag, only headers).
    48  
    49  .PP
    50  By default, up to 256 items may be returned. To limit this, use the '\-\-max' flag.
    51  Setting '\-\-max' to 0 will not return all results. Rather, it will return the
    52  server's default, which may be much higher than 256. Pairing the '\-\-max'
    53  flag with the '\-\-offset' flag allows you to page through results.
    54  
    55  
    56  .SH OPTIONS
    57  .PP
    58  \fB\-\-all\fP[=false]
    59      show all releases, not just the ones marked DEPLOYED
    60  
    61  .PP
    62  \fB\-d\fP, \fB\-\-date\fP[=false]
    63      sort by release date
    64  
    65  .PP
    66  \fB\-\-deleted\fP[=false]
    67      show deleted releases
    68  
    69  .PP
    70  \fB\-\-deleting\fP[=false]
    71      show releases that are currently being deleted
    72  
    73  .PP
    74  \fB\-\-deployed\fP[=false]
    75      show deployed releases. If no other is specified, this will be automatically enabled
    76  
    77  .PP
    78  \fB\-\-failed\fP[=false]
    79      show failed releases
    80  
    81  .PP
    82  \fB\-m\fP, \fB\-\-max\fP=256
    83      maximum number of releases to fetch
    84  
    85  .PP
    86  \fB\-\-namespace\fP=""
    87      show releases within a specific namespace
    88  
    89  .PP
    90  \fB\-o\fP, \fB\-\-offset\fP=""
    91      next release name in the list, used to offset from start value
    92  
    93  .PP
    94  \fB\-r\fP, \fB\-\-reverse\fP[=false]
    95      reverse the sort order
    96  
    97  .PP
    98  \fB\-q\fP, \fB\-\-short\fP[=false]
    99      output short (quiet) listing format
   100  
   101  
   102  .SH OPTIONS INHERITED FROM PARENT COMMANDS
   103  .PP
   104  \fB\-\-debug\fP[=false]
   105      enable verbose output
   106  
   107  .PP
   108  \fB\-\-home\fP="~/.helm"
   109      location of your Helm config. Overrides $HELM\_HOME
   110  
   111  .PP
   112  \fB\-\-host\fP=""
   113      address of tiller. Overrides $HELM\_HOST
   114  
   115  .PP
   116  \fB\-\-kube\-context\fP=""
   117      name of the kubeconfig context to use
   118  
   119  .PP
   120  \fB\-\-tiller\-namespace\fP="kube\-system"
   121      namespace of tiller
   122  
   123  
   124  .SH SEE ALSO
   125  .PP
   126  \fBhelm(1)\fP
   127  
   128  
   129  .SH HISTORY
   130  .PP
   131  11\-Mar\-2017 Auto generated by spf13/cobra