Home CLI Command

planemo workflow_test_init

Initialize a Galaxy workflow test description for supplied workflow.

draft
Revised
2026-05-11
Rev
1
cli planemo workflow_test_init
No CLI metadata registered for planemo/workflow_test_init. The note body below remains the source of truth until the upstream package's meta subpath is wired into this site.

planemo workflow_test_init

Initialize a Galaxy workflow test description for supplied workflow.

Synopsis

planemo workflow_test_init [OPTIONS] WORKFLOW_PATH_OR_ID

Arguments

ArgumentTypeRequiredHelp
WORKFLOW_PATH_OR_IDtextyes—

Options

OptionTypeDefaultRequiredHelp
-f, —forceflag——Overwrite existing files if present.
-o, —outputfile———
—split_test, —no_split_testflagfalse—Write workflow job and test definitions to separate files.
—galaxy_urltext——Remote Galaxy URL to use with external Galaxy engine.
—galaxy_user_keytext——User key to use with external Galaxy engine.
—from_invocation, —from_uriflagfalse—Build a workflow test or job description from an invocation ID run on an external Galaxy.A Galaxy URL and API key must also be specified. This allows test data to be downloadedand inputs and parameters defined automatically. Alternatively, the default is to build thedescriptions from a provided workflow URI.
—profiletext——Name of profile (created with the profile_create command) to use with this command.

Output

Describe stdout/stderr shape, exit-code contract, and any JSON-report flags here.

Examples

Add canonical invocations here.

Gotchas

Document non-obvious behavior and common failure modes here.