Skip to content

Usage notes

This page is intended to document any high level behaviour that needs its own explanation.

Package resolution

Package Search Paths

Package/Artifact search path ordering generally looks like:

pwd:KX_PACKAGE_PATH:KX_ARTIFACT_PATH
It is good to bear this in mind if you ever get the "wrong" package being resolved.

Generally we use "slash" to delimit package-name/package-version and the tool will split this up and try and resolve it based on the above searchpath precedence.

In the case where you specify something like: mypackage-0.0.1.kxi, the resolver will try to resolve an artifact (`.kxi) first but will fall back to a package (open directory structure).

Resolving Remote Packages

When dealing with a remote packages we must specifiy package-name/package-version using a slash to seperate them.

This is so that the server can split the name and version and find the package on the host in order to return it.

Manifest

The Manifest is special

The manifest file is special and should not be edited manually unless:

  • The documentation specify for you to do so
  • You know what you are doing

Generally the manifest is designed to be "reflective" of what is in the package and manipulation of it should be done through the kxi package tool where possible.

This "reflective" nature of the manifest can be seen if, for instance you change a pipeline name in the manifest and then hit kxi package refresh. You will notice your manifest file changes the name back again!

Package vs Artifact

Package or Artifact

Package refers to an "unpacked" Artifact - i.e. a simple directory structure Artifact refers to the "packed" (archive/zip) file - i.e. the .kxi extenstion object