API Reference / cli /

list_cmd.py

List Command - Browse the TuiML component registry via CLI.

Functions

Command

tuiml list

Line 20
tuiml list [OPTIONS]

Browse and search the component registry.

Lists everything registered with TuiML, grouped by category: algorithms, preprocessing steps, datasets, feature selectors, splitting strategies, and any custom components you have added. The names printed here are the exact class names the other commands expect, so this is the place to look up what to pass to -a, -p, or -d.

List everything the registry knows about:

bash
$ tuiml list

Show only classifiers, with full descriptions and tags:

bash
$ tuiml list -c algorithm -t classifier -v

Search for a component by keyword:

bash
$ tuiml list -s forest

Emit bare names, ready to pipe into another command:

bash
$ tuiml list -c preprocessing -f names

Page through a long listing:

bash
$ tuiml list --limit 20 --offset 40

Options

--category, -c
choice: algorithm | preprocessing | dataset | feature | splitting | custom | all = 'all'
Only list components in this category (default: all).
--type, -t
choice: classifier | regressor | clusterer | anomaly | associator | timeseries | all = 'all'
Only list algorithms of this task type (default: all).
--search, -s
Keep only components whose name or description matches this query.
--include-runs
flag
Include the recorded run history for custom algorithms.
--limit
int = 50
Maximum number of results to return (default: 50).
--offset
int = 0
Number of results to skip, for paging through a long list.
--format, -f
choice: table | json | names = 'table'
Output format: grouped table, raw JSON, or bare names (default: table).
--verbose, -v
flag
Show the full description, tags, and type for each component.