Skip to main content
Version: 0.5.3

Share Your Package to docker.io

kpm is a tool for managing kcl packages. This article will show you how to use kpm to push your kcl packages to docker.io.

Here is a simple step-by-step guide on how to use kpm to push your kcl package to docker.io.

Step 1: Install kpm​

First, you need to install kpm on your computer. You can follow the instructions in the kpm installation documentation.

Step 2: Create a docker.io account​

If you want to use docker.io as the OCI registry to share your kcl package with others, you need to create a docker.io account to support the push of your kcl package.

Step 3: Log in to docker.io​

You can use the following command to log in to docker.io.

kpm login -u <USERNAME> -p <PASSWORD> docker.io

Where <USERNAME> is your docker.io username, and <PASSWORD> is your docker.io password.

For more information on how to log in to docker.io using kpm, see kpm login.

Step 4: Push your kcl package​

Now, you can use kpm to push your kcl package to docker.io.

1. A valid kcl package​

First, you need to make sure that what you are pushing conforms to the specifications of a kcl package, i.e., it must contain valid kcl.mod and kcl.mod.lock files.

If you don't know how to get a valid kcl.mod and kcl.mod.lock, you can use the kpm init command.

Create a new kcl package named my_package.

kpm init my_package

The kpm init my_package command will create a new kcl package my_package for you and create the kcl.mod and kcl.mod.lock files for this package.

If you already have a directory containing kcl files exist_kcl_package, you can use the following command to convert it into a kcl package and create valid kcl.mod and kcl.mod.lock files for it.

Run the kpm init command under the exist_kcl_package directory.

kpm init

For more information on how to use kpm init, see kpm init.

2. Pushing the KCL Package​

You can use the following command in the root directory of your kcl package:

Run the kpm push command under the exist_kcl_package directory.

kpm push oci://docker.io/<USERNAME>/exist_kcl_package

After completing these steps, you have successfully pushed your KCL Package exist_kcl_package to docker.io. For more information on how to use kpm push, see kpm push.