config
The kilm config
command group allows you to inspect and manage the libraries registered in your KiLM configuration (config.yaml
) and control settings like the default library.
Subcommands
Section titled “Subcommands”Lists the configured libraries.
kilm config list [OPTIONS]
Options
Section titled “Options”-
--type [github|cloud|all]
: Filters the libraries shown by type.github
: Shows symbol/footprint/template libraries.cloud
: Shows 3D model libraries.all
: Shows all types (default). Example:kilm config list --type github
-
-v, --verbose
: Displays more detailed information about each library, reading from bothconfig.yaml
and the library’s metadata file (kilm.yaml
or.kilm_cloud_metadata
). Shows path, description, version, environment variable, capabilities/model count, etc. Example:kilm config list --verbose
-
--help
: Show the help message and exit.
Examples
Section titled “Examples”List all configured libraries (basic view):
kilm config list
List only symbol/footprint libraries:
kilm config list --type github
List all libraries with detailed information:
kilm config list --verbose
List only 3D model libraries with details:
kilm config list --type cloud --verbose
Sets a specific registered library as the default (“current”) library used by KiLM.
The current_library
setting in config.yaml
determines which library path is used by default in commands like status
or setup
(when not using --all-libraries
or specific library flags).
kilm config set-default [LIBRARY_NAME] [OPTIONS]
Arguments
Section titled “Arguments”LIBRARY_NAME
: The name (as shown inkilm config list
) of the library to set as default. If omitted, you will be prompted to choose from a list.
Options
Section titled “Options”-
--type [github|cloud]
: Specifies the type of library to choose from when prompting (ifLIBRARY_NAME
is omitted) or to disambiguate if names clash. Default:github
. Example:kilm config set-default --type cloud
(prompts for a cloud library) -
--help
: Show the help message and exit.
Examples
Section titled “Examples”Set a specific GitHub library as default:
kilm config set-default my-company-library
Set a specific Cloud (3D) library as default:
kilm config set-default shared-3d-models --type cloud
Interactively select a GitHub library to be default:
kilm config set-default
Interactively select a Cloud library to be default:
kilm config set-default --type cloud
Removes a registered library from the KiLM configuration (config.yaml
). This does not delete the library files or its metadata file, only the entry in KiLM’s central config.
kilm config remove LIBRARY_NAME [OPTIONS]
Arguments
Section titled “Arguments”LIBRARY_NAME
: Required. The name (as shown inkilm config list
) of the library to remove from the configuration.
Options
Section titled “Options”-
--type [github|cloud|all]
: Specifies the type of the library entry to remove. If a name exists for both types, this is needed for disambiguation.all
removes entries with this name regardless of type. Default:all
. Example:kilm config remove obsolete-lib --type github
-
--force
: Remove the library entry without asking for confirmation. Default:False
(confirmation required). Example:kilm config remove old-project-lib --force
-
--help
: Show the help message and exit.
Examples
Section titled “Examples”Remove a library (will ask for confirmation):
kilm config remove temp-test-library
Remove only the GitHub entry for a library:
kilm config remove shared-lib --type github
Force removal without confirmation:
kilm config remove unused-3d-models --type cloud --force