Skip to content

Commit ad7067a

Browse files
committed
Clarify nextflow tree discoverability
Signed-off-by: Edmund Miller <edmund.miller@seqera.io>
1 parent 611d6ac commit ad7067a

1 file changed

Lines changed: 3 additions & 0 deletions

File tree

adr/20260601-nextflow-tree.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Nextflow already has the semantic information needed to answer this question: th
2222
- Omit channel expressions, process scripts, directives, params, `take:`, `main:`, `emit:`, and other syntax that does not help understand structure.
2323
- Be useful by default on incomplete or partially broken projects.
2424
- Provide a stable text format for agents and optional machine-readable output.
25+
- Make the structural overview easy for coding agents to discover from `nextflow -h` and `nextflow help`.
2526
- Reuse Nextflow parser and include-resolution semantics rather than inventing a separate language model.
2627

2728
## Non-goals
@@ -59,6 +60,8 @@ workflow main
5960

6061
The command should use the strict parser / `nf-lang` model as the source of truth. In particular, it should build on script AST concepts such as `WorkflowNode`, `ProcessNode`, and `IncludeNode`, and include-resolution behavior such as `ResolveIncludeVisitor`, which already knows how to resolve local includes, directory includes, remote modules, plugin includes, aliases, and missing included names.
6162

63+
`nextflow tree` should be a top-level command rather than only a mode of `nextflow inspect`. `nextflow -h` already presents commands such as `inspect`, `lint`, and `view` as the primary discovery surface for users and agents. A dedicated command with help text such as `Print workflow, subworkflow, and module outline` is easier for agents to find and infer than an option hidden under `inspect`. The existing `inspect` command is described as inspecting process settings, and its current output is a flat process/container inventory; this ADR targets a different question: how the pipeline is structurally organized. A future `inspect` option may delegate to the same outline model, but `nextflow tree` should be the canonical discoverable interface.
64+
6265
## User interface
6366

6467
```text

0 commit comments

Comments
 (0)