Skip to main content
Version: Next

kcl mod init

Init a kcl module.

Usage​

kcl mod init [options][module_name]

Description​

kcl mod init will initialize a kcl package in the current directory. If the package name is not provided, the name of the current directory will be used.

If the package name is provided, a subdirectory with the name of the package will be created and the package will be initialized in that directory.

kcl mod init will create kcl.mod, kcl.mod.lock and main.k under the package directory.

Options​

--help, -h​

Show help for kcl mod init command.

Examples​

Init the current directory into a kcl package​

# create an empty directory
mkdir my_package

# cd into the directory
cd my_package

# init the current directory into a kcl package
kcl mod init

Init a kcl package with a name​

# init a kcl package with a name 'my_package'
kcl mod init my_package

Reference​

This command initializes new kcl module in current directory.

Usage:
  kcl mod init [flags]

Examples:
  kcl mod init <command> [arguments]...
  # Init one kcl module with the current folder name
  kcl mod init

  # Init one kcl module with the name
  kcl mod init package-name

  # Init one kcl module with the name and version
  kcl mod init package-name --version 0.1.0

Flags:
  -h, --help             help for init
      --version string   init module version

Global Flags:
  -q, --quiet   Set the quiet mode (no output)