Help Workflow
Interactive help and discovery workflow for ReaxKit.
This workflow supports two complementary help modes: 1) capability discovery (intent -> responsible analysis tasks/workflows/generators) 2) ReaxFF file discovery (query -> relevant input/output files)
Usage context
- Command routing: Resolve CLI aliases and normalized command names.
- Task execution: Build request objects and invoke registered tasks.
- Output handling: Forward results to table, plot, export, or report flows.
Command: help
Arguments
No command-specific arguments found.
Common Runtime and Presentation Arguments
These are shared workflow-level CLI flags added before command-specific options, covering runtime context (engine/input/storage) and output presentation/export behavior.
| Flag | Required | Default | Help | Choices |
|---|---|---|---|---|
query |
No | Search query (use quotes for multi-word queries). Example: "bond order", which searches that phrase across help index entries. | ||
--top |
No | 1 | Maximum results per category (generator/file/analyzer/workflow), sorted by score. Example: --top 3, which returns only the top 3 hits per category. | |
--engine |
No | Optional engine context for dataclass-to-file mappings. Example: --engine reaxff, which resolves relationships using ReaxFF context. | ||
--all-info |
No | Show detailed implementation and file/dataclass/analyzer mapping information. Example: --all-info, which expands output beyond summary hits. | ||
--exact-match |
No | Match query exactly against item title (and aliases) before returning results. Example: --exact-match, which avoids broad fuzzy matches. |