oxo-flow env#
Manage software environments. Provides subcommands for listing available backends and checking workflow environment requirements.
Usage#
Subcommands#
env list#
List available environment backends, or list environments defined in a workflow.
When called without arguments, lists all backends detected on the system. When given a workflow file, lists the environments used by each rule.
Output:
oxo-flow v0.15.0 — Rust-native bioinformatics pipeline engine
Available environment backends:
✓ conda
✓ docker
✓ singularity
✓ venv
env check#
Check that all environments declared in a workflow file are valid and their backends are available.
| Argument | Description |
|---|---|
[WORKFLOW] |
Optional path to the .oxoflow workflow file. If omitted, checks system-wide backend availability instead. |
Output (all valid):
env create#
Create a new environment from a specification file.
| Argument | Description |
|---|---|
<SPEC> |
Path to the environment specification file (.yaml/.yml, .toml, .lock) |
| Option | Short | Description |
|---|---|---|
--name |
-n |
Custom name for the created environment (default: derived from the spec filename) |
--ai |
— | Generate the environment spec from a natural-language description (SPEC is the description) |
--backend |
— | Environment backend to generate: conda (YAML) or pixi (TOML) (default: conda) |
Output (missing backend):
Options#
| Option | Short | Description |
|---|---|---|
--verbose |
-v |
Enable debug-level logging |
Examples#
# List available backends
oxo-flow env list
# Check a specific workflow
oxo-flow env check pipeline.oxoflow
Notes#
env checkexits with code1if any environment validation fails- The check verifies backend availability, not that specific conda environments or Docker images exist — it confirms that the required type of environment manager is installed
- Run
env checkbefore submitting to a cluster to catch environment issues early - To check that environment definition files exist (conda YAML, venv
directories,
pixi.toml), useoxo-flow test --deep(findingD002)