23 lines
1.2 KiB
Markdown
23 lines
1.2 KiB
Markdown
Selector & plugin-table usage
|
|
|
|
This project provides a small plugin/table/selector flow that allows plugins
|
|
and cmdlets to interact via a simple, pipable API.
|
|
|
|
Key ideas
|
|
- `plugin-table` renders a plugin result set and *emits* pipeline-friendly dicts for each row. Each emitted item includes `_selection_args`, a list of args the plugin suggests for selecting that row (e.g., `['-path', '/tmp/file']`).
|
|
- Use the `@N` syntax to select an item from a table and chain it to the next cmdlet.
|
|
|
|
Example:
|
|
|
|
plugin-table -plugin example -sample | @1 | add-file -instance default
|
|
|
|
What plugins must implement
|
|
- An adapter that yields `ResultModel` objects (breaking API).
|
|
- Optionally supply a `columns` factory and `selection_fn` (see `plugins/example_provider.py`).
|
|
|
|
Implementation notes
|
|
- `plugin-table` emits dicts like `{ 'title': ..., 'path': ..., 'metadata': ..., '_selection_args': [...] }`.
|
|
- Selection syntax (`@1`) will prefer `_selection_args` if present; otherwise it will fall back to plugin selection logic or sensible defaults (`-path` or `-title`).
|
|
|
|
This design keeps the selector-focused UX small and predictable while enabling full cmdlet interoperability via piping and `-run-cmd`.
|