Skip to content

Record command-line in BCO and WRROC files - #60

Open
suhrig wants to merge 2 commits into
nextflow-io:mainfrom
suhrig:record_command_line
Open

Record command-line in BCO and WRROC files#60
suhrig wants to merge 2 commits into
nextflow-io:mainfrom
suhrig:record_command_line

Conversation

@suhrig

@suhrig suhrig commented Jul 20, 2026

Copy link
Copy Markdown

Following up on my question in #58, this PR introduces an optional configuration flag, recordCommandLine, for both the BCO and WRROC provenance output formats. By default, it is off, ensuring the exact same behavior of the plugin as usual. When enabled, the plugin records the exact command-line invocation used to launch the Nextflow workflow in the generated provenance metadata.

Configuration example:

prov {
    formats {
        bco {
            recordCommandLine = true
        }
        wrroc {
            recordCommandLine = true
        }
    }
}

The command-line is recorded in the usability_domain of the BCO object. The IEEE-2791 schema specifies usability_domain as a list of free-text strings intended to guide users on how to understand, execute, or reproduce the computational object. Placing the launch command here provides clear, human-readable execution context without violating strict schema constraints.

The WRROC object records the info in the description of the main CreateAction. This is where the specification explicitly recommends putting details on the execution of the pipeline.

Let me know what you think about this suggestion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant