`init`

Initialize an empty package.

init initializes an existing empty directory as a kpt package by adding a Kptfile and a placeholder README.md file.

Synopsis #

kpt pkg init [DIR] [flags]

Args #

DIR:
  init fails if DIR does not already exist. Defaults to the current working directory.

Flags #

--description
  Short description of the package. (default "sample description")

--keywords
  A list of keywords describing the package.

--site
  Link to page with information about the package.

Examples #

# Creates a new Kptfile with metadata in the cockroachdb directory.
$ mkdir cockroachdb; kpt pkg init cockroachdb --keywords "cockroachdb,nosql,db"  \
    --description "my cockroachdb implementation"

# Creates a new Kptfile without metadata in the current directory.
$ kpt pkg init

Last modified October 28, 2025: Add shell to cli cmds (b9f9c412)