1 KDSL index commands reference

The kdsl index command is used to create or update an index of KDSL packages available in a specified directory. This index helps in managing and locating KDSL packages for deployment and development purposes. For further information about registries and indexes, refer to the Registries documentation and particularly the Building your own index file section.

Usage

kdsl index <subcommand> [options]

1.1 create

Creates or updates an index file in the specified directory.

Usage

kdsl index create [--module <module-path>] [--meta <meta-path>] [--index <index-path>]
  • --module <module-path>: (Optional) Path to the module to generate the index entry for. It can be either a relative or absolute path. Defaults to the current directory.
  • --meta <meta-path>: (Optional) Path to the metadata file (_index.json). It can be either a relative or absolute path. Defaults to _index.json in the module’s root directory.
  • --index <index-path>: (Optional) Path to the index file to append the new entry to. It can be either a relative or absolute path. If not provided, the entry will be printed to standard output.

Examples
This command will generate the entry for the current module:

kdsl index create

Or you can provide a module location to generate the entry for:

kdsl index create --module path/to/module

You can specify a custom metadata file location:

kdsl index create --meta path/to/custom/_index.json

The generated index entry will be printed to the standard output by default. However, you can directly add the new entry onto an existing index file by providing the –index option:

kdsl index create --index path/to/index/file.json

If the provided index file does not exist, it will be created.