Make CWL workflows easier to discover, cite, reuse, and inspect.
Transpiler-Mate is a collection of open-source tools built around Common Workflow Language (CWL). Describe your workflow and its software metadata once, then use independent plugins to generate documentation, diagrams, citations, research objects, service descriptions, and software bills of materials.
Explore the documentation for guides, the plugin catalog, and API references.
Install the runtime and a plugin in the same Python 3.10+ environment. For example, start with documentation generation:
python -m pip install transpiler-mate-runtime cwl2markdown
transpiler-mate --help
transpiler-mate cwl2markdown --helpInstalled plugins become subcommands of transpiler-mate. Each plugin's help lists its options.
- Choose a CWL workflow to document, inspect, or share.
- Add the metadata your plugin needs using the online metadata generator and the Software Application metadata reference.
- Follow the cwl2markdown guide to generate documentation, or explore the other tools below.
The documentation groups tools by what you want to accomplish:
| Goal | Documentation |
|---|---|
| Understand the runtime, shared plugin API, and CWL loader | Foundations |
| Generate documentation and diagrams, explore workflows, and compare releases | Analysis and reporting |
| Export metadata, citations, research objects, and service descriptions | Format conversion |
| Inventory workflow containers and generate SBOMs | Software supply chain |
| Generate input templates, CLI scaffolding, and integration artifacts | Software generation |
| Check workflow inputs with schemas, policies, and assertions | Input validation |
| Run multiple plugins with the same resolved CWL context | Batch execution |
Plugins are independent Python packages discovered by the runtime. Follow the plugin development guide to implement, test, and distribute your own plugin using the shared API contracts.
The plugin project template provides a starting point with Python packaging, tests, documentation, and CI.
Bug reports, workflow examples, documentation improvements, and new plugins are welcome. Find a project on GitHub, open an issue or pull request, and follow its contribution and development instructions.
This .github repository hosts the organization's profile content. The documentation website is maintained in Transpiler-Mate.github.io.