Skip to content

entity_registry

Defines the entity registry used for dynamic CLI command generation in the Merlin database interface.

This registry maps entity types (e.g., study, run, logical-worker, physical-worker) to their corresponding CLI argument metadata and supported filtering options. It is used by CLI subcommands (such as get, delete, and info) to automatically construct argument parsers and handle entity-specific logic in a generic, extensible way.

Each entry in the registry includes: - filters: A list of supported filters, where each filter specifies a name and its type (and optionally nargs for multi-valued arguments). - identifiers: A human-readable description of valid identifiers for referencing entities. - ident_arg: The name used for the positional identifier argument in CLI commands. - ident_help: The help string template for CLI identifier arguments, parameterized with {verb}.

This design allows new entity types to be added to the CLI with minimal changes to the command logic.