github.com/wmuizelaar/kpt@v0.0.0-20221018115725-bd564717b2ed/internal/docs/generated/repodocs/docs.go (about)

     1  // Code generated by "mdtogo"; DO NOT EDIT.
     2  package repodocs
     3  
     4  var RepoShort = `Manage package repositories.`
     5  var RepoLong = `
     6  The ` + "`" + `repo` + "`" + ` command group contains subcommands for managing package repositories.
     7  `
     8  
     9  var GetShort = `List registered repositories.`
    10  var GetLong = `
    11    kpt alpha repo get [REPOSITORY_NAME] [flags]
    12  
    13  Args:
    14  
    15    REPOSITORY_NAME:
    16      The name of a repository. If provided, only that specific
    17      repository will be shown. Defaults to showing all registered
    18      repositories.
    19  `
    20  var GetExamples = `
    21    # list all repositories registered in the default namespace
    22    $ kpt alpha repo get --namespace default
    23  
    24    # show the repository named foo in the bar namespace
    25    $ kpt alpha repo get foo --namespace bar
    26  `
    27  
    28  var RegShort = `Register a package repository.`
    29  var RegLong = `
    30    kpt alpha repo reg REPOSITORY [flags]
    31  
    32  Args:
    33  
    34    REPOSITORY:
    35      The URI for the registry. It can be either a git repository
    36      or an oci repository. For the latter, the URI must have the
    37      'oci://' prefix.
    38  
    39  Flags:
    40  
    41    --branch:
    42      Branch within the repository where finalized packages are
    43      commited. The default is to use the 'main' branch.
    44    
    45    --deployment:
    46      Tags the repository as a deployment repository. Packages in
    47      a deployment repository are considered ready for deployment.
    48    
    49    --description:
    50      Description of the repository.
    51    
    52    --directory:
    53      Directory within the repository where packages are found. The
    54      default is the root of the repository.
    55    
    56    --name:
    57      Name of the repository. By default the last segment of the
    58      repository URL will be used as the name.
    59    
    60    --repo-basic-username:
    61      Username for authenticating to a repository with basic auth.
    62    
    63    --repo-basic-password:
    64      Password for authenticating to a repository with basic auth.
    65  `
    66  var RegExamples = `
    67    # register a new git repository with the name generated from the URI.
    68    $ kpt alpha repo register https://github.com/platkrm/demo-blueprints.git --namespace=default
    69  
    70    # register a new deployment repository with name foo.
    71    $ kpt alpha repo register https://github.com/platkrm/blueprints-deployment.git --name=foo --deployment --namespace=bar
    72  `
    73  
    74  var UnregShort = `Unregister a repository.`
    75  var UnregLong = `
    76    kpt alpha repo unreg REPOSITORY_NAME [flags]
    77  
    78  Args:
    79  
    80    REPOSITORY_NAME:
    81      The name of a repository.
    82  
    83  Flags:
    84  
    85    --keep-auth-secret:
    86      Keep the Secret object with auth information referenced by the repository.
    87      By default, it will be deleted when the repository is unregistered.
    88  `
    89  var UnregExamples = `
    90    # unregister a repository and keep the auth secret.
    91    $ kpt alpha repo unreg registered-repository --namespace=default --keep-auth-secret
    92  `