cfgdocs

Documentation

Overview

Code generated by "mdtogo"; DO NOT EDIT.

Index

• Variables

Variables

var AnnotateExamples = `` /* 400-byte string literal not displayed */

var AnnotateLong = `
  kpt cfg annotate DIR --kv KEY=VALUE...

Args:

  DIR:
    Path to a package directory
`

var AnnotateShort = `Set an annotation on one or more resources`

var CatExamples = `
  # print Resource config from a directory
  kpt cfg cat my-dir/
`

var CatLong = `
  kpt cfg cat DIR
  
  DIR:
    Path to a package directory
`

var CatShort = `Print the resources in a package`

var CfgExamples = `` /* 740-byte string literal not displayed */

var CfgLong = `
| Reads From              | Writes To                |
|-------------------------|--------------------------|
| local files or stdin    | local files or stdout    |

The ` + "`" + `cfg` + "`" + ` command group contains subcommands which read and write
local YAML files.  They are focused on providing porcelain on top
of workflows which would otherwise require viewing and editing YAML
directly.

Many cfg subcommands may also read from STDIN, allowing them to be paired
with other tools such as ` + "`" + `kubectl get` + "`" + `.
`

var CfgShort = `Display and modify JSON or YAML configuration`

var CountExamples = `` /* 152-byte string literal not displayed */

var CountLong = `
  kpt cfg count [DIR]
  
  DIR:
    Path to a package directory.  Defaults to stdin if unspecified.
`

var CountShort = `Print resource counts for a package`

var CreateSetterExamples = `` /* 882-byte string literal not displayed */

var CreateSetterLong = `` /* 347-byte string literal not displayed */

var CreateSetterShort = `Create a setter for one or more field`

var CreateSubstExamples = `` /* 1308-byte string literal not displayed */

var CreateSubstLong = `` /* 674-byte string literal not displayed */

var CreateSubstShort = `Create a substitution for one or more fields`

var DeleteSetterExamples = `
  # delete a setter replicas
  kpt cfg delete-setter DIR/ replicas
`

var DeleteSetterLong = `` /* 142-byte string literal not displayed */

var DeleteSetterShort = `Delete a setter`

var DeleteSubstExamples = `
  # delete a substitution image-tag
  kpt cfg delete-subst DIR/ image-tag
`

var DeleteSubstLong = `` /* 148-byte string literal not displayed */

var DeleteSubstShort = `Delete a substitution`

var FmtExamples = `` /* 298-byte string literal not displayed */

var FmtLong = `
  kpt cfg fmt [DIR]
  
  DIR:
    Path to a package directory.  Reads from STDIN if not provided.
`

var FmtShort = `Format configuration files`

var GrepExamples = `` /* 423-byte string literal not displayed */

var GrepLong = `` /* 405-byte string literal not displayed */

var GrepShort = `Filter resources by their field values`

var ListSettersExamples = `` /* 190-byte string literal not displayed */

var ListSettersLong = `` /* 136-byte string literal not displayed */

var ListSettersShort = `List setters for a package`

var SetExamples = `` /* 536-byte string literal not displayed */

var SetLong = `` /* 491-byte string literal not displayed */

var SetShort = `Set one or more field values`

var TreeExamples = `` /* 1031-byte string literal not displayed */

var TreeLong = `` /* 647-byte string literal not displayed */

var TreeShort = `Render resources using a tree structure`